diff mbox

[1/2,RESEND] iio: add kernel-doc for field @owner

Message ID 1515202318-17401-2-git-send-email-me@tobin.cc (mailing list archive)
State New, archived
Headers show

Commit Message

Tobin Harding Jan. 6, 2018, 1:31 a.m. UTC
When building kernel documentation sphinx emits the following warning

	warning: No description found for parameter 'owner'

Add description for struct member 'owner'.

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

Comments

Jonathan Cameron Jan. 6, 2018, 1 p.m. UTC | #1
On Sat,  6 Jan 2018 12:31:57 +1100
"Tobin C. Harding" <me@tobin.cc> wrote:

> When building kernel documentation sphinx emits the following warning
> 
> 	warning: No description found for parameter 'owner'
> 
> Add description for struct member 'owner'.
> 
> Signed-off-by: Tobin C. Harding <me@tobin.cc>

This isn't a resend.  It's a version 2.  Please resend with the
changes from v1 clearly stated.

If you were resending you should say why as well in the cover letter!

Jonathan

> ---
>  include/linux/iio/trigger.h | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/include/linux/iio/trigger.h b/include/linux/iio/trigger.h
> index 7d5e44518379..390789d43369 100644
> --- a/include/linux/iio/trigger.h
> +++ b/include/linux/iio/trigger.h
> @@ -43,6 +43,7 @@ struct iio_trigger_ops {
>  /**
>   * struct iio_trigger - industrial I/O trigger device
>   * @ops:		[DRIVER] operations structure
> + * @owner:		[INTERN] owner of this driver module
>   * @id:			[INTERN] unique id number
>   * @name:		[DRIVER] unique name
>   * @dev:		[DRIVER] associated device (if relevant)

--
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
Tobin Harding Jan. 6, 2018, 9:40 p.m. UTC | #2
On Sat, Jan 06, 2018 at 01:00:53PM +0000, Jonathan Cameron wrote:
> On Sat,  6 Jan 2018 12:31:57 +1100
> "Tobin C. Harding" <me@tobin.cc> wrote:
> 
> > When building kernel documentation sphinx emits the following warning
> > 
> > 	warning: No description found for parameter 'owner'
> > 
> > Add description for struct member 'owner'.
> > 
> > Signed-off-by: Tobin C. Harding <me@tobin.cc>
> 
> This isn't a resend.  It's a version 2.  Please resend with the
> changes from v1 clearly stated.

Oh, you are right it should have been a version 2. The 'resend' referred
to the single cover letter I sent (forgot --to-cover --cc-cover flags to
git send-email).

> If you were resending you should say why as well in the cover letter!

My mistake, sloppy work.

> Jonathan

Thanks for your patience. Will fix up and re-send (as v3 ;)

thanks,
Tobin
--
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 7d5e44518379..390789d43369 100644
--- a/include/linux/iio/trigger.h
+++ b/include/linux/iio/trigger.h
@@ -43,6 +43,7 @@  struct iio_trigger_ops {
 /**
  * struct iio_trigger - industrial I/O trigger device
  * @ops:		[DRIVER] operations structure
+ * @owner:		[INTERN] owner of this driver module
  * @id:			[INTERN] unique id number
  * @name:		[DRIVER] unique name
  * @dev:		[DRIVER] associated device (if relevant)