Subject: [PATCH 0/3] Fix kernel-doc warnings dfl files

Fixed the kernel-doc warnings in drivers/fpga/dfl.c, drivers/fpga/dfl.h
and include/linux/dfl.h. Each file commit has a list of warnings fixed.

Basheer Ahmed Muddebihal (3):
fpga: dfl: Fix kernel-doc warning in dfl.h for revision
fpga: dfl: Fix kernel-doc warnings in include/linux/dfl.h
fpga: dfl: Fix kernel-doc warnings in drivers/fpga/dfl.c

drivers/fpga/dfl.c | 5 +++--
drivers/fpga/dfl.h | 1 +
include/linux/dfl.h | 4 ++++
3 files changed, 8 insertions(+), 2 deletions(-)

--
2.34.1



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

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 <[email protected]>
---
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.
+ * @PORT_ID: dfl id for Port.
+ * @DFL_ID_MAX: maximum number for dfl ids.
*/
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.
* @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


2022-05-28 19:42:56

by Xu Yilun

[permalink] [raw]
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 <[email protected]>
> ---
> 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