linux-kernel - Re: [PATCH 02/37] drm/xlnx/zynqmp_disp: Use correct kerneldoc formatting in zynqmp

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: <20230320081700.GH9667@google.com>
Date:   Mon, 20 Mar 2023 08:17:00 +0000
From:   Lee Jones <lee@...nel.org>
To:     Laurent Pinchart <laurent.pinchart@...asonboard.com>
Cc:     dri-devel@...ts.freedesktop.org, linux-kernel@...r.kernel.org,
        Hyun Kwon <hyun.kwon@...inx.com>,
        David Airlie <airlied@...il.com>,
        Daniel Vetter <daniel@...ll.ch>,
        Michal Simek <michal.simek@...inx.com>,
        linux-arm-kernel@...ts.infradead.org
Subject: Re: [PATCH 02/37] drm/xlnx/zynqmp_disp: Use correct kerneldoc
 formatting in zynqmp_disp

On Sun, 19 Mar 2023, Laurent Pinchart wrote:

> Hi Lee,
>
> Thank you for the patch.
>
> On Fri, Mar 17, 2023 at 08:16:43AM +0000, Lee Jones wrote:
> > Fixes the following W=1 kernel build warning(s):
> >
> >  drivers/gpu/drm/xlnx/zynqmp_disp.c:151: warning: Function parameter or member 'blend' not described in 'zynqmp_disp'
> >  drivers/gpu/drm/xlnx/zynqmp_disp.c:151: warning: Function parameter or member 'avbuf' not described in 'zynqmp_disp'
> >  drivers/gpu/drm/xlnx/zynqmp_disp.c:151: warning: Function parameter or member 'audio' not described in 'zynqmp_disp'
> >
> > Cc: Hyun Kwon <hyun.kwon@...inx.com>
> > Cc: Laurent Pinchart <laurent.pinchart@...asonboard.com>
> > Cc: David Airlie <airlied@...il.com>
> > Cc: Daniel Vetter <daniel@...ll.ch>
> > Cc: Michal Simek <michal.simek@...inx.com>
> > Cc: dri-devel@...ts.freedesktop.org
> > Cc: linux-arm-kernel@...ts.infradead.org
> > Signed-off-by: Lee Jones <lee@...nel.org>
> > ---
> >  drivers/gpu/drm/xlnx/zynqmp_disp.c | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
> >
> > diff --git a/drivers/gpu/drm/xlnx/zynqmp_disp.c b/drivers/gpu/drm/xlnx/zynqmp_disp.c
> > index 3b87eebddc979..63358f4898625 100644
> > --- a/drivers/gpu/drm/xlnx/zynqmp_disp.c
> > +++ b/drivers/gpu/drm/xlnx/zynqmp_disp.c
> > @@ -128,9 +128,9 @@ struct zynqmp_disp_layer {
> >   * struct zynqmp_disp - Display controller
> >   * @dev: Device structure
> >   * @dpsub: Display subsystem
> > - * @blend.base: Register I/O base address for the blender
> > - * @avbuf.base: Register I/O base address for the audio/video buffer manager
> > - * @audio.base: Registers I/O base address for the audio mixer
> > + * @blend: .base: Register I/O base address for the blender
> > + * @avbuf: .base: Register I/O base address for the audio/video buffer manager
> > + * @audio: .base: Registers I/O base address for the audio mixer
>
> This is a hack, it won't work properly if the nested structures get
> extended with more fields.

The original doc is a hack, for it is not recognised kerneldoc format.  :)

> Is there a correct kerneldoc syntax for this code construct ?

Not that I'm aware of.

Unless it's been added since my last round of this stuff.

> >   * @layers: Layers (planes)
> >   */
> >  struct zynqmp_disp {
>
> --
> Regards,
>
> Laurent Pinchart

--
Lee Jones [李琼斯]