lkml.org 
[lkml]   [2019]   [Jan]   [20]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
Subject[PATCH 0/3] docs/core-api/mm: fix return value descriptions
Date
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.

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

\
 
 \ /
  Last update: 2019-01-20 13:02    [W:0.064 / U:1.312 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site