linux-kernel - Re: [PATCH] fpga: dfl: more kernel-doc corrections

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: <78d502cf-9e68-5477-5685-cf0cc53b9b86@infradead.org>
Date:   Sat, 14 Jan 2023 09:00:23 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Xu Yilun <yilun.xu@...el.com>, hao.wu@...el.com, trix@...hat.com,
        mdf@...nel.org, linux-fpga@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] fpga: dfl: more kernel-doc corrections



On 1/14/23 07:54, Xu Yilun wrote:
> Fix more kernel-doc warnings in drivers/fpga/:
> 
> $ ./scripts/kernel-doc -none drivers/fpga/*
> drivers/fpga/dfl-afu.h:61: warning: expecting prototype for struct fpga_afu_dma_region. Prototype was for struct dfl_afu_dma_region instead
> drivers/fpga/dfl-afu-region.c:52: warning: Function parameter or member 'pdata' not described in 'afu_mmio_region_add'
> drivers/fpga/dfl-fme-perf.c:161: warning: Function parameter or member 'node' not described in 'fme_perf_priv'
> drivers/fpga/dfl-fme-pr.h:70: warning: expecting prototype for struct dfl_fme_bridge_pdata. Prototype was for struct dfl_fme_br_pdata instead
> drivers/fpga/dfl.h:256: warning: Function parameter or member 'revision' not described in 'dfl_feature'
> 
> Signed-off-by: Xu Yilun <yilun.xu@...el.com>

Reviewed-by: Randy Dunlap <rdunlap@...radead.org>

Thanks.

> ---
>  drivers/fpga/dfl-afu-region.c | 1 +
>  drivers/fpga/dfl-afu.h        | 2 +-
>  drivers/fpga/dfl-fme-perf.c   | 2 +-
>  drivers/fpga/dfl-fme-pr.h     | 2 +-
>  drivers/fpga/dfl.h            | 1 +
>  5 files changed, 5 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/fpga/dfl-afu-region.c b/drivers/fpga/dfl-afu-region.c
> index 0804b7a0c298..2e7b41629406 100644
> --- a/drivers/fpga/dfl-afu-region.c
> +++ b/drivers/fpga/dfl-afu-region.c
> @@ -39,6 +39,7 @@ static struct dfl_afu_mmio_region *get_region_by_index(struct dfl_afu *afu,
>  /**
>   * afu_mmio_region_add - add a mmio region to given feature dev.
>   *
> + * @pdata: afu platform device's pdata.
>   * @region_index: region index.
>   * @region_size: region size.
>   * @phys: region's physical address of this region.
> diff --git a/drivers/fpga/dfl-afu.h b/drivers/fpga/dfl-afu.h
> index e5020e2b1f3d..674e9772f0ea 100644
> --- a/drivers/fpga/dfl-afu.h
> +++ b/drivers/fpga/dfl-afu.h
> @@ -41,7 +41,7 @@ struct dfl_afu_mmio_region {
>  };
>  
>  /**
> - * struct fpga_afu_dma_region - afu DMA region data structure
> + * struct dfl_afu_dma_region - afu DMA region data structure
>   *
>   * @user_addr: region userspace virtual address.
>   * @length: region length.
> diff --git a/drivers/fpga/dfl-fme-perf.c b/drivers/fpga/dfl-fme-perf.c
> index 587c82be12f7..7422d2bc6f37 100644
> --- a/drivers/fpga/dfl-fme-perf.c
> +++ b/drivers/fpga/dfl-fme-perf.c
> @@ -141,7 +141,7 @@
>   * @fab_port_id: used to indicate current working mode of fabric counters.
>   * @fab_lock: lock to protect fabric counters working mode.
>   * @cpu: active CPU to which the PMU is bound for accesses.
> - * @cpuhp_node: node for CPU hotplug notifier link.
> + * @node: node for CPU hotplug notifier link.
>   * @cpuhp_state: state for CPU hotplug notification;
>   */
>  struct fme_perf_priv {
> diff --git a/drivers/fpga/dfl-fme-pr.h b/drivers/fpga/dfl-fme-pr.h
> index 096a699089d3..761f80f63312 100644
> --- a/drivers/fpga/dfl-fme-pr.h
> +++ b/drivers/fpga/dfl-fme-pr.h
> @@ -58,7 +58,7 @@ struct dfl_fme_bridge {
>  };
>  
>  /**
> - * struct dfl_fme_bridge_pdata - platform data for FME bridge platform device.
> + * struct dfl_fme_br_pdata - platform data for FME bridge platform device.
>   *
>   * @cdev: container device.
>   * @port_id: port id.
> diff --git a/drivers/fpga/dfl.h b/drivers/fpga/dfl.h
> index 06cfcd5e84bb..5fc424d505c8 100644
> --- a/drivers/fpga/dfl.h
> +++ b/drivers/fpga/dfl.h
> @@ -231,6 +231,7 @@ struct dfl_feature_irq_ctx {
>   *
>   * @dev: ptr to pdev of the feature device which has the sub feature.
>   * @id: sub feature id.
> + * @revision: revision value of this sub feature.
>   * @resource_index: each sub feature has one mmio resource for its registers.
>   *		    this index is used to find its mmio resource from the
>   *		    feature dev (platform device)'s resources.

-- 
~Randy