* [PATCH] iio: Correct kernel-doc inconsistency
@ 2020-07-15 19:17 Colton Lewis
2020-07-18 16:19 ` Jonathan Cameron
0 siblings, 1 reply; 2+ messages in thread
From: Colton Lewis @ 2020-07-15 19:17 UTC (permalink / raw)
To: jic23; +Cc: linux-iio, Colton Lewis
Silence documentation build warning by correcting kernel-doc comment
for iio_dev struct.
./include/linux/iio/iio.h:574: warning: Function parameter or member 'read_buf' not described in 'iio_dev'
./include/linux/iio/iio.h:574: warning: Function parameter or member 'read_buf_len' not described in 'iio_dev'
Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
---
include/linux/iio/iio.h | 2 ++
1 file changed, 2 insertions(+)
diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
index a1be82e74c93..48049b344e6c 100644
--- a/include/linux/iio/iio.h
+++ b/include/linux/iio/iio.h
@@ -522,6 +522,8 @@ struct iio_buffer_setup_ops {
* @flags: [INTERN] file ops related flags including busy flag.
* @debugfs_dentry: [INTERN] device specific debugfs dentry.
* @cached_reg_addr: [INTERN] cached register address for debugfs reads.
+ * @read_buf: [INTERN] cached register contents for debugfs reads
+ * @read_buf_len: [INTERN] length of @read_buf
*/
struct iio_dev {
int id;
--
2.26.2
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] iio: Correct kernel-doc inconsistency
2020-07-15 19:17 [PATCH] iio: Correct kernel-doc inconsistency Colton Lewis
@ 2020-07-18 16:19 ` Jonathan Cameron
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Cameron @ 2020-07-18 16:19 UTC (permalink / raw)
To: Colton Lewis; +Cc: linux-iio
On Wed, 15 Jul 2020 19:17:09 +0000
Colton Lewis <colton.w.lewis@protonmail.com> wrote:
> Silence documentation build warning by correcting kernel-doc comment
> for iio_dev struct.
>
> ./include/linux/iio/iio.h:574: warning: Function parameter or member 'read_buf' not described in 'iio_dev'
> ./include/linux/iio/iio.h:574: warning: Function parameter or member 'read_buf_len' not described in 'iio_dev'
>
> Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
Hi Colton,
Thanks for the patch, but these elements have moved and now have docs
(very recent!) See the testing branch of iio.git on git.kernel.org
Jonathan
> ---
> include/linux/iio/iio.h | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
> index a1be82e74c93..48049b344e6c 100644
> --- a/include/linux/iio/iio.h
> +++ b/include/linux/iio/iio.h
> @@ -522,6 +522,8 @@ struct iio_buffer_setup_ops {
> * @flags: [INTERN] file ops related flags including busy flag.
> * @debugfs_dentry: [INTERN] device specific debugfs dentry.
> * @cached_reg_addr: [INTERN] cached register address for debugfs reads.
> + * @read_buf: [INTERN] cached register contents for debugfs reads
> + * @read_buf_len: [INTERN] length of @read_buf
> */
> struct iio_dev {
> int id;
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2020-07-18 16:19 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-15 19:17 [PATCH] iio: Correct kernel-doc inconsistency Colton Lewis
2020-07-18 16:19 ` Jonathan Cameron
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).