linux-kernel - Re: [PATCH v2] jbd2: fix sphinx kerel-doc build warnings

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 for Android: free password hash cracker in your pocket

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

Message-ID: <20180110052619.GG5809@thunk.org>
Date:   Wed, 10 Jan 2018 00:26:19 -0500
From:   Theodore Ts'o <tytso@....edu>
To:     "Tobin C. Harding" <me@...in.cc>
Cc:     Jan Kara <jack@...e.com>, linux-ext4@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] jbd2: fix sphinx kerel-doc build warnings

On Wed, Jan 10, 2018 at 12:42:29PM +1100, Tobin C. Harding wrote:
> Sphinx emits various (26) warnings when building make target 'htmldocs'.
> Currently struct definitions contain duplicate documentation, some as
> kernel-docs and some as standard c89 comments.  We can reduce
> duplication while cleaning up the kernel docs.
> 
> Move all kernel-docs to right above each struct member.  Use the set of
> all existing comments (kernel-doc and c89).  Add documentation for
> missing struct members and function arguments.
> 
> Signed-off-by: Tobin C. Harding <me@...in.cc>

Thanks, applied.  I did fix up a few of your newly added doc strings.

		    	       - Ted