linux-kernel - Re: [PATCH 15/18] iio: iio.h: use nested struct support on kernel-doc markup

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <20180507180803.21e967b2@archlinux>
Date:   Mon, 7 May 2018 18:08:03 +0100
From:   Jonathan Cameron <jic23@...nel.org>
To:     Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Hartmut Knaack <knaack.h@....de>,
        Lars-Peter Clausen <lars@...afoo.de>,
        Peter Meerwald-Stadler <pmeerw@...erw.net>,
        linux-iio@...r.kernel.org
Subject: Re: [PATCH 15/18] iio: iio.h: use nested struct support on
 kernel-doc markup

On Mon,  7 May 2018 06:35:51 -0300
Mauro Carvalho Chehab <mchehab+samsung@...nel.org> wrote:

> Solve those Sphinx warnings:
> 
>     ./include/linux/iio/iio.h:270: warning: Function parameter or member 'scan_type.sign' not described in 'iio_chan_spec'
>     ./include/linux/iio/iio.h:270: warning: Function parameter or member 'scan_type.realbits' not described in 'iio_chan_spec'
>     ./include/linux/iio/iio.h:270: warning: Function parameter or member 'scan_type.storagebits' not described in 'iio_chan_spec'
>     ./include/linux/iio/iio.h:270: warning: Function parameter or member 'scan_type.shift' not described in 'iio_chan_spec'
>     ./include/linux/iio/iio.h:270: warning: Function parameter or member 'scan_type.repeat' not described in 'iio_chan_spec'
>     ./include/linux/iio/iio.h:270: warning: Function parameter or member 'scan_type.endianness' not described in 'iio_chan_spec'
> 
>     ./include/linux/iio/iio.h:191: WARNING: Unexpected indentation.
>     ./include/linux/iio/iio.h:192: WARNING: Block quote ends without a blank line; unexpected unindent.
>     ./include/linux/iio/iio.h:198: WARNING: Definition list ends without a blank line; unexpected unindent.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
Great thanks.  I couldn't figure out how to do this last time
I looked at it.

Applied to the togreg branch of iio.git and pushed out as testing for
the autobuilders to ignore it.

Thanks,

Jonathan
> ---
>  include/linux/iio/iio.h | 24 ++++++++++++------------
>  1 file changed, 12 insertions(+), 12 deletions(-)
> 
> diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
> index 11579fd4126e..a74cb177dc6f 100644
> --- a/include/linux/iio/iio.h
> +++ b/include/linux/iio/iio.h
> @@ -183,18 +183,18 @@ struct iio_event_spec {
>   * @address:		Driver specific identifier.
>   * @scan_index:		Monotonic index to give ordering in scans when read
>   *			from a buffer.
> - * @scan_type:		sign:		's' or 'u' to specify signed or unsigned
> - *			realbits:	Number of valid bits of data
> - *			storagebits:	Realbits + padding
> - *			shift:		Shift right by this before masking out
> - *					realbits.
> - *			repeat:		Number of times real/storage bits
> - *					repeats. When the repeat element is
> - *					more than 1, then the type element in
> - *					sysfs will show a repeat value.
> - *					Otherwise, the number of repetitions is
> - *					omitted.
> - *			endianness:	little or big endian
> + * @scan_type:		struct describing the scan type
> + * @scan_type.sign:		's' or 'u' to specify signed or unsigned
> + * @scan_type.realbits:		Number of valid bits of data
> + * @scan_type.storagebits:	Realbits + padding
> + * @scan_type.shift:		Shift right by this before masking out
> + *				realbits.
> + * @scan_type.repeat:		Number of times real/storage bits repeats.
> + *				When the repeat element is more than 1, then
> + *				the type element in sysfs will show a repeat
> + *				value. Otherwise, the number of repetitions
> + *				is omitted.
> + * @scan_type.endianness:	little or big endian
>   * @info_mask_separate: What information is to be exported that is specific to
>   *			this channel.
>   * @info_mask_separate_available: What availability information is to be