diff options
| author |   Randy Dunlap <rdunlap@infradead.org> | 2017-10-16 16:32:51 -0700 |
|---|---|---|
| committer |   Jonathan Corbet <corbet@lwn.net> | 2017-10-19 13:01:40 -0600 |
| commit | 7d7363e403ce959941f80684cc5f33e747afff17 (patch) | |
| tree | 793fe05bf0426d400b07b3077b8d521a93ea96f4 /lib/bitmap.c | |
| parent | Documentation: fix selftests related file refs (diff) | |
| download | linux-dev-7d7363e403ce959941f80684cc5f33e747afff17.tar.xz linux-dev-7d7363e403ce959941f80684cc5f33e747afff17.zip | |
documentation: kernel-api: add more info on bitmap functions
There are some good comments about bitmap operations in lib/bitmap.c
and include/linux/bitmap.h, so format them for document generation and
pull them into core-api/kernel-api.rst.
I converted the "tables" of functions from using tabs to using spaces
so that they are more readable in the source file and in the generated
output.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'lib/bitmap.c')
| -rw-r--r-- | lib/bitmap.c | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/lib/bitmap.c b/lib/bitmap.c index c82c61b66e16..d8f0c094b18e 100644 --- a/lib/bitmap.c +++ b/lib/bitmap.c @@ -18,7 +18,9 @@ #include <asm/page.h> -/* +/** + * DOC: bitmap introduction + * * bitmaps provide an array of bits, implemented using an an * array of unsigned longs. The number of valid bits in a * given bitmap does _not_ need to be an exact multiple of |