2022-09-02 14:32:01

by William Breathitt Gray

[permalink] [raw]

Subject: [PATCH] counter: Realign counter_comp comment block to 80 characters

---

The member documentation comment lines for struct counter_comp extend
past the 80-characters column boundary due to extra identation at the
start of each section. This patch realigns the comment block within the
80-characters boundary by removing these superfluous indents.

Cc: Yanteng Si <[email protected]>
Signed-off-by: William Breathitt Gray <[email protected]>
---
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 1fe17f5adb09..a81234bc8ea8 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.
*/

base-commit: a12224997bec72d231a8dd642876e6364decdc45
--
2.37.2

2022-09-03 07:09:22

by Yanteng Si

[permalink] [raw]

Subject: Re: [PATCH] counter: Realign counter_comp comment block to 80 characters

---

在 2022/9/2 20:08, William Breathitt Gray 写道:
> The member documentation comment lines for struct counter_comp extend
> past the 80-characters column boundary due to extra identation at the
> start of each section. This patch realigns the comment block within the
> 80-characters boundary by removing these superfluous indents.
>
> Cc: Yanteng Si <[email protected]>
> Signed-off-by: William Breathitt Gray <[email protected]>
Reviewed-by: Yanteng Si <[email protected]>
> ---
> 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 1fe17f5adb09..a81234bc8ea8 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.
> */
>
> base-commit: a12224997bec72d231a8dd642876e6364decdc45

2022-09-11 16:29:45

by William Breathitt Gray

[permalink] [raw]

Subject: Re: [PATCH] counter: Realign counter_comp comment block to 80 characters

---

On Fri, Sep 02, 2022 at 08:08:39AM -0400, William Breathitt Gray wrote:
> The member documentation comment lines for struct counter_comp extend
> past the 80-characters column boundary due to extra identation at the
> start of each section. This patch realigns the comment block within the
> 80-characters boundary by removing these superfluous indents.
>
> Cc: Yanteng Si <[email protected]>
> Signed-off-by: William Breathitt Gray <[email protected]>

Applied to counter-current.

William Breathitt Gray

---

Attachments:

(No filename) (529.00 B)
signature.asc (235.00 B)
Download all attachments