| Message ID | 1a31240699b1b6ee089b5b36889ab27ae14ad94e.1525684985.git.mchehab+samsung@kernel.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
On Mon, 7 May 2018 06:35:51 -0300 Mauro Carvalho Chehab <mchehab+samsung@kernel.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@kernel.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 -- To unsubscribe from this list: send the line "unsubscribe linux-iio" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Em Mon, 7 May 2018 18:08:03 +0100 Jonathan Cameron <jic23@kernel.org> escreveu: > On Mon, 7 May 2018 06:35:51 -0300 > Mauro Carvalho Chehab <mchehab+samsung@kernel.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@kernel.org> > Great thanks. I couldn't figure out how to do this last time > I looked at it. Support for nested structs were only recently introduced :-) > > Applied to the togreg branch of iio.git and pushed out as testing for > the autobuilders to ignore it. Thanks! Mauro -- To unsubscribe from this list: send the line "unsubscribe linux-iio" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
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
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@kernel.org> --- include/linux/iio/iio.h | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-)