diff mbox series

[01/10] iio: core: Fix the kernel doc regarding the currentmode iio_dev entry

Message ID 20211215151344.163036-2-miquel.raynal@bootlin.com (mailing list archive)
State Changes Requested
Headers show
Series Light core IIO enhancements | expand

Commit Message

Miquel Raynal Dec. 15, 2021, 3:13 p.m. UTC
This is an internal variable, which should be accessed in a very
sporadic way and in no case changed by any device driver.

Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
---
 include/linux/iio/iio.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Alexandru Ardelean Dec. 16, 2021, 6:23 a.m. UTC | #1
On Wed, Dec 15, 2021 at 10:04 PM Miquel Raynal
<miquel.raynal@bootlin.com> wrote:
>
> This is an internal variable, which should be accessed in a very
> sporadic way and in no case changed by any device driver.

Reviewed-by: Alexandru Ardelean <ardeleanalex@gmail.com>

>
> Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
> ---
>  include/linux/iio/iio.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
> index 324561b7a5e8..06433c2c2968 100644
> --- a/include/linux/iio/iio.h
> +++ b/include/linux/iio/iio.h
> @@ -488,7 +488,7 @@ struct iio_buffer_setup_ops {
>  /**
>   * struct iio_dev - industrial I/O device
>   * @modes:             [DRIVER] operating modes supported by device
> - * @currentmode:       [DRIVER] current operating mode
> + * @currentmode:       [INTERN] current operating mode
>   * @dev:               [DRIVER] device structure, should be assigned a parent
>   *                     and owner
>   * @buffer:            [DRIVER] any buffer present
> --
> 2.27.0
>
Jonathan Cameron Jan. 15, 2022, 3:47 p.m. UTC | #2
On Wed, 15 Dec 2021 16:13:35 +0100
Miquel Raynal <miquel.raynal@bootlin.com> wrote:

Sorry for taking so long to get to these. I knew some of them were
likely to take some thinking so they kept falling at the end of
my review list and I kept running out of time / energy!

Anyhow, time to make some progress.

> This is an internal variable, which should be accessed in a very
> sporadic way and in no case changed by any device driver.
> 
> Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
Hohum.  Plenty of history around this one but I think you are right
that it now makes sense to mark it as INTERN (and when we can move it
over to the opaque structure).

Applied to the togreg branch of iio.git and pushed out as testing.

Thanks,

Jonathan

> ---
>  include/linux/iio/iio.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
> index 324561b7a5e8..06433c2c2968 100644
> --- a/include/linux/iio/iio.h
> +++ b/include/linux/iio/iio.h
> @@ -488,7 +488,7 @@ struct iio_buffer_setup_ops {
>  /**
>   * struct iio_dev - industrial I/O device
>   * @modes:		[DRIVER] operating modes supported by device
> - * @currentmode:	[DRIVER] current operating mode
> + * @currentmode:	[INTERN] current operating mode
>   * @dev:		[DRIVER] device structure, should be assigned a parent
>   *			and owner
>   * @buffer:		[DRIVER] any buffer present
diff mbox series

Patch

diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
index 324561b7a5e8..06433c2c2968 100644
--- a/include/linux/iio/iio.h
+++ b/include/linux/iio/iio.h
@@ -488,7 +488,7 @@  struct iio_buffer_setup_ops {
 /**
  * struct iio_dev - industrial I/O device
  * @modes:		[DRIVER] operating modes supported by device
- * @currentmode:	[DRIVER] current operating mode
+ * @currentmode:	[INTERN] current operating mode
  * @dev:		[DRIVER] device structure, should be assigned a parent
  *			and owner
  * @buffer:		[DRIVER] any buffer present