* [PATCH] documentation: core-api: rearrange a few kernel-api chapters and sections
@ 2018-04-27 1:11 ` Randy Dunlap
0 siblings, 0 replies; 8+ messages in thread
From: Randy Dunlap @ 2018-04-27 1:11 UTC (permalink / raw)
To: linux-doc, Jonathan Corbet; +Cc: LKML
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
---------
^ permalink raw reply [flat|nested] 8+ messages in thread* [PATCH] documentation: core-api: rearrange a few kernel-api chapters and sections
@ 2018-04-27 1:11 ` Randy Dunlap
0 siblings, 0 replies; 8+ messages in thread
From: Randy Dunlap @ 2018-04-27 1:11 UTC (permalink / raw)
To: linux-doc, Jonathan Corbet; +Cc: LKML
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
---------
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
^ permalink raw reply [flat|nested] 8+ messages in thread* Re: [PATCH] documentation: core-api: rearrange a few kernel-api chapters and sections
2018-04-27 1:11 ` Randy Dunlap
@ 2018-04-27 13:21 ` Matthew Wilcox
-1 siblings, 0 replies; 8+ messages in thread
From: Matthew Wilcox @ 2018-04-27 13:21 UTC (permalink / raw)
To: Randy Dunlap; +Cc: linux-doc, Jonathan Corbet, LKML
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>
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] documentation: core-api: rearrange a few kernel-api chapters and sections
@ 2018-04-27 13:21 ` Matthew Wilcox
0 siblings, 0 replies; 8+ messages in thread
From: Matthew Wilcox @ 2018-04-27 13:21 UTC (permalink / raw)
To: Randy Dunlap; +Cc: linux-doc, Jonathan Corbet, LKML
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>
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] documentation: core-api: rearrange a few kernel-api chapters and sections
2018-04-27 1:11 ` Randy Dunlap
@ 2018-04-27 23:17 ` Jonathan Corbet
-1 siblings, 0 replies; 8+ messages in thread
From: Jonathan Corbet @ 2018-04-27 23:17 UTC (permalink / raw)
To: Randy Dunlap; +Cc: linux-doc, LKML
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
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] documentation: core-api: rearrange a few kernel-api chapters and sections
@ 2018-04-27 23:17 ` Jonathan Corbet
0 siblings, 0 replies; 8+ messages in thread
From: Jonathan Corbet @ 2018-04-27 23:17 UTC (permalink / raw)
To: Randy Dunlap; +Cc: linux-doc, LKML
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
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] documentation: core-api: rearrange a few kernel-api chapters and sections
2018-04-27 23:17 ` Jonathan Corbet
@ 2018-04-28 2:04 ` Randy Dunlap
-1 siblings, 0 replies; 8+ messages in thread
From: Randy Dunlap @ 2018-04-28 2:04 UTC (permalink / raw)
To: Jonathan Corbet; +Cc: linux-doc, LKML
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
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] documentation: core-api: rearrange a few kernel-api chapters and sections
@ 2018-04-28 2:04 ` Randy Dunlap
0 siblings, 0 replies; 8+ messages in thread
From: Randy Dunlap @ 2018-04-28 2:04 UTC (permalink / raw)
To: Jonathan Corbet; +Cc: linux-doc, LKML
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
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
^ permalink raw reply [flat|nested] 8+ messages in thread
end of thread, other threads:[~2018-04-28 2:04 UTC | newest]
Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-04-27 1:11 [PATCH] documentation: core-api: rearrange a few kernel-api chapters and sections Randy Dunlap
2018-04-27 1:11 ` Randy Dunlap
2018-04-27 13:21 ` Matthew Wilcox
2018-04-27 13:21 ` Matthew Wilcox
2018-04-27 23:17 ` Jonathan Corbet
2018-04-27 23:17 ` Jonathan Corbet
2018-04-28 2:04 ` Randy Dunlap
2018-04-28 2:04 ` Randy Dunlap
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.