diff mbox

[v3,2/2] iio: add field identifier for @use_count kernel-doc

Message ID 1515275766-31302-3-git-send-email-me@tobin.cc (mailing list archive)
State New, archived
Headers show

Commit Message

Tobin Harding Jan. 6, 2018, 9:56 p.m. UTC
Kernel-doc for @use_count does not currently have a field identifier.
All the rest of the fields do. @use_count is used internally and should
not be accessed directly by the driver so it should be marked as so.

Add [INTERN] identifier to @use_count field.

Signed-off-by: Tobin C. Harding <me@tobin.cc>
---
 include/linux/iio/trigger.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Jonathan Cameron Jan. 7, 2018, 4:15 p.m. UTC | #1
On Sun,  7 Jan 2018 08:56:06 +1100
"Tobin C. Harding" <me@tobin.cc> wrote:

> Kernel-doc for @use_count does not currently have a field identifier.
> All the rest of the fields do. @use_count is used internally and should
> not be accessed directly by the driver so it should be marked as so.
> 
> Add [INTERN] identifier to @use_count field.
> 
> Signed-off-by: Tobin C. Harding <me@tobin.cc>
Applied to the togreg branch of iio.git and pushed out as testing
for the autobuilder to play with it.

Thanks,

Jonathan

> ---
>  include/linux/iio/trigger.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/iio/trigger.h b/include/linux/iio/trigger.h
> index 390789d43369..b19b7204ef84 100644
> --- a/include/linux/iio/trigger.h
> +++ b/include/linux/iio/trigger.h
> @@ -49,7 +49,7 @@ struct iio_trigger_ops {
>   * @dev:		[DRIVER] associated device (if relevant)
>   * @list:		[INTERN] used in maintenance of global trigger list
>   * @alloc_list:		[DRIVER] used for driver specific trigger list
> - * @use_count:		use count for the trigger
> + * @use_count:		[INTERN] use count for the trigger.
>   * @subirq_chip:	[INTERN] associate 'virtual' irq chip.
>   * @subirq_base:	[INTERN] base number for irqs provided by trigger.
>   * @subirqs:		[INTERN] information about the 'child' irqs.

--
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 mbox

Patch

diff --git a/include/linux/iio/trigger.h b/include/linux/iio/trigger.h
index 390789d43369..b19b7204ef84 100644
--- a/include/linux/iio/trigger.h
+++ b/include/linux/iio/trigger.h
@@ -49,7 +49,7 @@  struct iio_trigger_ops {
  * @dev:		[DRIVER] associated device (if relevant)
  * @list:		[INTERN] used in maintenance of global trigger list
  * @alloc_list:		[DRIVER] used for driver specific trigger list
- * @use_count:		use count for the trigger
+ * @use_count:		[INTERN] use count for the trigger.
  * @subirq_chip:	[INTERN] associate 'virtual' irq chip.
  * @subirq_base:	[INTERN] base number for irqs provided by trigger.
  * @subirqs:		[INTERN] information about the 'child' irqs.