linux-kernel - Re: [PATCH 20/22] usb: typec_altmode: add a missing "@" at a kernel-doc parameter

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] [thread-next>] [day] [month] [year] [list]

Date:   Tue, 28 Jun 2022 12:55:29 +0300
From:   Heikki Krogerus <heikki.krogerus@...ux.intel.com>
To:     Mauro Carvalho Chehab <mchehab@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        linux-kernel@...r.kernel.org, linux-usb@...r.kernel.org
Subject: Re: [PATCH 20/22] usb: typec_altmode: add a missing "@" at a
 kernel-doc parameter

On Tue, Jun 28, 2022 at 10:46:24AM +0100, Mauro Carvalho Chehab wrote:
> Without that, the parameter is not properly parsed:
> 	include/linux/usb/typec_altmode.h:132: warning: Function parameter or member 'altmode' not described in 'typec_altmode_get_orientation'
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@...nel.org>

Acked-by: Heikki Krogerus <heikki.krogerus@...ux.intel.com>

> ---
> 
> To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH 00/22] at: https://lore.kernel.org/all/cover.1656409369.git.mchehab@kernel.org/
> 
>  include/linux/usb/typec_altmode.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/usb/typec_altmode.h b/include/linux/usb/typec_altmode.h
> index 65933cbe9129..350d49012659 100644
> --- a/include/linux/usb/typec_altmode.h
> +++ b/include/linux/usb/typec_altmode.h
> @@ -124,7 +124,7 @@ struct typec_altmode *typec_match_altmode(struct typec_altmode **altmodes,
>  
>  /**
>   * typec_altmode_get_orientation - Get cable plug orientation
> - * altmode: Handle to the alternate mode
> + * @altmode: Handle to the alternate mode
>   */
>  static inline enum typec_orientation
>  typec_altmode_get_orientation(struct typec_altmode *altmode)
> -- 
> 2.36.1

-- 
heikki