diff mbox series

counter: Add the necessary colons and indents to the comments of counter_compi

Message ID 20211205130816.4121898-1-siyanteng@loongson.cn (mailing list archive)
State Handled Elsewhere
Headers show
Series counter: Add the necessary colons and indents to the comments of counter_compi | expand

Commit Message

yanteng si Dec. 5, 2021, 1:08 p.m. UTC 
Fix warning as:

linux-next/Documentation/driver-api/generic-counter:234: ./include/linux/counter.h:43: WARNING: Unexpected indentation.
linux-next/Documentation/driver-api/generic-counter:234: ./include/linux/counter.h:45: WARNING: Block quote ends without a blank line; unexpected unindent.

Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
---
 include/linux/counter.h | 40 ++++++++++++++++++++--------------------
 1 file changed, 20 insertions(+), 20 deletions(-)

Comments

William Breathitt Gray Dec. 10, 2021, 10:28 p.m. UTC | #1 
On Sun, Dec 05, 2021 at 09:08:16PM +0800, Yanteng Si wrote:
> Fix warning as:
> 
> linux-next/Documentation/driver-api/generic-counter:234: ./include/linux/counter.h:43: WARNING: Unexpected indentation.
> linux-next/Documentation/driver-api/generic-counter:234: ./include/linux/counter.h:45: WARNING: Block quote ends without a blank line; unexpected unindent.
> 
> Signed-off-by: Yanteng Si <siyanteng@loongson.cn>

Hello Yanteng,

