[PATCH v1] docs/core-api: Add string helpers API to the list

[PATCH v1] docs/core-api: Add string helpers API to the list

[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.c exported functions.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
 Documentation/core-api/kernel-api.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst
index a53ec2eb8176..65ae2bf1f86d 100644
--- a/Documentation/core-api/kernel-api.rst
+++ b/Documentation/core-api/kernel-api.rst
@@ -33,6 +33,9 @@ String Conversions
 .. kernel-doc:: lib/kstrtox.c
    :export:
 
+.. kernel-doc:: lib/string_helpers.c
+   :export:
+
 String Manipulation
 -------------------
 
-- 
2.20.1

Re: [PATCH v1] docs/core-api: Add string helpers API to the list

[Mike Rapoport]

On Wed, Jun 05, 2019 at 07:39:44PM +0300, Andy Shevchenko wrote:
> 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.
> 
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

Acked-by: Mike Rapoport <rppt@linux.ibm.com>

> ---
>  Documentation/core-api/kernel-api.rst | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst
> index a53ec2eb8176..65ae2bf1f86d 100644
> --- a/Documentation/core-api/kernel-api.rst
> +++ b/Documentation/core-api/kernel-api.rst
> @@ -33,6 +33,9 @@ String Conversions
>  .. kernel-doc:: lib/kstrtox.c
>     :export:
> 
> +.. kernel-doc:: lib/string_helpers.c
> +   :export:
> +
>  String Manipulation
>  -------------------
> 
> -- 
> 2.20.1
> 

-- 
Sincerely yours,
Mike.

Re: [PATCH v1] docs/core-api: Add string helpers API to the list

[Jonathan Corbet]

On Wed,  5 Jun 2019 19:39:44 +0300
Andy Shevchenko <andriy.shevchenko@linux.intel.com> wrote:

> 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.
> 
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

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:

> +./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