linux-kernel - Re: [PATCH 0/3] docs/core-api/mm: fix return value descriptions

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-Id: <20190131110428.GJ28876@rapoport-lnx>
Date:   Thu, 31 Jan 2019 13:04:29 +0200
From:   Mike Rapoport <rppt@...ux.ibm.com>
To:     linux-mm@...ck.org
Cc:     Andrew Morton <akpm@...ux-foundation.org>,
        Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH 0/3] docs/core-api/mm: fix return value descriptions

Any comments on these?

On Sun, Jan 20, 2019 at 02:01:34PM +0200, Mike Rapoport wrote:
> 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
> 

-- 
Sincerely yours,
Mike.