linux-kernel - Re: [PATCH 1/2] HID: uclogic: remove extraneous asterisk on uclogic_params

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <87tu988jq7.fsf@meer.lwn.net>
Date:   Sun, 29 May 2022 09:02:56 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Bagas Sanjaya <bagasdotme@...il.com>, linux-doc@...r.kernel.org
Cc:     Bagas Sanjaya <bagasdotme@...il.com>,
        kernel test robot <lkp@...el.com>,
        Nikolai Kondrashov <spbnick@...il.com>,
        Jiri Kosina <jikos@...nel.org>,
        Benjamin Tissoires <benjamin.tissoires@...hat.com>,
        José Expósito 
        <jose.exposito89@...il.com>, llvm@...ts.linux.dev,
        linux-input@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 1/2] HID: uclogic: remove extraneous asterisk on
 uclogic_params_* static functions comments

Bagas Sanjaya <bagasdotme@...il.com> writes:

> *uclogic_params_pen_inrange_to_str(), uclogic_params_pen_hid_dbg(), and
> uclogic_params_frame_hid_dbg() are static functions but contain
> double-asterisk (/** */) comment, which confuses kernel-doc as public
> function for generating documentation.
>
> Remove the extraneous asterisk from these comments.

So there is nothing wrong with making kerneldoc comments for static
functions, that is not where the problem lies.

> 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@...el.com>
> Cc: Nikolai Kondrashov <spbnick@...il.com>
> Cc: Jiri Kosina <jikos@...nel.org>
> Cc: Benjamin Tissoires <benjamin.tissoires@...hat.com>
> Cc: "José Expósito" <jose.exposito89@...il.com>
> Cc: llvm@...ts.linux.dev
> Cc: linux-input@...r.kernel.org
> Cc: linux-kernel@...r.kernel.org
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
> ---
>  drivers/hid/hid-uclogic-params.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/hid/hid-uclogic-params.c b/drivers/hid/hid-uclogic-params.c
> index db838f16282d64..71501453de12e4 100644
> --- a/drivers/hid/hid-uclogic-params.c
> +++ b/drivers/hid/hid-uclogic-params.c
> @@ -20,7 +20,7 @@
>  #include <linux/ctype.h>
>  #include <asm/unaligned.h>
>  
> -/**
> +/*
>   * uclogic_params_pen_inrange_to_str() - Convert a pen in-range reporting type
>   *                                       to a string.
>   *

A more likely problem here is the blank between the function intro and
the parameter description.

> @@ -44,7 +44,7 @@ static const char *uclogic_params_pen_inrange_to_str(
>  	}
>  }
>  
> -/**
> +/*
>   * Dump tablet interface pen parameters with hid_dbg(), indented with one tab.
>   *

Here too

>   * @hdev:	The HID device the pen parameters describe.
> @@ -76,7 +76,7 @@ static void uclogic_params_pen_hid_dbg(const struct hid_device *hdev,
>  		(pen->tilt_y_flipped ? "true" : "false"));
>  }
>  
> -/**
> +/*
>   * Dump tablet interface frame parameters with hid_dbg(), indented with two
>   * tabs.
>   *

Here, instead, this needs to be formatted as a proper kerneldoc comment
with the function name.

jon