linux-kernel - Re: [PATCH] gpu/drm: fix a few kernel-doc "/**" mark warnings

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]

Date:   Tue, 16 Jul 2019 11:24:53 +0200
From:   Daniel Vetter <daniel@...ll.ch>
To:     Qian Cai <cai@....pw>
Cc:     emil.l.velikov@...il.com, maarten.lankhorst@...ux.intel.com,
        maxime.ripard@...tlin.com, sean@...rly.run, airlied@...ux.ie,
        daniel@...ll.ch, dri-devel@...ts.freedesktop.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] gpu/drm: fix a few kernel-doc "/**" mark warnings

On Mon, Jul 15, 2019 at 09:42:53AM -0400, Qian Cai wrote:
> The opening comment mark "/**" is reserved for kernel-doc comments, so
> it will generate warnings for comments that are not kernel-doc with
> "make W=1". For example,
> 
> drivers/gpu/drm/drm_memory.c:2: warning: Cannot understand  * \file
> drm_memory.c
> 
> Signed-off-by: Qian Cai <cai@....pw>

Applied to drm-misc-next for 5.4.
-Daniel

> ---
>  drivers/gpu/drm/drm_agpsupport.c  | 2 +-
>  drivers/gpu/drm/drm_dma.c         | 2 +-
>  drivers/gpu/drm/drm_legacy_misc.c | 2 +-
>  drivers/gpu/drm/drm_lock.c        | 2 +-
>  drivers/gpu/drm/drm_memory.c      | 2 +-
>  drivers/gpu/drm/drm_scatter.c     | 2 +-
>  drivers/gpu/drm/drm_vm.c          | 2 +-
>  7 files changed, 7 insertions(+), 7 deletions(-)
> 
> diff --git a/drivers/gpu/drm/drm_agpsupport.c b/drivers/gpu/drm/drm_agpsupport.c
> index 40fba1c04dfc..ef549c95b0b9 100644
> --- a/drivers/gpu/drm/drm_agpsupport.c
> +++ b/drivers/gpu/drm/drm_agpsupport.c
> @@ -1,4 +1,4 @@
> -/**
> +/*
>   * \file drm_agpsupport.c
>   * DRM support for AGP/GART backend
>   *
> diff --git a/drivers/gpu/drm/drm_dma.c b/drivers/gpu/drm/drm_dma.c
> index 3f83e2ca80ad..cbfaa2eaab00 100644
> --- a/drivers/gpu/drm/drm_dma.c
> +++ b/drivers/gpu/drm/drm_dma.c
> @@ -1,4 +1,4 @@
> -/**
> +/*
>   * \file drm_dma.c
>   * DMA IOCTL and function support
>   *
> diff --git a/drivers/gpu/drm/drm_legacy_misc.c b/drivers/gpu/drm/drm_legacy_misc.c
> index 2fe786839ca8..745eb9939414 100644
> --- a/drivers/gpu/drm/drm_legacy_misc.c
> +++ b/drivers/gpu/drm/drm_legacy_misc.c
> @@ -1,4 +1,4 @@
> -/**
> +/*
>   * \file drm_legacy_misc.c
>   * Misc legacy support functions.
>   *
> diff --git a/drivers/gpu/drm/drm_lock.c b/drivers/gpu/drm/drm_lock.c
> index b70058e77a28..2610bff3d539 100644
> --- a/drivers/gpu/drm/drm_lock.c
> +++ b/drivers/gpu/drm/drm_lock.c
> @@ -1,4 +1,4 @@
> -/**
> +/*
>   * \file drm_lock.c
>   * IOCTLs for locking
>   *
> diff --git a/drivers/gpu/drm/drm_memory.c b/drivers/gpu/drm/drm_memory.c
> index 132fef8ff1b6..d92f24c308a1 100644
> --- a/drivers/gpu/drm/drm_memory.c
> +++ b/drivers/gpu/drm/drm_memory.c
> @@ -1,4 +1,4 @@
> -/**
> +/*
>   * \file drm_memory.c
>   * Memory management wrappers for DRM
>   *
> diff --git a/drivers/gpu/drm/drm_scatter.c b/drivers/gpu/drm/drm_scatter.c
> index bb829a115fc6..b6d863699d0f 100644
> --- a/drivers/gpu/drm/drm_scatter.c
> +++ b/drivers/gpu/drm/drm_scatter.c
> @@ -1,4 +1,4 @@
> -/**
> +/*
>   * \file drm_scatter.c
>   * IOCTLs to manage scatter/gather memory
>   *
> diff --git a/drivers/gpu/drm/drm_vm.c b/drivers/gpu/drm/drm_vm.c
> index 10cf83d569e1..6c74c68f192a 100644
> --- a/drivers/gpu/drm/drm_vm.c
> +++ b/drivers/gpu/drm/drm_vm.c
> @@ -1,4 +1,4 @@
> -/**
> +/*
>   * \file drm_vm.c
>   * Memory mapping for DRM
>   *
> -- 
> 1.8.3.1
> 

-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch