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

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

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.org>

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@infradead.org>
---
 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
 ---------
 

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

[Matthew Wilcox]

On Thu, Apr 26, 2018 at 06:11:02PM -0700, Randy Dunlap wrote:
> 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@infradead.org>

This all makes sense to me.

Acked-by: Matthew Wilcox <mawilcox@microsoft.com>

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

[Jonathan Corbet]

On Thu, 26 Apr 2018 18:11:02 -0700
Randy Dunlap <rdunlap@infradead.org> wrote:

> 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

The changes look good.  But ... grr... some of the stuff you are moving
around was introduced in -rc2 via the networking tree.  That kind of thing
makes life harder than it needs to be.  I've sorted it out and applied the
patch, thanks.

jon

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

[Randy Dunlap]

On 04/27/2018 04:17 PM, Jonathan Corbet wrote:
> On Thu, 26 Apr 2018 18:11:02 -0700
> Randy Dunlap <rdunlap@infradead.org> wrote:
> 
>> 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
> 
> The changes look good.  But ... grr... some of the stuff you are moving
> around was introduced in -rc2 via the networking tree.  That kind of thing
> makes life harder than it needs to be.  I've sorted it out and applied the
> patch, thanks.

Sorry, I thought that making the patch on linux-next 20180426 (which is based
on -rc2 and a few hundred git trees) would help with that.

Thanks for fixing.
-- 
~Randy