linux-kernel - Re: [PATCH 06/10] drm: amd: amdgpu_dm.h: fix a wrong kernel-doc markup

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: <aa22e626-e461-48a1-e905-9c1e7cf204de@amd.com>
Date:   Thu, 14 Jan 2021 14:50:24 +0100
From:   Christian König <christian.koenig@....com>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Daniel Vetter <daniel@...ll.ch>,
        David Airlie <airlied@...ux.ie>
Cc:     Jonathan Corbet <corbet@....net>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Alex Deucher <alexander.deucher@....com>,
        Aurabindo Pillai <aurabindo.pillai@....com>,
        Bas Nieuwenhuizen <bas@...nieuwenhuizen.nl>,
        Bhawanpreet Lakha <Bhawanpreet.Lakha@....com>,
        Eryk Brol <eryk.brol@....com>,
        Harry Wentland <harry.wentland@....com>,
        Leo Li <sunpeng.li@....com>,
        Mikita Lipski <mikita.lipski@....com>,
        Nicholas Kazlauskas <nicholas.kazlauskas@....com>,
        Rodrigo Siqueira <Rodrigo.Siqueira@....com>,
        Wayne Lin <Wayne.Lin@....com>, amd-gfx@...ts.freedesktop.org,
        dri-devel@...ts.freedesktop.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 06/10] drm: amd: amdgpu_dm.h: fix a wrong kernel-doc
 markup

Am 14.01.21 um 08:53 schrieb Mauro Carvalho Chehab:
> There's a missing colon, causing the markup to be ignored,
> solving those warnings:
>
> 	../drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:340: warning: Incorrect use of kernel-doc format:          * @active_vblank_irq_count
> 	../drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:379: warning: Function parameter or member 'active_vblank_irq_count' not described in 'amdgpu_display_manager'
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

Reviewed-by: Christian König <christian.koenig@....com>

> ---
>   drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> index f084e2fc9569..5ee1b766884e 100644
> --- a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> +++ b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> @@ -337,7 +337,7 @@ struct amdgpu_display_manager {
>   	const struct gpu_info_soc_bounding_box_v1_0 *soc_bounding_box;
>   
>   	/**
> -	 * @active_vblank_irq_count
> +	 * @active_vblank_irq_count:
>   	 *
>   	 * number of currently active vblank irqs
>   	 */