[PATCH] documentation: core-api: rearrange a few kernel-api chapters and sections

From: Randy Dunlap
Date: Thu Apr 26 2018 - 21:11:09 EST


From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Rearrange some kernel-api chapters and sections to group them
together better.

- move Bit Operations from Basic C Library Functions to Basic
Kernel Library Functions (now adjacent to Bitmap Operations since
they are not typical C library functions)

- move Sorting from Math Functions to Basic Kernel Library Functions
since sort functions are more Basic than Math Functions

- move Text Searching from Math Functions to Basic Kernel Library
Functions (keep Sorting and Searching close to each other)

- combine CRC and Math functions together into the (newly named)
CRC and Math Functions chapter

Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
---
Documentation/core-api/kernel-api.rst | 60 ++++++++++++------------
1 file changed, 30 insertions(+), 30 deletions(-)

--- linux-next-20180426.orig/Documentation/core-api/kernel-api.rst
+++ linux-next-20180426/Documentation/core-api/kernel-api.rst
@@ -39,17 +39,17 @@ String Manipulation
.. kernel-doc:: lib/string.c
:export:

+Basic Kernel Library Functions
+==============================
+
+The Linux kernel provides more basic utility functions.
+
Bit Operations
--------------

.. kernel-doc:: arch/x86/include/asm/bitops.h
:internal:

-Basic Kernel Library Functions
-==============================
-
-The Linux kernel provides more basic utility functions.
-
Bitmap Operations
-----------------

@@ -80,6 +80,31 @@ Command-line Parsing
.. kernel-doc:: lib/cmdline.c
:export:

+Sorting
+-------
+
+.. kernel-doc:: lib/sort.c
+ :export:
+
+.. kernel-doc:: lib/list_sort.c
+ :export:
+
+Text Searching
+--------------
+
+.. kernel-doc:: lib/textsearch.c
+ :doc: ts_intro
+
+.. kernel-doc:: lib/textsearch.c
+ :export:
+
+.. kernel-doc:: include/linux/textsearch.h
+ :functions: textsearch_find textsearch_next \
+ textsearch_get_pattern textsearch_get_pattern_len
+
+CRC and Math Functions in Linux
+===============================
+
CRC Functions
-------------

@@ -103,9 +128,6 @@ CRC Functions
.. kernel-doc:: lib/crc-itu-t.c
:export:

-Math Functions in Linux
-=======================
-
Base 2 log and power Functions
------------------------------

@@ -127,28 +149,6 @@ Division Functions
.. kernel-doc:: lib/gcd.c
:export:

-Sorting
--------
-
-.. kernel-doc:: lib/sort.c
- :export:
-
-.. kernel-doc:: lib/list_sort.c
- :export:
-
-Text Searching
---------------
-
-.. kernel-doc:: lib/textsearch.c
- :doc: ts_intro
-
-.. kernel-doc:: lib/textsearch.c
- :export:
-
-.. kernel-doc:: include/linux/textsearch.h
- :functions: textsearch_find textsearch_next \
- textsearch_get_pattern textsearch_get_pattern_len
-
UUID/GUID
---------