From: Mike Rapoport <rppt@linux.ibm.com>
To: Andrew Morton <akpm@linux-foundation.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
linux-mm@kvack.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, Mike Rapoport <rppt@linux.ibm.com>
Subject: [RESEND PATCH 0/3] docs/core-api/mm: fix return value descriptions
Date: Thu, 7 Feb 2019 16:27:21 +0200 [thread overview]
Message-ID: <1549549644-4903-1-git-send-email-rppt@linux.ibm.com> (raw)
Many kernel-doc comments referenced by Documentation/core-api/mm-api.rst
have the return value descriptions misformatted or lack it completely. This
makes kernel-doc script unhappy and produces more than 100 warnings when
running
make htmldocs V=1
These patches fix the formatting of present return value descriptions and
add some new ones.
As these patches touch lots of mm/ files, I think it's better to merge them
via -mm tree.
Side note:
----------
I've noticed that kernel-doc produces
warning: contents before sections
when it is parsing description of a function that has no parameters, but
does have a return value, i.e.
unsigned long nr_free_buffer_pages(void)
As far as I can tell, the generated html is ok no matter if the detailed
description present before 'the sections', so probably this warning is not
really needed?
Mike Rapoport (3):
docs/mm: vmalloc: re-indent kernel-doc comemnts
docs/core-api/mm: fix user memory accessors formatting
docs/core-api/mm: fix return value descriptions in mm/
arch/x86/include/asm/uaccess.h | 24 +--
arch/x86/lib/usercopy_32.c | 8 +-
mm/dmapool.c | 13 +-
mm/filemap.c | 73 ++++++--
mm/memory.c | 26 ++-
mm/mempool.c | 8 +
mm/page-writeback.c | 24 ++-
mm/page_alloc.c | 24 ++-
mm/readahead.c | 2 +
mm/slab.c | 14 ++
mm/slab_common.c | 6 +
mm/truncate.c | 6 +-
mm/util.c | 37 ++--
mm/vmalloc.c | 394 ++++++++++++++++++++++-------------------
14 files changed, 409 insertions(+), 250 deletions(-)
--
2.7.4
next reply other threads:[~2019-02-07 14:27 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-02-07 14:27 Mike Rapoport [this message]
2019-02-07 14:27 ` [RESEND PATCH 1/3] docs/mm: vmalloc: re-indent kernel-doc comemnts Mike Rapoport
2019-02-07 14:27 ` [RESEND PATCH 2/3] docs/core-api/mm: fix user memory accessors formatting Mike Rapoport
2019-02-07 14:27 ` [RESEND PATCH 3/3] docs/core-api/mm: fix return value descriptions in mm/ Mike Rapoport
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=1549549644-4903-1-git-send-email-rppt@linux.ibm.com \
--to=rppt@linux.ibm.com \
--cc=akpm@linux-foundation.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
/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).