Skip to contentSkip to conversation

pinctrl: aspeed: placate kernel-doc warnings

PATCH New Randy Dunlap 3 participants 3 messages Jul 23, 2021 – Aug 10, 2021

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 pinctrl: aspeed: placate kernel-doc warnings

Eliminate kernel-doc warnings in drivers/pinctrl/aspeed by using proper kernel-doc notation.

Fixes these kernel-doc warnings:

drivers/pinctrl/aspeed/pinmux-aspeed.c:61: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Query the enabled or disabled state for a mux function's signal on a pin
drivers/pinctrl/aspeed/pinctrl-aspeed.c:135: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Search for the signal expression needed to enable the pin's signal for the

Cc Aditya Srivastava <[email protected]>
Cc Andrew Jeffery <[email protected]>
Cc linux-aspeed at lists.ozlabs.org
Cc openbmc at lists.ozlabs.org
Cc Linus Walleij <[email protected]>
Cc linux-gpio at vger.kernel.org
---
 drivers/pinctrl/aspeed/pinctrl-aspeed.c |    4 ++--
 drivers/pinctrl/aspeed/pinmux-aspeed.c  |    3 ++-
 2 files changed, 4 insertions(+), 3 deletions(-)
drivers/pinctrl/aspeed/pinmux-aspeed.c +2 -1
@@ -59,7 +59,8 @@ int aspeed_sig_desc_eval(const struct as
 }
 
 /**
- * Query the enabled or disabled state for a mux function's signal on a pin
+ * aspeed_sig_expr_eval - Query the enabled or disabled state for a
+ * mux function's signal on a pin
  *
  * @ctx: The driver context for the pinctrl IP
  * @expr: An expression controlling the signal for a mux function on a pin
drivers/pinctrl/aspeed/pinctrl-aspeed.c +2 -2
@@ -133,8 +133,8 @@ static int aspeed_disable_sig(struct asp
 }
 
 /**
- * Search for the signal expression needed to enable the pin's signal for the
- * requested function.
+ * aspeed_find_expr_by_name - Search for the signal expression needed to
+ * enable the pin's signal for the requested function.
  *
  * @exprs: List of signal expressions (haystack)
  * @name: The name of the requested function (needle)
#1 lore raw

PATCH 1/1 pinctrl: aspeed: placate kernel-doc warnings

Quoted 5 lines · Randy Dunlap

Eliminate kernel-doc warnings in drivers/pinctrl/aspeed by using proper kernel-doc notation.

Fixes these kernel-doc warnings:

Quoted 11 lines

drivers/pinctrl/aspeed/pinmux-aspeed.c:61: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Query the enabled or disabled state for a mux function's signal
on a pin
drivers/pinctrl/aspeed/pinctrl-aspeed.c:135: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Search for the signal expression needed to enable the pin's
signal for the

#2 lore raw

PATCH 1/1 pinctrl: aspeed: placate kernel-doc warnings

In reply to Randy Dunlap
Quoted 10 lines · Randy Dunlap

Eliminate kernel-doc warnings in drivers/pinctrl/aspeed by using proper kernel-doc notation.

Fixes these kernel-doc warnings:

drivers/pinctrl/aspeed/pinmux-aspeed.c:61: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Query the enabled or disabled state for a mux function's signal on a pin
drivers/pinctrl/aspeed/pinctrl-aspeed.c:135: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Search for the signal expression needed to enable the pin's signal for the

Quoted 8 lines
Cc Aditya Srivastava <[email protected]>
Cc Andrew Jeffery <[email protected]>
Cc linux-aspeed at lists.ozlabs.org
Cc openbmc at lists.ozlabs.org
Cc Linus Walleij <[email protected]>
Cc linux-gpio at vger.kernel.org

Patch applied.

Yours,
Linus Walleij