linux-kernel - Re: [PATCH] media: davinci: fix two kernel-doc comments

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: <76df28ed-9243-8fb5-be67-aa9130b5a174@infradead.org>
Date:   Thu, 20 May 2021 10:10:16 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     linuxarm@...wei.com, mauro.chehab@...wei.com,
        "Lad, Prabhakar" <prabhakar.csengg@...il.com>,
        Mauro Carvalho Chehab <mchehab@...nel.org>,
        linux-kernel@...r.kernel.org, linux-media@...r.kernel.org
Subject: Re: [PATCH] media: davinci: fix two kernel-doc comments

On 5/20/21 7:07 AM, Mauro Carvalho Chehab wrote:
> A typo there is causing two warnings:
> 	drivers/media/platform/davinci/vpif_display.c:114: warning: Function parameter or member 'nplanes' not described in 'vpif_buffer_queue_setup'
> 	drivers/media/platform/davinci/vpif_capture.c:112: warning: Function parameter or member 'nplanes' not described in 'vpif_buffer_queue_setup'
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> ---
>  drivers/media/platform/davinci/vpif_capture.c | 2 +-
>  drivers/media/platform/davinci/vpif_display.c | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/media/platform/davinci/vpif_capture.c b/drivers/media/platform/davinci/vpif_capture.c
> index 8d2e165bf7de..c034e25dd9aa 100644
> --- a/drivers/media/platform/davinci/vpif_capture.c
> +++ b/drivers/media/platform/davinci/vpif_capture.c
> @@ -99,7 +99,7 @@ static int vpif_buffer_prepare(struct vb2_buffer *vb)
>   * vpif_buffer_queue_setup : Callback function for buffer setup.

    * vpif_buffer_queue_setup - Callback ...

>   * @vq: vb2_queue ptr
>   * @nbuffers: ptr to number of buffers requested by application
> - * @nplanes:: contains number of distinct video planes needed to hold a frame
> + * @nplanes: contains number of distinct video planes needed to hold a frame
>   * @sizes: contains the size (in bytes) of each plane.
>   * @alloc_devs: ptr to allocation context
>   *
> diff --git a/drivers/media/platform/davinci/vpif_display.c b/drivers/media/platform/davinci/vpif_display.c
> index e5f61d9b221d..59f6b782e104 100644
> --- a/drivers/media/platform/davinci/vpif_display.c
> +++ b/drivers/media/platform/davinci/vpif_display.c
> @@ -101,7 +101,7 @@ static int vpif_buffer_prepare(struct vb2_buffer *vb)
>   * vpif_buffer_queue_setup : Callback function for buffer setup.

same (s/ : / - /)

>   * @vq: vb2_queue ptr
>   * @nbuffers: ptr to number of buffers requested by application
> - * @nplanes:: contains number of distinct video planes needed to hold a frame
> + * @nplanes: contains number of distinct video planes needed to hold a frame
>   * @sizes: contains the size (in bytes) of each plane.
>   * @alloc_devs: ptr to allocation context
>   *
> 

Thanks.
-- 
~Randy