docs/core-api: Add string helpers API to the list
PATCH 1/1 docs/core-api: Add string helpers API to the list
Some times string helpers are needed, but there is nothing about them in the generated documentation.
Fill the gap by adding a reference to string_helpers.c exported functions.
--- Documentation/core-api/kernel-api.rst | 3 +++ 1 file changed, 3 insertions(+)
Documentation/core-api/kernel-api.rst +3 -0
@@ -33,6 +33,9 @@ String Conversions .. kernel-doc:: lib/kstrtox.c :export: +.. kernel-doc:: lib/string_helpers.c + :export: + String Manipulation -------------------
Signature · 1 line
2.20.1
Quoted 6 lines · Andy Shevchenko
Some times string helpers are needed, but there is nothing about them in the generated documentation.
Fill the gap by adding a reference to
string_helpers.cexported functions.Signed-off-by Andy Shevchenko <[email protected]>
Quoted 21 lines
--- Documentation/core-api/kernel-api.rst | 3 +++ 1 file changed, 3 insertions(+)Documentation/core-api/kernel-api.rst +3
-0@@ -33,6 +33,9 @@ String Conversions .. kernel-doc:: lib/kstrtox.c :export: +.. kernel-doc:: lib/string_helpers.c + :export: + String Manipulation -------------------Signature · 1 line
2.20.1
Signature · 2 lines
Sincerely yours, Mike.
Jonathan Corbet
maintainerQuoted 6 lines · On Wed, 5 Jun 2019 19:39:44 +0300 Andy Shevchenko…
Some times string helpers are needed, but there is nothing about them in the generated documentation.
Fill the gap by adding a reference to
string_helpers.cexported functions.Signed-off-by Andy Shevchenko <[email protected]>
So I've applied this (and the integer power functions one too), but let me grumble for just a moment...
This patch adds a set of new warnings to the docs build:
Quoted 5 lines
+./lib/string_helpers.c:236: WARNING: Unexpected indentation.+./lib/string_helpers.c:241: WARNING: Block quote ends without a blank line; unexpected unindent.+./lib/string_helpers.c:446: WARNING: Unexpected indentation.+./lib/string_helpers.c:451: WARNING: Block quote ends without a blank line; unexpected unindent.+./lib/string_helpers.c:474: WARNING: Unexpected indentation.
It would be *really* nice if folks would check for these things and fix them when they arise. The docs build is a horrific mess of warnings that will never get better if we keep adding more. This one is an easy fix; I'll toss together a patch to do it.
Beyond that (and this is in no way your fault, I'm just whining) kernel-api.rst has become a huge dumping ground. Someday it would sure be nice if we could create a bit more order there...
Thanks,
jon