Skip to contentSkip to conversation

gpio: uapi: fix line info flags description

PATCH Applied Kent Gibson 2 participants 2 messages Jan 19, 2021 – Jan 22, 2021

Subsystems (2)
lore
Share & tools
lore

Kent Gibson

author reviewer
#0 lore raw

PATCH 1/1 gpio: uapi: fix line info flags description

The description of the flags field of the struct gpio_v2_line_info mentions "the GPIO lines" while the info only applies to an individual GPIO line. This was accidentally changed from "the GPIO line" during formatting improvements.

Reword to "this GPIO line" to clarify and to be consistent with other struct gpio_v2_line_info fields.

Fixes 2cc522d3931b ("gpio: uapi: kernel-doc formatting improvements")
---
 include/uapi/linux/gpio.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/uapi/linux/gpio.h +1 -1
index e4eb0b8c5cf9..7a6f7948a7df 100644
@@ -212,7 +212,7 @@ struct gpio_v2_line_request {
  * @offset: the local offset on this GPIO chip, fill this in when
  * requesting the line information from the kernel
  * @num_attrs: the number of attributes in @attrs
- * @flags: flags for the GPIO lines, with values from &enum
+ * @flags: flags for this GPIO line, with values from &enum
  * gpio_v2_line_flag, such as %GPIO_V2_LINE_FLAG_ACTIVE_LOW,
  * %GPIO_V2_LINE_FLAG_OUTPUT etc, added together.
  * @attrs: the configuration attributes associated with the line
Signature · 1 line
2.30.0
#1 lore raw
Quoted 29 lines · Kent Gibson

The description of the flags field of the struct gpio_v2_line_info mentions "the GPIO lines" while the info only applies to an individual GPIO line. This was accidentally changed from "the GPIO line" during formatting improvements.

Reword to "this GPIO line" to clarify and to be consistent with other struct gpio_v2_line_info fields.

Fixes 2cc522d3931b ("gpio: uapi: kernel-doc formatting improvements")
---
 include/uapi/linux/gpio.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/uapi/linux/gpio.h +1 -2
index e4eb0b8c5cf9..7a6f7948a7df 100644
@@ -212,7 +212,7 @@ struct gpio_v2_line_request {
  * @offset: the local offset on this GPIO chip, fill this in when
  * requesting the line information from the kernel
  * @num_attrs: the number of attributes in @attrs
- * @flags: flags for the GPIO lines, with values from &enum
+ * @flags: flags for this GPIO line, with values from &enum
  * gpio_v2_line_flag, such as %GPIO_V2_LINE_FLAG_ACTIVE_LOW,
  * %GPIO_V2_LINE_FLAG_OUTPUT etc, added together.
  * @attrs: the configuration attributes associated with the line
--
Quoted 2 lines

2.30.0

Applied, thanks!

Bart