pinctrl: aspeed: Fix minor documentation error
Subsystems (4)
PATCH 1/1 pinctrl: aspeed: Fix minor documentation error
Kernel test robot throws below warning ->
drivers/pinctrl/aspeed/pinctrl-aspeed-g5.c:2705: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pinctrl/aspeed/pinctrl-aspeed-g6.c:2614: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pinctrl/aspeed/pinctrl-aspeed.c:111: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pinctrl/aspeed/pinmux-aspeed.c:24: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
Fix minor documentation error.
--- drivers/pinctrl/aspeed/pinctrl-aspeed-g5.c | 4 ++-- drivers/pinctrl/aspeed/pinctrl-aspeed-g6.c | 4 ++-- drivers/pinctrl/aspeed/pinctrl-aspeed.c | 3 ++- drivers/pinctrl/aspeed/pinmux-aspeed.c | 3 ++- 4 files changed, 8 insertions(+), 6 deletions(-)
drivers/pinctrl/aspeed/pinctrl-aspeed-g5.c +2 -2
@@ -2702,8 +2702,8 @@ static int aspeed_g5_sig_expr_eval(struct aspeed_pinmux_data *ctx, }/** -* Configure a pin's signal by applying an expression's descriptor state for -* all descriptors in the expression. +* aspeed_g5_sig_expr_set() - Configure a pin's signal by applying an +* expression's descriptor state for all descriptors in the expression. * * @ctx: The pinmux context * @expr: The expression associated with the function whose signal is to be
drivers/pinctrl/aspeed/pinctrl-aspeed-g6.c +2 -2
@@ -2611,8 +2611,8 @@ };/** -* Configure a pin's signal by applying an expression's descriptor state for -* all descriptors in the expression. +* aspeed_g6_sig_expr_set() - Configure a pin's signal by applying an +* expression's descriptor state for all descriptors in the expression. * * @ctx: The pinmux context * @expr: The expression associated with the function whose signal is to be
drivers/pinctrl/aspeed/pinctrl-aspeed.c +2 -1
@@ -108,7 +108,8 @@ static int aspeed_sig_expr_disable(struct aspeed_pinmux_data *ctx, }/** -* Disable a signal on a pin by disabling all provided signal expressions. +* aspeed_disable_sig() - Disable a signal on a pin by disabling all provided +* signal expressions. * * @ctx: The pinmux context * @exprs: The list of signal expressions (from a priority level on a pin)
drivers/pinctrl/aspeed/pinmux-aspeed.c +2 -1
@@ -21,7 +21,8 @@ static inline void aspeed_sig_desc_print_val( }/** -* Query the enabled or disabled state of a signal descriptor +* aspeed_sig_desc_eval() - Query the enabled or disabled state of a signal +* descriptor. * * @desc: The signal descriptor of interest * @enabled: True to query the enabled state, false to query disabled state
Signature · 1 line
1.9.1
Quoted 15 lines · Souptick Joarder
Kernel test robot throws below warning ->
drivers/pinctrl/aspeed/pinctrl-aspeed-g5.c:2705: warning: This comment starts with '/**', but isn't a kernel-doc comment. ReferDocumentation/doc-guide/kernel-doc.rstdrivers/pinctrl/aspeed/pinctrl-aspeed-g6.c:2614: warning: This comment starts with '/**', but isn't a kernel-doc comment. ReferDocumentation/doc-guide/kernel-doc.rstdrivers/pinctrl/aspeed/pinctrl-aspeed.c:111: warning: This comment starts with '/**', but isn't a kernel-doc comment. ReferDocumentation/doc-guide/kernel-doc.rstdrivers/pinctrl/aspeed/pinmux-aspeed.c:24: warning: This comment starts with '/**', but isn't a kernel-doc comment. ReferDocumentation/doc-guide/kernel-doc.rst
Quoted 5 lines
Fix minor documentation error.
Reported-by kernel test robot <[email protected]>Signed-off-by Souptick Joarder <[email protected]>Cc Randy Dunlap <[email protected]>
Thanks.
Quoted 66 lines
--- drivers/pinctrl/aspeed/pinctrl-aspeed-g5.c | 4 ++-- drivers/pinctrl/aspeed/pinctrl-aspeed-g6.c | 4 ++-- drivers/pinctrl/aspeed/pinctrl-aspeed.c | 3 ++- drivers/pinctrl/aspeed/pinmux-aspeed.c | 3 ++- 4 files changed, 8 insertions(+), 6 deletions(-)drivers/pinctrl/aspeed/pinctrl-aspeed-g5.c +2
-2@@ -2702,8 +2702,8 @@ static int aspeed_g5_sig_expr_eval(struct aspeed_pinmux_data *ctx, }/** -* Configure a pin's signal by applying an expression's descriptor state for -* all descriptors in the expression. +* aspeed_g5_sig_expr_set() - Configure a pin's signal by applying an +* expression's descriptor state for all descriptors in the expression. * * @ctx: The pinmux context * @expr: The expression associated with the function whose signal is to be drivers/pinctrl/aspeed/pinctrl-aspeed-g6.c +2
-2@@ -2611,8 +2611,8 @@ };/** -* Configure a pin's signal by applying an expression's descriptor state for -* all descriptors in the expression. +* aspeed_g6_sig_expr_set() - Configure a pin's signal by applying an +* expression's descriptor state for all descriptors in the expression. * * @ctx: The pinmux context * @expr: The expression associated with the function whose signal is to be drivers/pinctrl/aspeed/pinctrl-aspeed.c +2
-1@@ -108,7 +108,8 @@ static int aspeed_sig_expr_disable(struct aspeed_pinmux_data *ctx, }/** -* Disable a signal on a pin by disabling all provided signal expressions. +* aspeed_disable_sig() - Disable a signal on a pin by disabling all provided +* signal expressions. * * @ctx: The pinmux context * @exprs: The list of signal expressions (from a priority level on a pin) drivers/pinctrl/aspeed/pinmux-aspeed.c +2
-1@@ -21,7 +21,8 @@ static inline void aspeed_sig_desc_print_val( }/** -* Query the enabled or disabled state of a signal descriptor +* aspeed_sig_desc_eval() - Query the enabled or disabled state of a signal +* descriptor. * * @desc: The signal descriptor of interest * @enabled: True to query the enabled state, false to query disabled state
Signature · 1 line
~Randy
Quoted 15 lines · Souptick Joarder
Kernel test robot throws below warning ->
drivers/pinctrl/aspeed/pinctrl-aspeed-g5.c:2705: warning: This comment starts with '/**', but isn't a kernel-doc comment. ReferDocumentation/doc-guide/kernel-doc.rstdrivers/pinctrl/aspeed/pinctrl-aspeed-g6.c:2614: warning: This comment starts with '/**', but isn't a kernel-doc comment. ReferDocumentation/doc-guide/kernel-doc.rstdrivers/pinctrl/aspeed/pinctrl-aspeed.c:111: warning: This comment starts with '/**', but isn't a kernel-doc comment. ReferDocumentation/doc-guide/kernel-doc.rstdrivers/pinctrl/aspeed/pinmux-aspeed.c:24: warning: This comment starts with '/**', but isn't a kernel-doc comment. ReferDocumentation/doc-guide/kernel-doc.rst
Quoted 5 lines
Fix minor documentation error.
Reported-by kernel test robot <[email protected]>Signed-off-by Souptick Joarder <[email protected]>Cc Randy Dunlap <[email protected]>
Quoted 1 line · Souptick Joarder
Kernel test robot throws below warning ->
Patch applied for fixes!
Yours,
Linus Walleij