* [PATCH v2] counter: Add the necessary colons and indents to the comments of counter_compi
@ 2021-12-11 11:53 Yanteng Si
2021-12-15 8:18 ` William Breathitt Gray
0 siblings, 1 reply; 3+ messages in thread
From: Yanteng Si @ 2021-12-11 11:53 UTC (permalink / raw)
To: vilhelm.gray
Cc: Yanteng Si, corbet, linux-doc, linux-iio, chenhuacai, Yanteng Si
From: Yanteng Si <siyanteng01@gmail.com>
Since aaec1a0f76ec ("counter: Internalize sysfs interface code") introduce a 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.
Add the necessary colons and indents.
Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
---
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
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v2] counter: Add the necessary colons and indents to the comments of counter_compi
2021-12-11 11:53 [PATCH v2] counter: Add the necessary colons and indents to the comments of counter_compi Yanteng Si
@ 2021-12-15 8:18 ` William Breathitt Gray
2021-12-16 2:25 ` yanteng si
0 siblings, 1 reply; 3+ messages in thread
From: William Breathitt Gray @ 2021-12-15 8:18 UTC (permalink / raw)
To: Yanteng Si; +Cc: corbet, linux-doc, linux-iio, chenhuacai, Yanteng Si
[-- Attachment #1: Type: text/plain, Size: 6756 bytes --]
On Sat, Dec 11, 2021 at 07:53:15PM +0800, Yanteng Si wrote:
> From: Yanteng Si <siyanteng01@gmail.com>
>
> Since aaec1a0f76ec ("counter: Internalize sysfs interface code") introduce a 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.
>
> Add the necessary colons and indents.
>
> Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Hi Yanteng,
Thank you for resubmitting this patch with a reference to the commit
that introduced the bug. I'll pick this patch up and submit it later
with the rest of the Counter changes for this cycle.
For future patches, please add information about which commit a patch
fixes by using the Fixes tag. For example, this patch would have the
following Fixes tag above your Signed-off-by tag.
Fixes: aaec1a0f76ec ("counter: Internalize sysfs interface code")
I'll add that Fixes tag for you as I pick this up so you won't need to
resubmit this patch again. :-)
Thanks,
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
>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH v2] counter: Add the necessary colons and indents to the comments of counter_compi
2021-12-15 8:18 ` William Breathitt Gray
@ 2021-12-16 2:25 ` yanteng si
0 siblings, 0 replies; 3+ messages in thread
From: yanteng si @ 2021-12-16 2:25 UTC (permalink / raw)
To: William Breathitt Gray
Cc: Jonathan Corbet, Linux Doc Mailing List, linux-iio, Huacai Chen,
Yanteng Si
William Breathitt Gray <vilhelm.gray@gmail.com> 于2021年12月15日周三 16:18写道：
>
> On Sat, Dec 11, 2021 at 07:53:15PM +0800, Yanteng Si wrote:
> > From: Yanteng Si <siyanteng01@gmail.com>
> >
> > Since aaec1a0f76ec ("counter: Internalize sysfs interface code") introduce a 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.
> >
> > Add the necessary colons and indents.
> >
> > Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
>
> Hi Yanteng,
>
> Thank you for resubmitting this patch with a reference to the commit
> that introduced the bug. I'll pick this patch up and submit it later
> with the rest of the Counter changes for this cycle.
>
> For future patches, please add information about which commit a patch
> fixes by using the Fixes tag. For example, this patch would have the
> following Fixes tag above your Signed-off-by tag.
>
> Fixes: aaec1a0f76ec ("counter: Internalize sysfs interface code")
>
> I'll add that Fixes tag for you as I pick this up so you won't need to
> resubmit this patch again. :-)
OK! Thanks! >_<
Thanks
Yanteng
>
> Thanks,
>
> 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
> >
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-12-16 2:25 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-12-11 11:53 [PATCH v2] counter: Add the necessary colons and indents to the comments of counter_compi Yanteng Si
2021-12-15 8:18 ` William Breathitt Gray
2021-12-16 2:25 ` yanteng si
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox