| Message ID | 20220531092817.13894-1-bagasdotme@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Delegated to: | Jiri Kosina |
| Headers | show |
| Series | [v2] HID: uclogic: properly format kernel-doc comment for hid_dbg() wrappers | expand |
On 5/31/22 02:28, Bagas Sanjaya wrote: > Running kernel-doc script on drivers/hid/hid-uclogic-params.c, it found > 6 warnings for hid_dbg() wrapper functions below: > > drivers/hid/hid-uclogic-params.c:48: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * Dump tablet interface pen parameters with hid_dbg(), indented with one tab. > drivers/hid/hid-uclogic-params.c:48: warning: missing initial short description on line: > * Dump tablet interface pen parameters with hid_dbg(), indented with one tab. > drivers/hid/hid-uclogic-params.c:48: info: Scanning doc for function Dump > drivers/hid/hid-uclogic-params.c:80: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * Dump tablet interface frame parameters with hid_dbg(), indented with two > drivers/hid/hid-uclogic-params.c:80: warning: missing initial short description on line: > * Dump tablet interface frame parameters with hid_dbg(), indented with two > drivers/hid/hid-uclogic-params.c:80: info: Scanning doc for function Dump > drivers/hid/hid-uclogic-params.c:105: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * Dump tablet interface parameters with hid_dbg(). > drivers/hid/hid-uclogic-params.c:105: warning: missing initial short description on line: > * Dump tablet interface parameters with hid_dbg(). > > One of them is reported by kernel test robot. > > Fix these warnings by properly format kernel-doc comment for these > functions. > > Link: https://lore.kernel.org/linux-doc/202205272033.XFYlYj8k-lkp@intel.com/ > Fixes: a228809fa6f39c ("HID: uclogic: Move param printing to a function") > Reported-by: kernel test robot <lkp@intel.com> > Cc: Nikolai Kondrashov <spbnick@gmail.com> > Cc: Jiri Kosina <jikos@kernel.org> > Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com> > Cc: "José Expósito" <jose.exposito89@gmail.com> > Cc: llvm@lists.linux.dev > Cc: stable@vger.kernel.org # v5.18 > Cc: linux-input@vger.kernel.org > Cc: linux-kernel@vger.kernel.org > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> > --- > Changes since v1 [1]: > - Approach the warning by fixing kernel-doc comments formatting > (suggested by Jonathan Corbet) > > [1]: https://lore.kernel.org/linux-doc/20220528091403.160169-1-bagasdotme@gmail.com/ Tested-by: Randy Dunlap <rdunlap@infradead.org> Acked-by: Randy Dunlap <rdunlap@infradead.org> One note (nit) below: > drivers/hid/hid-uclogic-params.c | 24 ++++++++++++++---------- > 1 file changed, 14 insertions(+), 10 deletions(-) > > diff --git a/drivers/hid/hid-uclogic-params.c b/drivers/hid/hid-uclogic-params.c > index db838f16282d64..647bbd3e000e2f 100644 > --- a/drivers/hid/hid-uclogic-params.c > +++ b/drivers/hid/hid-uclogic-params.c > @@ -23,11 +23,11 @@ > /** > * uclogic_params_pen_inrange_to_str() - Convert a pen in-range reporting type > * to a string. > - * > * @inrange: The in-range reporting type to convert. > * > - * Returns: > - * The string representing the type, or NULL if the type is unknown. > + * Return: > + * * The string representing the type, or > + * * NULL if the type is unknown. %NULL would be better here, but not required. > */ > static const char *uclogic_params_pen_inrange_to_str( > enum uclogic_params_pen_inrange inrange) Thanks.
> One note (nit) below: > > > drivers/hid/hid-uclogic-params.c | 24 ++++++++++++++---------- > > 1 file changed, 14 insertions(+), 10 deletions(-) > > > > diff --git a/drivers/hid/hid-uclogic-params.c b/drivers/hid/hid-uclogic-params.c > > index db838f16282d64..647bbd3e000e2f 100644 > > --- a/drivers/hid/hid-uclogic-params.c > > +++ b/drivers/hid/hid-uclogic-params.c > > @@ -23,11 +23,11 @@ > > /** > > * uclogic_params_pen_inrange_to_str() - Convert a pen in-range reporting type > > * to a string. > > - * > > * @inrange: The in-range reporting type to convert. > > * > > - * Returns: > > - * The string representing the type, or NULL if the type is unknown. > > + * Return: > > + * * The string representing the type, or > > + * * NULL if the type is unknown. > > %NULL > would be better here, but not required. > Hi Randy, I don't see %NULL in Documentation/ (I git-grep-ed it but none found). What should I do when I have to explain NULL in Return: section of kernel-doc comment?
On 6/1/22 00:27, Bagas Sanjaya wrote: >> One note (nit) below: >> >>> drivers/hid/hid-uclogic-params.c | 24 ++++++++++++++---------- >>> 1 file changed, 14 insertions(+), 10 deletions(-) >>> >>> diff --git a/drivers/hid/hid-uclogic-params.c b/drivers/hid/hid-uclogic-params.c >>> index db838f16282d64..647bbd3e000e2f 100644 >>> --- a/drivers/hid/hid-uclogic-params.c >>> +++ b/drivers/hid/hid-uclogic-params.c >>> @@ -23,11 +23,11 @@ >>> /** >>> * uclogic_params_pen_inrange_to_str() - Convert a pen in-range reporting type >>> * to a string. >>> - * >>> * @inrange: The in-range reporting type to convert. >>> * >>> - * Returns: >>> - * The string representing the type, or NULL if the type is unknown. >>> + * Return: >>> + * * The string representing the type, or >>> + * * NULL if the type is unknown. >> >> %NULL >> would be better here, but not required. >> > > Hi Randy, > > I don't see %NULL in Documentation/ (I git-grep-ed it but none found). > What should I do when I have to explain NULL in Return: section of > kernel-doc comment? In Documentation/doc-guide/kernel-doc.rst, section Highlights and cross-references: ``%CONST`` Name of a constant. (No cross-referencing, just formatting.) So '%' before a constant value just helps with the generated formatting of the output. It's just "prettier." No big deal.
> On 6/1/22 00:27, Bagas Sanjaya wrote: > Running kernel-doc script on drivers/hid/hid-uclogic-params.c, it found > 6 warnings for hid_dbg() wrapper functions below: > [...] Hi Bagas, Thanks a lot for fixing these warnings. I compiled it and I can confirm that the sparse warning is also fixed. Tested-by: José Expósito <jose.exposito89@gmail.com>
On Wed, Jun 01, 2022 at 05:18:52AM -0700, Randy Dunlap wrote: > In Documentation/doc-guide/kernel-doc.rst, section Highlights and cross-references: > > ``%CONST`` > Name of a constant. (No cross-referencing, just formatting.) > > So '%' before a constant value just helps with the generated formatting > of the output. It's just "prettier." No big deal. > Thanks for suggestion!
diff --git a/drivers/hid/hid-uclogic-params.c b/drivers/hid/hid-uclogic-params.c index db838f16282d64..647bbd3e000e2f 100644 --- a/drivers/hid/hid-uclogic-params.c +++ b/drivers/hid/hid-uclogic-params.c @@ -23,11 +23,11 @@ /** * uclogic_params_pen_inrange_to_str() - Convert a pen in-range reporting type * to a string. - * * @inrange: The in-range reporting type to convert. * - * Returns: - * The string representing the type, or NULL if the type is unknown. + * Return: + * * The string representing the type, or + * * NULL if the type is unknown. */ static const char *uclogic_params_pen_inrange_to_str( enum uclogic_params_pen_inrange inrange) @@ -45,10 +45,12 @@ static const char *uclogic_params_pen_inrange_to_str( } /** - * Dump tablet interface pen parameters with hid_dbg(), indented with one tab. - * + * uclogic_params_pen_hid_dbg() - Dump tablet interface pen parameters * @hdev: The HID device the pen parameters describe. * @pen: The pen parameters to dump. + * + * Dump tablet interface pen parameters with hid_dbg(). The dump is indented + * with a tab. */ static void uclogic_params_pen_hid_dbg(const struct hid_device *hdev, const struct uclogic_params_pen *pen) @@ -77,11 +79,12 @@ static void uclogic_params_pen_hid_dbg(const struct hid_device *hdev, } /** - * Dump tablet interface frame parameters with hid_dbg(), indented with two - * tabs. - * + * uclogic_params_frame_hid_dbg() - Dump tablet interface frame parameters * @hdev: The HID device the pen parameters describe. * @frame: The frame parameters to dump. + * + * Dump tablet interface frame parameters with hid_dbg(). The dump is + * indented with two tabs. */ static void uclogic_params_frame_hid_dbg( const struct hid_device *hdev, @@ -102,10 +105,11 @@ static void uclogic_params_frame_hid_dbg( } /** - * Dump tablet interface parameters with hid_dbg(). - * + * uclogic_params_hid_dbg() - Dump tablet interface parameters * @hdev: The HID device the parameters describe. * @params: The parameters to dump. + * + * Dump tablet interface parameters with hid_dbg(). */ void uclogic_params_hid_dbg(const struct hid_device *hdev, const struct uclogic_params *params)
Running kernel-doc script on drivers/hid/hid-uclogic-params.c, it found 6 warnings for hid_dbg() wrapper functions below: drivers/hid/hid-uclogic-params.c:48: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Dump tablet interface pen parameters with hid_dbg(), indented with one tab. drivers/hid/hid-uclogic-params.c:48: warning: missing initial short description on line: * Dump tablet interface pen parameters with hid_dbg(), indented with one tab. drivers/hid/hid-uclogic-params.c:48: info: Scanning doc for function Dump drivers/hid/hid-uclogic-params.c:80: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Dump tablet interface frame parameters with hid_dbg(), indented with two drivers/hid/hid-uclogic-params.c:80: warning: missing initial short description on line: * Dump tablet interface frame parameters with hid_dbg(), indented with two drivers/hid/hid-uclogic-params.c:80: info: Scanning doc for function Dump drivers/hid/hid-uclogic-params.c:105: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Dump tablet interface parameters with hid_dbg(). drivers/hid/hid-uclogic-params.c:105: warning: missing initial short description on line: * Dump tablet interface parameters with hid_dbg(). One of them is reported by kernel test robot. Fix these warnings by properly format kernel-doc comment for these functions. Link: https://lore.kernel.org/linux-doc/202205272033.XFYlYj8k-lkp@intel.com/ Fixes: a228809fa6f39c ("HID: uclogic: Move param printing to a function") Reported-by: kernel test robot <lkp@intel.com> Cc: Nikolai Kondrashov <spbnick@gmail.com> Cc: Jiri Kosina <jikos@kernel.org> Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com> Cc: "José Expósito" <jose.exposito89@gmail.com> Cc: llvm@lists.linux.dev Cc: stable@vger.kernel.org # v5.18 Cc: linux-input@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> --- Changes since v1 [1]: - Approach the warning by fixing kernel-doc comments formatting (suggested by Jonathan Corbet) [1]: https://lore.kernel.org/linux-doc/20220528091403.160169-1-bagasdotme@gmail.com/ drivers/hid/hid-uclogic-params.c | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) base-commit: 8ab2afa23bd197df47819a87f0265c0ac95c5b6a