linux-kernel - Re: [PATCH v3 40/56] firmware: stratix10-svc: fix kernel-doc markups

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]

Message-ID: <42c3c7bf-bbdb-cba8-af58-37fb3637f443@linux.intel.com>
Date:   Tue, 27 Oct 2020 12:31:12 -0500
From:   Richard Gong <richard.gong@...ux.intel.com>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>
Cc:     Jonathan Corbet <corbet@....net>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v3 40/56] firmware: stratix10-svc: fix kernel-doc markups

Acked-by: Richard Gong <richard.gong@...ux.intel.com>

On 10/23/20 11:33 AM, Mauro Carvalho Chehab wrote:
> There are some common comments marked, instead, with kernel-doc
> notation, which won't work.
> 
> While here, rename an identifier, in order to match the
> function prototype below kernel-doc markup.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> ---
>   include/linux/firmware/intel/stratix10-svc-client.h | 10 +++++-----
>   1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/include/linux/firmware/intel/stratix10-svc-client.h b/include/linux/firmware/intel/stratix10-svc-client.h
> index a93d85932eb9..ebc295647581 100644
> --- a/include/linux/firmware/intel/stratix10-svc-client.h
> +++ b/include/linux/firmware/intel/stratix10-svc-client.h
> @@ -6,7 +6,7 @@
>   #ifndef __STRATIX10_SVC_CLIENT_H
>   #define __STRATIX10_SVC_CLIENT_H
>   
> -/**
> +/*
>    * Service layer driver supports client names
>    *
>    * fpga: for FPGA configuration
> @@ -15,7 +15,7 @@
>   #define SVC_CLIENT_FPGA			"fpga"
>   #define SVC_CLIENT_RSU			"rsu"
>   
> -/**
> +/*
>    * Status of the sent command, in bit number
>    *
>    * SVC_STATUS_OK:
> @@ -50,7 +50,7 @@
>   #define SVC_STATUS_ERROR		5
>   #define SVC_STATUS_NO_SUPPORT		6
>   
> -/**
> +/*
>    * Flag bit for COMMAND_RECONFIG
>    *
>    * COMMAND_RECONFIG_FLAG_PARTIAL:
> @@ -58,7 +58,7 @@
>    */
>   #define COMMAND_RECONFIG_FLAG_PARTIAL	1
>   
> -/**
> +/*
>    * Timeout settings for service clients:
>    * timeout value used in Stratix10 FPGA manager driver.
>    * timeout value used in RSU driver
> @@ -218,7 +218,7 @@ void stratix10_svc_free_memory(struct stratix10_svc_chan *chan, void *kaddr);
>   int stratix10_svc_send(struct stratix10_svc_chan *chan, void *msg);
>   
>   /**
> - * intel_svc_done() - complete service request
> + * stratix10_svc_done() - complete service request
>    * @chan: service channel assigned to the client
>    *
>    * This function is used by service client to inform service layer that
>