Thank you for the patch. Is this fixing commit aaec1a0f76ec ("counter:
Internalize sysfs interface code")?

William Breathitt Gray

> ---
>  include/linux/counter.h | 40 ++++++++++++++++++++--------------------
>  1 file changed, 20 insertions(+), 20 deletions(-)
> 
> diff --git a/include/linux/counter.h b/include/linux/counter.h
> index b7d0a00a61cf..dfbde2808998 100644
> --- a/include/linux/counter.h
> +++ b/include/linux/counter.h
> @@ -38,64 +38,64 @@ enum counter_comp_type {
>   * @type:		Counter component data type
>   * @name:		device-specific component name
>   * @priv:		component-relevant data
> - * @action_read		Synapse action mode read callback. The read value of the
> + * @action_read:		Synapse action mode read callback. The read value of the
>   *			respective Synapse action mode should be passed back via
>   *			the action parameter.
> - * @device_u8_read	Device u8 component read callback. The read value of the
> + * @device_u8_read:		Device u8 component read callback. The read value of the
>   *			respective Device u8 component should be passed back via
>   *			the val parameter.
> - * @count_u8_read	Count u8 component read callback. The read value of the
> + * @count_u8_read:		Count u8 component read callback. The read value of the
>   *			respective Count u8 component should be passed back via
>   *			the val parameter.
> - * @signal_u8_read	Signal u8 component read callback. The read value of the
> + * @signal_u8_read:		Signal u8 component read callback. The read value of the
>   *			respective Signal u8 component should be passed back via
>   *			the val parameter.
> - * @device_u32_read	Device u32 component read callback. The read value of
> + * @device_u32_read:		Device u32 component read callback. The read value of
>   *			the respective Device u32 component should be passed
>   *			back via the val parameter.
> - * @count_u32_read	Count u32 component read callback. The read value of the
> + * @count_u32_read:		Count u32 component read callback. The read value of the
>   *			respective Count u32 component should be passed back via
>   *			the val parameter.
> - * @signal_u32_read	Signal u32 component read callback. The read value of
> + * @signal_u32_read:		Signal u32 component read callback. The read value of
>   *			the respective Signal u32 component should be passed
>   *			back via the val parameter.
> - * @device_u64_read	Device u64 component read callback. The read value of
> + * @device_u64_read:		Device u64 component read callback. The read value of
>   *			the respective Device u64 component should be passed
>   *			back via the val parameter.
> - * @count_u64_read	Count u64 component read callback. The read value of the
> + * @count_u64_read:		Count u64 component read callback. The read value of the
>   *			respective Count u64 component should be passed back via
>   *			the val parameter.
> - * @signal_u64_read	Signal u64 component read callback. The read value of
> + * @signal_u64_read:		Signal u64 component read callback. The read value of
>   *			the respective Signal u64 component should be passed
>   *			back via the val parameter.
> - * @action_write	Synapse action mode write callback. The write value of
> + * @action_write:		Synapse action mode write callback. The write value of
>   *			the respective Synapse action mode is passed via the
>   *			action parameter.
> - * @device_u8_write	Device u8 component write callback. The write value of
> + * @device_u8_write:		Device u8 component write callback. The write value of
>   *			the respective Device u8 component is passed via the val
>   *			parameter.
> - * @count_u8_write	Count u8 component write callback. The write value of
> + * @count_u8_write:		Count u8 component write callback. The write value of
>   *			the respective Count u8 component is passed via the val
>   *			parameter.
> - * @signal_u8_write	Signal u8 component write callback. The write value of
> + * @signal_u8_write:		Signal u8 component write callback. The write value of
>   *			the respective Signal u8 component is passed via the val
>   *			parameter.
> - * @device_u32_write	Device u32 component write callback. The write value of
> + * @device_u32_write:		Device u32 component write callback. The write value of
>   *			the respective Device u32 component is passed via the
>   *			val parameter.
> - * @count_u32_write	Count u32 component write callback. The write value of
> + * @count_u32_write:		Count u32 component write callback. The write value of
>   *			the respective Count u32 component is passed via the val
>   *			parameter.
> - * @signal_u32_write	Signal u32 component write callback. The write value of
> + * @signal_u32_write:		Signal u32 component write callback. The write value of
>   *			the respective Signal u32 component is passed via the
>   *			val parameter.
> - * @device_u64_write	Device u64 component write callback. The write value of
> + * @device_u64_write:		Device u64 component write callback. The write value of
>   *			the respective Device u64 component is passed via the
>   *			val parameter.
> - * @count_u64_write	Count u64 component write callback. The write value of
> + * @count_u64_write:		Count u64 component write callback. The write value of
>   *			the respective Count u64 component is passed via the val
>   *			parameter.
> - * @signal_u64_write	Signal u64 component write callback. The write value of
> + * @signal_u64_write:		Signal u64 component write callback. The write value of
>   *			the respective Signal u64 component is passed via the
>   *			val parameter.
>   */
> -- 
> 2.27.0
>
yanteng si Dec. 11, 2021, 11:47 a.m. UTC | #2 
William Breathitt Gray <vilhelm.gray@gmail.com> 于2021年12月11日周六 06:28写道：
>
> On Sun, Dec 05, 2021 at 09:08:16PM +0800, Yanteng Si wrote:
> > Fix warning as:
> >
> > linux-next/Documentation/driver-api/generic-counter:234: ./include/linux/counter.h:43: WARNING: Unexpected indentation.
> > linux-next/Documentation/driver-api/generic-counter:234: ./include/linux/counter.h:45: WARNING: Block quote ends without a blank line; unexpected unindent.
> >
> > Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
>
> Hello Yanteng,
>
> Thank you for the patch. Is this fixing commit aaec1a0f76ec ("counter:
> Internalize sysfs interface code")?
Yeah, I will add a it in patch v2.

Thank you very much!

Thanks,
Yanteng
>
> William Breathitt Gray
>
> > ---
> >  include/linux/counter.h | 40 ++++++++++++++++++++--------------------
> >  1 file changed, 20 insertions(+), 20 deletions(-)
> >
> > diff --git a/include/linux/counter.h b/include/linux/counter.h
> > index b7d0a00a61cf..dfbde2808998 100644
> > --- a/include/linux/counter.h
> > +++ b/include/linux/counter.h
> > @@ -38,64 +38,64 @@ enum counter_comp_type {
> >   * @type:            Counter component data type
> >   * @name:            device-specific component name
> >   * @priv:            component-relevant data
> > - * @action_read              Synapse action mode read callback. The read value of the
> > + * @action_read:             Synapse action mode read callback. The read value of the
> >   *                   respective Synapse action mode should be passed back via
> >   *                   the action parameter.
> > - * @device_u8_read   Device u8 component read callback. The read value of the
> > + * @device_u8_read:          Device u8 component read callback. The read value of the
> >   *                   respective Device u8 component should be passed back via
> >   *                   the val parameter.
> > - * @count_u8_read    Count u8 component read callback. The read value of the
> > + * @count_u8_read:           Count u8 component read callback. The read value of the
> >   *                   respective Count u8 component should be passed back via
> >   *                   the val parameter.
> > - * @signal_u8_read   Signal u8 component read callback. The read value of the
> > + * @signal_u8_read:          Signal u8 component read callback. The read value of the
> >   *                   respective Signal u8 component should be passed back via
> >   *                   the val parameter.
> > - * @device_u32_read  Device u32 component read callback. The read value of
> > + * @device_u32_read:         Device u32 component read callback. The read value of
> >   *                   the respective Device u32 component should be passed
> >   *                   back via the val parameter.
> > - * @count_u32_read   Count u32 component read callback. The read value of the
> > + * @count_u32_read:          Count u32 component read callback. The read value of the
> >   *                   respective Count u32 component should be passed back via
> >   *                   the val parameter.
> > - * @signal_u32_read  Signal u32 component read callback. The read value of
> > + * @signal_u32_read:         Signal u32 component read callback. The read value of
> >   *                   the respective Signal u32 component should be passed
> >   *                   back via the val parameter.
> > - * @device_u64_read  Device u64 component read callback. The read value of
> > + * @device_u64_read:         Device u64 component read callback. The read value of
> >   *                   the respective Device u64 component should be passed
> >   *                   back via the val parameter.
> > - * @count_u64_read   Count u64 component read callback. The read value of the
> > + * @count_u64_read:          Count u64 component read callback. The read value of the
> >   *                   respective Count u64 component should be passed back via
> >   *                   the val parameter.
> > - * @signal_u64_read  Signal u64 component read callback. The read value of
> > + * @signal_u64_read:         Signal u64 component read callback. The read value of
> >   *                   the respective Signal u64 component should be passed
> >   *                   back via the val parameter.
> > - * @action_write     Synapse action mode write callback. The write value of
> > + * @action_write:            Synapse action mode write callback. The write value of
> >   *                   the respective Synapse action mode is passed via the
> >   *                   action parameter.
> > - * @device_u8_write  Device u8 component write callback. The write value of
> > + * @device_u8_write:         Device u8 component write callback. The write value of
> >   *                   the respective Device u8 component is passed via the val
> >   *                   parameter.
> > - * @count_u8_write   Count u8 component write callback. The write value of
> > + * @count_u8_write:          Count u8 component write callback. The write value of
> >   *                   the respective Count u8 component is passed via the val
> >   *                   parameter.
> > - * @signal_u8_write  Signal u8 component write callback. The write value of
> > + * @signal_u8_write:         Signal u8 component write callback. The write value of
> >   *                   the respective Signal u8 component is passed via the val
> >   *                   parameter.
> > - * @device_u32_write Device u32 component write callback. The write value of
> > + * @device_u32_write:                Device u32 component write callback. The write value of
> >   *                   the respective Device u32 component is passed via the
> >   *                   val parameter.
> > - * @count_u32_write  Count u32 component write callback. The write value of
> > + * @count_u32_write:         Count u32 component write callback. The write value of
> >   *                   the respective Count u32 component is passed via the val
> >   *                   parameter.
> > - * @signal_u32_write Signal u32 component write callback. The write value of
> > + * @signal_u32_write:                Signal u32 component write callback. The write value of
> >   *                   the respective Signal u32 component is passed via the
> >   *                   val parameter.
> > - * @device_u64_write Device u64 component write callback. The write value of
> > + * @device_u64_write:                Device u64 component write callback. The write value of
> >   *                   the respective Device u64 component is passed via the
> >   *                   val parameter.
> > - * @count_u64_write  Count u64 component write callback. The write value of
> > + * @count_u64_write:         Count u64 component write callback. The write value of
> >   *                   the respective Count u64 component is passed via the val
> >   *                   parameter.
> > - * @signal_u64_write Signal u64 component write callback. The write value of
> > + * @signal_u64_write:                Signal u64 component write callback. The write value of
> >   *                   the respective Signal u64 component is passed via the
> >   *                   val parameter.
> >   */
> > --
> > 2.27.0
> >
diff mbox series

Patch

diff --git a/include/linux/counter.h b/include/linux/counter.h
index b7d0a00a61cf..dfbde2808998 100644
--- a/include/linux/counter.h
+++ b/include/linux/counter.h
@@ -38,64 +38,64 @@  enum counter_comp_type {
  * @type:		Counter component data type
  * @name:		device-specific component name
  * @priv:		component-relevant data
- * @action_read		Synapse action mode read callback. The read value of the
+ * @action_read:		Synapse action mode read callback. The read value of the
  *			respective Synapse action mode should be passed back via
  *			the action parameter.
- * @device_u8_read	Device u8 component read callback. The read value of the
+ * @device_u8_read:		Device u8 component read callback. The read value of the
  *			respective Device u8 component should be passed back via
  *			the val parameter.
- * @count_u8_read	Count u8 component read callback. The read value of the
+ * @count_u8_read:		Count u8 component read callback. The read value of the
  *			respective Count u8 component should be passed back via
  *			the val parameter.
- * @signal_u8_read	Signal u8 component read callback. The read value of the
+ * @signal_u8_read:		Signal u8 component read callback. The read value of the
  *			respective Signal u8 component should be passed back via
  *			the val parameter.
- * @device_u32_read	Device u32 component read callback. The read value of
+ * @device_u32_read:		Device u32 component read callback. The read value of
  *			the respective Device u32 component should be passed
  *			back via the val parameter.
- * @count_u32_read	Count u32 component read callback. The read value of the
+ * @count_u32_read:		Count u32 component read callback. The read value of the
  *			respective Count u32 component should be passed back via
  *			the val parameter.
- * @signal_u32_read	Signal u32 component read callback. The read value of
+ * @signal_u32_read:		Signal u32 component read callback. The read value of
  *			the respective Signal u32 component should be passed
  *			back via the val parameter.
- * @device_u64_read	Device u64 component read callback. The read value of
+ * @device_u64_read:		Device u64 component read callback. The read value of
  *			the respective Device u64 component should be passed
  *			back via the val parameter.
- * @count_u64_read	Count u64 component read callback. The read value of the
+ * @count_u64_read:		Count u64 component read callback. The read value of the
  *			respective Count u64 component should be passed back via
  *			the val parameter.
- * @signal_u64_read	Signal u64 component read callback. The read value of
+ * @signal_u64_read:		Signal u64 component read callback. The read value of
  *			the respective Signal u64 component should be passed
  *			back via the val parameter.
- * @action_write	Synapse action mode write callback. The write value of
+ * @action_write:		Synapse action mode write callback. The write value of
  *			the respective Synapse action mode is passed via the
  *			action parameter.
- * @device_u8_write	Device u8 component write callback. The write value of
+ * @device_u8_write:		Device u8 component write callback. The write value of
  *			the respective Device u8 component is passed via the val
  *			parameter.
- * @count_u8_write	Count u8 component write callback. The write value of
+ * @count_u8_write:		Count u8 component write callback. The write value of
  *			the respective Count u8 component is passed via the val
  *			parameter.
- * @signal_u8_write	Signal u8 component write callback. The write value of
+ * @signal_u8_write:		Signal u8 component write callback. The write value of
  *			the respective Signal u8 component is passed via the val
  *			parameter.
- * @device_u32_write	Device u32 component write callback. The write value of
+ * @device_u32_write:		Device u32 component write callback. The write value of
  *			the respective Device u32 component is passed via the
  *			val parameter.
- * @count_u32_write	Count u32 component write callback. The write value of
+ * @count_u32_write:		Count u32 component write callback. The write value of
  *			the respective Count u32 component is passed via the val
  *			parameter.
- * @signal_u32_write	Signal u32 component write callback. The write value of
+ * @signal_u32_write:		Signal u32 component write callback. The write value of
  *			the respective Signal u32 component is passed via the
  *			val parameter.
- * @device_u64_write	Device u64 component write callback. The write value of
+ * @device_u64_write:		Device u64 component write callback. The write value of
  *			the respective Device u64 component is passed via the
  *			val parameter.
- * @count_u64_write	Count u64 component write callback. The write value of
+ * @count_u64_write:		Count u64 component write callback. The write value of
  *			the respective Count u64 component is passed via the val
  *			parameter.
- * @signal_u64_write	Signal u64 component write callback. The write value of
+ * @signal_u64_write:		Signal u64 component write callback. The write value of
  *			the respective Signal u64 component is passed via the
  *			val parameter.
  */