Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-12-29 06:12:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

kernel-api.rst: fix some complex tags at lib/bitmap.c

Browse Source 
Fix the following issues:

./lib/bitmap.c:869: WARNING: Definition list ends without a blank line; unexpected unindent.
./lib/bitmap.c:876: WARNING: Inline emphasis start-string without end-string.
./lib/bitmap.c:508: ERROR: Unexpected indentation.

And make sure that a table and a footnote will use the right tags.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
mchehab@s-opensource.com 2017-03-30 17:11:35 -03:00 committed by Jonathan Corbet
parent 6cc89134c0
commit 40bf19a8d9
1 changed files with 17 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
lib/bitmap.c
View File

@ -502,11 +502,11 @@ EXPORT_SYMBOL(bitmap_print_to_pagebuf);
* Syntax: range:used_size/group_size * Syntax: range:used_size/group_size
* Example: 0-1023:2/256 ==> 0,1,256,257,512,513,768,769 * Example: 0-1023:2/256 ==> 0,1,256,257,512,513,768,769
* *
* Returns 0 on success, -errno on invalid input strings. * Returns: 0 on success, -errno on invalid input strings. Error values:
* Error values: *
* %-EINVAL: second number in range smaller than first * - ``-EINVAL``: second number in range smaller than first
* %-EINVAL: invalid character in string * - ``-EINVAL``: invalid character in string
* %-ERANGE: bit number specified too large for mask * - ``-ERANGE``: bit number specified too large for mask
*/ */
static int __bitmap_parselist(const char *buf, unsigned int buflen, static int __bitmap_parselist(const char *buf, unsigned int buflen,
int is_user, unsigned long *maskp, int is_user, unsigned long *maskp,
@ -864,14 +864,16 @@ EXPORT_SYMBOL(bitmap_bitremap);
* 11 was set in @orig had no affect on @dst. * 11 was set in @orig had no affect on @dst.
* *
* Example [2] for bitmap_fold() + bitmap_onto(): * Example [2] for bitmap_fold() + bitmap_onto():
* Let's say @relmap has these ten bits set: * Let's say @relmap has these ten bits set::
*
* 40 41 42 43 45 48 53 61 74 95 * 40 41 42 43 45 48 53 61 74 95
*
* (for the curious, that's 40 plus the first ten terms of the * (for the curious, that's 40 plus the first ten terms of the
* Fibonacci sequence.) * Fibonacci sequence.)
* *
* Further lets say we use the following code, invoking * Further lets say we use the following code, invoking
* bitmap_fold() then bitmap_onto, as suggested above to * bitmap_fold() then bitmap_onto, as suggested above to
* avoid the possibility of an empty @dst result: * avoid the possibility of an empty @dst result::
* *
* unsigned long *tmp; // a temporary bitmap's bits * unsigned long *tmp; // a temporary bitmap's bits
* *
@ -882,22 +884,26 @@ EXPORT_SYMBOL(bitmap_bitremap);
* various @orig's. I list the zero-based positions of each set bit. * various @orig's. I list the zero-based positions of each set bit.
* The tmp column shows the intermediate result, as computed by * The tmp column shows the intermediate result, as computed by
* using bitmap_fold() to fold the @orig bitmap modulo ten * using bitmap_fold() to fold the @orig bitmap modulo ten
* (the weight of @relmap). * (the weight of @relmap):
* *
* =============== ============== =================
* @orig tmp @dst * @orig tmp @dst
* 0 0 40 * 0 0 40
* 1 1 41 * 1 1 41
* 9 9 95 * 9 9 95
* 10 0 40 (*) * 10 0 40 [#f1]_
* 1 3 5 7 1 3 5 7 41 43 48 61 * 1 3 5 7 1 3 5 7 41 43 48 61
* 0 1 2 3 4 0 1 2 3 4 40 41 42 43 45 * 0 1 2 3 4 0 1 2 3 4 40 41 42 43 45
* 0 9 18 27 0 9 8 7 40 61 74 95 * 0 9 18 27 0 9 8 7 40 61 74 95
* 0 10 20 30 0 40 * 0 10 20 30 0 40
* 0 11 22 33 0 1 2 3 40 41 42 43 * 0 11 22 33 0 1 2 3 40 41 42 43
* 0 12 24 36 0 2 4 6 40 42 45 53 * 0 12 24 36 0 2 4 6 40 42 45 53
* 78 102 211 1 2 8 41 42 74 (*) * 78 102 211 1 2 8 41 42 74 [#f1]_
* =============== ============== =================
* *
* (*) For these marked lines, if we hadn't first done bitmap_fold() * .. [#f1]
*
* For these marked lines, if we hadn't first done bitmap_fold()
* into tmp, then the @dst result would have been empty. * into tmp, then the @dst result would have been empty.
* *
* If either of @orig or @relmap is empty (no set bits), then @dst * If either of @orig or @relmap is empty (no set bits), then @dst