linux-kernel - Re: [PATCH 2/3] fpga: dfl: Fix kernel-doc warnings in include/linux/dfl.h

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: <20220528104918.GB178479@yilunxu-OptiPlex-7050>
Date:   Sat, 28 May 2022 18:49:18 +0800
From:   Xu Yilun <yilun.xu@...el.com>
To:     Basheer Ahmed Muddebihal 
        <basheer.ahmed.muddebihal@...ux.intel.com>
Cc:     hao.wu@...el.com, trix@...hat.com, mdf@...nel.org,
        linux-fpga@...r.kernel.org, linux-kernel@...r.kernel.org,
        matthew.gerlach@...ux.intel.com, marpagan@...hat.com,
        tianfei.zhang@...el.com
Subject: Re: [PATCH 2/3] fpga: dfl: Fix kernel-doc warnings in
 include/linux/dfl.h

On Thu, May 19, 2022 at 03:12:48PM -0700, Basheer Ahmed Muddebihal wrote:
> Fixed the following warnings:
> include/linux/dfl.h:21: warning: Enum value 'FME_ID' not described in enum 'dfl_id_type'
> include/linux/dfl.h:21: warning: Enum value 'PORT_ID' not described in enum 'dfl_id_type'
> include/linux/dfl.h:21: warning: Enum value 'DFL_ID_MAX' not described in enum 'dfl_id_type'
> include/linux/dfl.h:47: warning: Function parameter or member 'revision' not described in 'dfl_device'
> 
> Signed-off-by: Basheer Ahmed Muddebihal <basheer.ahmed.muddebihal@...ux.intel.com>
> ---
>  include/linux/dfl.h | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/include/linux/dfl.h b/include/linux/dfl.h
> index 431636a0dc78..4caa2d99d8dc 100644
> --- a/include/linux/dfl.h
> +++ b/include/linux/dfl.h
> @@ -13,6 +13,9 @@
>  
>  /**
>   * enum dfl_id_type - define the DFL FIU types
> + * @FME_ID: dfl id for FPGA Management Engine node.

DFL FIU type for FPGA Management Engine. Is it better?

> + * @PORT_ID: dfl id for Port.

DFL FIU type for Port.

> + * @DFL_ID_MAX: maximum number for dfl ids.

number of valid DFL FIU types.

>   */
>  enum dfl_id_type {
>  	FME_ID = 0,
> @@ -27,6 +30,7 @@ enum dfl_id_type {
>   * @id: id of the dfl device.
>   * @type: type of DFL FIU of the device. See enum dfl_id_type.
>   * @feature_id: feature identifier local to its DFL FIU type.
> + * @revision: feature revision local to its DFL FIU type.

Local to its DFL FIU type? Every feature manages it's own revesion, is
it?

Thanks,
Yilun

>   * @mmio_res: mmio resource of this dfl device.
>   * @irqs: list of Linux IRQ numbers of this dfl device.
>   * @num_irqs: number of IRQs supported by this dfl device.
> -- 
> 2.34.1