linux-kernel - Re: [PATCH v2] drm/nouveau: exec: fix ioctl kernel-doc warning

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: <a53adb9e7c598119a490dca20305644d6d7f312a.camel@redhat.com>
Date:   Mon, 09 Oct 2023 17:37:09 -0400
From:   Lyude Paul <lyude@...hat.com>
To:     Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org
Cc:     Dave Airlie <airlied@...hat.com>,
        Danilo Krummrich <dakr@...hat.com>,
        Karol Herbst <kherbst@...hat.com>,
        dri-devel@...ts.freedesktop.org, nouveau@...ts.freedesktop.org,
        Bragatheswaran Manickavel <bragathemanick0908@...il.com>
Subject: Re: [PATCH v2] drm/nouveau: exec: fix ioctl kernel-doc warning

Reviewed-by: Lyude Paul <lyude@...hat.com>

On Sun, 2023-10-08 at 07:02 -0700, Randy Dunlap wrote:
> kernel-doc emits a warning:
> 
> include/uapi/drm/nouveau_drm.h:49: warning: Cannot understand  * @NOUVEAU_GETPARAM_EXEC_PUSH_MAX
>  on line 49 - I thought it was a doc line
> 
> We don't have a way to document a macro value via kernel-doc, so
> change the "/**" kernel-doc marker to a C comment and format the comment
> more like a kernel-doc comment for consistency.
> 
> Fixes: d59e75eef52d ("drm/nouveau: exec: report max pushs through getparam")
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Dave Airlie <airlied@...hat.com>
> Cc: Danilo Krummrich <dakr@...hat.com>
> Cc: Karol Herbst <kherbst@...hat.com>
> Cc: Lyude Paul <lyude@...hat.com>
> Cc: dri-devel@...ts.freedesktop.org
> Cc: nouveau@...ts.freedesktop.org
> Cc: Bragatheswaran Manickavel <bragathemanick0908@...il.com>
> ---
> v2: update commit text; somehow I sent a version of the patch before
>     adding the full text.
> v1: https://lore.kernel.org/lkml/20231007005518.32015-1-rdunlap@infradead.org/
> 
>  include/uapi/drm/nouveau_drm.h |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff -- a/include/uapi/drm/nouveau_drm.h b/include/uapi/drm/nouveau_drm.h
> --- a/include/uapi/drm/nouveau_drm.h
> +++ b/include/uapi/drm/nouveau_drm.h
> @@ -45,8 +45,8 @@ extern "C" {
>  #define NOUVEAU_GETPARAM_HAS_BO_USAGE    15
>  #define NOUVEAU_GETPARAM_HAS_PAGEFLIP    16
>  
> -/**
> - * @NOUVEAU_GETPARAM_EXEC_PUSH_MAX
> +/*
> + * NOUVEAU_GETPARAM_EXEC_PUSH_MAX - query max pushes through getparam
>   *
>   * Query the maximum amount of IBs that can be pushed through a single
>   * &drm_nouveau_exec structure and hence a single &DRM_IOCTL_NOUVEAU_EXEC
> 

-- 
Cheers,
 Lyude Paul (she/her)
 Software Engineer at Red Hat