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

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>
Acked-by: Matthew Wilcox <mawilcox@microsoft.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Randy Dunlap 2018-04-26 18:11:02 -07:00 committed by Jonathan Corbet
parent ccf2b06794
commit eacc670fa4
1 changed files with 30 additions and 30 deletions

View File

@ -39,17 +39,17 @@ String Manipulation
.. kernel-doc:: lib/string.c .. kernel-doc:: lib/string.c
:export: :export:
Basic Kernel Library Functions
==============================
The Linux kernel provides more basic utility functions.
Bit Operations Bit Operations
-------------- --------------
.. kernel-doc:: arch/x86/include/asm/bitops.h .. kernel-doc:: arch/x86/include/asm/bitops.h
:internal: :internal:
Basic Kernel Library Functions
==============================
The Linux kernel provides more basic utility functions.
Bitmap Operations Bitmap Operations
----------------- -----------------
@ -80,6 +80,31 @@ Command-line Parsing
.. kernel-doc:: lib/cmdline.c .. kernel-doc:: lib/cmdline.c
:export: :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 CRC Functions
------------- -------------
@ -103,9 +128,6 @@ CRC Functions
.. kernel-doc:: lib/crc-itu-t.c .. kernel-doc:: lib/crc-itu-t.c
:export: :export:
Math Functions in Linux
=======================
Base 2 log and power Functions Base 2 log and power Functions
------------------------------ ------------------------------
@ -127,28 +149,6 @@ Division Functions
.. kernel-doc:: lib/gcd.c .. kernel-doc:: lib/gcd.c
:export: :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 UUID/GUID
--------- ---------