From: Lee Jones <lee@kernel.org>
To: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Cc: Hyun Kwon <hyun.kwon@xilinx.com>,
linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org,
Michal Simek <michal.simek@xilinx.com>,
linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH 02/37] drm/xlnx/zynqmp_disp: Use correct kerneldoc formatting in zynqmp_disp
Date: Mon, 20 Mar 2023 08:17:00 +0000 [thread overview]
Message-ID: <20230320081700.GH9667@google.com> (raw)
In-Reply-To: <20230319142432.GM10144@pendragon.ideasonboard.com>
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@xilinx.com>
> > Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> > Cc: David Airlie <airlied@gmail.com>
> > Cc: Daniel Vetter <daniel@ffwll.ch>
> > Cc: Michal Simek <michal.simek@xilinx.com>
> > Cc: dri-devel@lists.freedesktop.org
> > Cc: linux-arm-kernel@lists.infradead.org
> > Signed-off-by: Lee Jones <lee@kernel.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 [李琼斯]
next prev parent reply other threads:[~2023-03-20 8:17 UTC|newest]
Thread overview: 80+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-17 8:16 [PATCH 00/37] Rid W=1 warnings from GPU Lee Jones
2023-03-17 8:16 ` [PATCH 01/37] drm/amd/display/dc/dc_hdmi_types: Move string definition to the only file it's used in Lee Jones
2023-03-17 20:15 ` Alex Deucher
2023-03-17 8:16 ` [PATCH 02/37] drm/xlnx/zynqmp_disp: Use correct kerneldoc formatting in zynqmp_disp Lee Jones
2023-03-19 14:24 ` Laurent Pinchart
2023-03-20 8:17 ` Lee Jones [this message]
2023-03-20 23:15 ` Laurent Pinchart
2023-08-01 22:36 ` Laurent Pinchart
2023-08-02 14:45 ` Jonathan Corbet
2023-03-17 8:16 ` [PATCH 03/37] drm/amd/amdgpu/amdgpu_device: Provide missing kerneldoc entry for 'reset_context' Lee Jones
2023-03-17 20:16 ` Alex Deucher
2023-03-17 8:16 ` [PATCH 04/37] drm/xlnx/zynqmp_dp: Fix function name zynqmp_dp_link_train() -> zynqmp_dp_train() Lee Jones
2023-03-19 14:10 ` Laurent Pinchart
2023-03-17 8:16 ` [PATCH 05/37] drm/ttm/ttm_bo: Provide a missing 'bulk' description and correct misnaming of 'placement' Lee Jones
2023-03-17 8:40 ` Christian König
2023-03-17 8:16 ` [PATCH 06/37] drm/vkms/vkms_composer: Fix a few different kerneldoc formatting Lee Jones
2023-03-20 23:46 ` Melissa Wen
2023-03-21 0:09 ` Randy Dunlap
2023-03-21 9:49 ` Melissa Wen
2023-03-21 14:51 ` Randy Dunlap
2023-03-17 8:16 ` [PATCH 07/37] drm/mediatek/mtk_disp_aal: Remove half completed incorrect struct header Lee Jones
2023-03-17 9:22 ` AngeloGioacchino Del Regno
2023-03-20 8:22 ` Lee Jones
2023-03-17 8:16 ` [PATCH 08/37] drm/mediatek/mtk_disp_ccorr: " Lee Jones
2023-03-17 8:16 ` [PATCH 09/37] drm/tegra/dc: Remove set but unused variable 'state' Lee Jones
2023-04-04 12:14 ` (subset) " Thierry Reding
2023-03-17 8:16 ` [PATCH 10/37] drm/nouveau/nvkm/nvfw/acr: Make local function ‘wpr_generic_header_dump’ static Lee Jones
2023-03-17 8:16 ` [PATCH 11/37] drm/nouveau/nvkm/subdev/acr/lsfw: Remove unused variable 'loc' Lee Jones
2023-03-17 8:16 ` [PATCH 12/37] drm/nouveau/nvkm/subdev/bios/init: Demote a bunch of kernel-doc abuses Lee Jones
2023-03-17 8:16 ` [PATCH 13/37] drm/amd/amdgpu/amdgpu_ucode: Remove unused function ‘amdgpu_ucode_print_imu_hdr’ Lee Jones
2023-03-17 20:18 ` Alex Deucher
2023-03-17 8:16 ` [PATCH 14/37] drm/amd/amdgpu/amdgpu_vm_pt: Supply description for amdgpu_vm_pt_free_dfs()'s unlocked param Lee Jones
2023-03-17 20:21 ` Alex Deucher
2023-03-17 8:16 ` [PATCH 15/37] drm/amd/amdgpu/gmc_v11_0: Provide a few missing param descriptions relating to hubs and flushes Lee Jones
2023-03-17 20:22 ` Alex Deucher
2023-03-17 8:16 ` [PATCH 16/37] drm/amd/amdgpu/ih_v6_0: Repair misspelling and provide descriptions for 'ih' Lee Jones
2023-03-17 20:23 ` Alex Deucher
2023-03-17 8:16 ` [PATCH 17/37] drm/amd/amdgpu/amdgpu_mes: Ensure amdgpu_bo_create_kernel()'s return value is checked Lee Jones
2023-03-17 20:25 ` Alex Deucher
2023-03-17 8:16 ` [PATCH 18/37] drm/amd/amdgpu/amdgpu_vce: Provide description for amdgpu_vce_validate_bo()'s 'p' param Lee Jones
2023-03-17 20:27 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 19/37] drm/amd/pm/swsmu/smu11/vangogh_ppt: Provide a couple of missing parameter descriptions Lee Jones
2023-03-17 20:28 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 20/37] drm/amd/display/amdgpu_dm/amdgpu_dm_helpers: Move defines out to where they are actually used Lee Jones
2023-03-17 20:30 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 21/37] drm/nouveau/nvkm/subdev/volt/gk20a: Demote kerneldoc abuses Lee Jones
2023-03-17 8:17 ` [PATCH 22/37] drm/nouveau/nvkm/engine/fifo/runl: Staticify local function nvkm_engn_cgrp_get() Lee Jones
2023-03-17 8:17 ` [PATCH 23/37] drm/nouveau/nvkm/engine/fifo/gf100: Staticify local function gf100_fifo_nonstall_block() Lee Jones
2023-03-17 8:17 ` [PATCH 24/37] drm/nouveau/nvkm/engine/gr/gf100: Demote kerneldoc abuse Lee Jones
2023-03-17 8:17 ` [PATCH 25/37] drm/nouveau/nvkm/engine/gr/tu102: Staticify local function gf100_fifo_nonstall_block() Lee Jones
2023-03-17 8:17 ` [PATCH 26/37] drm/amd/display/amdgpu_dm/amdgpu_dm_helpers: Move SYNAPTICS_DEVICE_ID into CONFIG_DRM_AMD_DC_DCN ifdef Lee Jones
2023-03-17 20:32 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 27/37] drm/amd/display/dc/dce/dmub_psr: Demote kerneldoc abuse Lee Jones
2023-03-17 20:33 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 28/37] drm/amd/display/dc/core/dc_stat: Convert a couple of doc headers to kerneldoc format Lee Jones
2023-03-17 20:36 ` Alex Deucher
2023-03-20 8:19 ` Lee Jones
2023-03-20 13:11 ` Harry Wentland
2023-03-20 13:25 ` Lee Jones
2023-03-20 14:04 ` Hamza Mahfooz
2023-03-17 8:17 ` [PATCH 29/37] drm/amd/display/dc/link/link_detection: Remove unused variable 'status' Lee Jones
2023-03-17 20:38 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 30/37] drm/amd/display/dc/link/protocols/link_dp_training: Remove set but unused variable 'result' Lee Jones
2023-03-17 20:39 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 31/37] drm/nouveau/dispnv04/crtc: Demote kerneldoc abuses Lee Jones
2023-03-17 14:12 ` Karol Herbst
2023-03-17 8:17 ` [PATCH 32/37] drm/amd/display/dc/link/protocols/link_dp_capability: Remove unused variable and mark another as __maybe_unused Lee Jones
2023-03-17 20:41 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 33/37] drm/amd/display/dc/link/protocols/link_dp_capability: Demote non-compliant kerneldoc Lee Jones
2023-03-17 20:42 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 34/37] drm/nouveau/nvkm/engine/gr/tu102: Completely remove unused function ‘tu102_gr_load’ Lee Jones
2023-03-17 14:13 ` Karol Herbst
2023-03-17 8:17 ` [PATCH 35/37] drm/amd/display/dc/dce60/Makefile: Fix previous attempt to silence known override-init warnings Lee Jones
2023-03-17 20:43 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 36/37] drm/amd/display/dc/link/link_detection: Demote a couple of kerneldoc abuses Lee Jones
2023-03-17 20:44 ` Alex Deucher
2023-03-20 8:23 ` Lee Jones
2023-03-17 8:17 ` [PATCH 37/37] drm/bridge/imx/Kconfig: Prevent imx-ldb-helper from appearing in 2 separate modules Lee Jones
2023-03-17 9:42 ` Liu Ying
2023-03-20 8:21 ` Lee Jones
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230320081700.GH9667@google.com \
--to=lee@kernel.org \
--cc=dri-devel@lists.freedesktop.org \
--cc=hyun.kwon@xilinx.com \
--cc=laurent.pinchart@ideasonboard.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=michal.simek@xilinx.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).