linux-kernel - Re: [PATCH] iio: add kernel-doc '@...er'

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]

Date:   Sat, 30 Dec 2017 20:58:12 +1100
From:   "Tobin C. Harding" <me@...in.cc>
To:     Jonathan Cameron <jic23@...nel.org>
Cc:     Hartmut Knaack <knaack.h@....de>,
        Lars-Peter Clausen <lars@...afoo.de>,
        Peter Meerwald-Stadler <pmeerw@...erw.net>,
        linux-iio@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] iio: add kernel-doc '@...er'

On Fri, Dec 29, 2017 at 05:36:40PM +0000, Jonathan Cameron wrote:
> On Tue, 19 Dec 2017 17:17:50 +1100
> "Tobin C. Harding" <me@...in.cc> wrote:
> 
> > When building kernel documentation sphinx emits the following warning
> > 
> > 	warning: No description found for parameter 'owner'
> > 
> > Add description for struct member 'owner'.
> > 
> > Signed-off-by: Tobin C. Harding <me@...in.cc>
> > ---
> > 
> > I couldn't work out what DRIVER/INTERN were for so I took a guess.
> Try the other one ;)
> 
> They refer to whether the driver should be directly accessing the
> field or not.  In the case of owner they shouldn't be so it is INTERN.
> 
> Were I writing the subsystem from scratch again I'd probably make the
> separation of the two cleaner, but there we are.

Thanks, will re-spin after Christmas break.

	Tobin