From: Jonathan Corbet <corbet@lwn.net>
To: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Cc: linux-doc@vger.kernel.org,
Andrew Morton <akpm@linux-foundation.org>,
Mike Rapoport <rppt@linux.vnet.ibm.com>
Subject: Re: [PATCH v1] docs/core-api: Add string helpers API to the list
Date: Thu, 6 Jun 2019 10:01:58 -0600 [thread overview]
Message-ID: <20190606100158.76df3cb5@lwn.net> (raw)
In-Reply-To: <20190605163944.50803-1-andriy.shevchenko@linux.intel.com>
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
prev parent reply other threads:[~2019-06-06 16:02 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-05 16:39 [PATCH v1] docs/core-api: Add string helpers API to the list Andy Shevchenko
2019-06-05 21:39 ` Mike Rapoport
2019-06-06 16:01 ` Jonathan Corbet [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190606100158.76df3cb5@lwn.net \
--to=corbet@lwn.net \
--cc=akpm@linux-foundation.org \
--cc=andriy.shevchenko@linux.intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=rppt@linux.vnet.ibm.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).