From: Lee Jones <lee.jones@linaro.org>
To: "Christian König" <christian.koenig@amd.com>
Cc: linux-kernel@vger.kernel.org, Huang Rui <ray.huang@amd.com>,
David Airlie <airlied@linux.ie>, Daniel Vetter <daniel@ffwll.ch>,
dri-devel@lists.freedesktop.org
Subject: Re: [PATCH 32/42] drm/ttm/ttm_tt: Demote kernel-doc header format abuses
Date: Tue, 17 Nov 2020 08:33:46 +0000 [thread overview]
Message-ID: <20201117083346.GB1869941@dell> (raw)
In-Reply-To: <bcb40255-312f-8cdb-28a8-7ee2e6596f90@amd.com>
On Mon, 16 Nov 2020, Christian König wrote:
> Am 16.11.20 um 18:41 schrieb Lee Jones:
> > Fixes the following W=1 kernel build warning(s):
> >
> > drivers/gpu/drm/ttm/ttm_tt.c:45: warning: Function parameter or member 'bo' not described in 'ttm_tt_create'
> > drivers/gpu/drm/ttm/ttm_tt.c:45: warning: Function parameter or member 'zero_alloc' not described in 'ttm_tt_create'
> > drivers/gpu/drm/ttm/ttm_tt.c:83: warning: Function parameter or member 'ttm' not described in 'ttm_tt_alloc_page_directory'
>
> Couldn't we rather describe the missing parameters? Shouldn't be much work.
My rule is; if a substantial attempt has been made to document
something, I'll patch it up. If little or no attempt has been made,
then it gets demoted.
Please feel free to document and upgrade them once more.
Bear in mind however, there is a script that reports on all files
which utilise kernel-doc notation but do not have matching references
from the Documentation area.
See: scripts/find-unused-docs.sh
> > Cc: Christian Koenig <christian.koenig@amd.com>
> > Cc: Huang Rui <ray.huang@amd.com>
> > Cc: David Airlie <airlied@linux.ie>
> > Cc: Daniel Vetter <daniel@ffwll.ch>
> > Cc: dri-devel@lists.freedesktop.org
> > Signed-off-by: Lee Jones <lee.jones@linaro.org>
> > ---
> > drivers/gpu/drm/ttm/ttm_tt.c | 4 ++--
> > 1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/drivers/gpu/drm/ttm/ttm_tt.c b/drivers/gpu/drm/ttm/ttm_tt.c
> > index cfd633c7e7643..da9eeffe0c6d7 100644
> > --- a/drivers/gpu/drm/ttm/ttm_tt.c
> > +++ b/drivers/gpu/drm/ttm/ttm_tt.c
> > @@ -38,7 +38,7 @@
> > #include <drm/drm_cache.h>
> > #include <drm/ttm/ttm_bo_driver.h>
> > -/**
> > +/*
> > * Allocates a ttm structure for the given BO.
> > */
> > int ttm_tt_create(struct ttm_buffer_object *bo, bool zero_alloc)
> > @@ -73,7 +73,7 @@ int ttm_tt_create(struct ttm_buffer_object *bo, bool zero_alloc)
> > return 0;
> > }
> > -/**
> > +/*
> > * Allocates storage for pointers to the pages that back the ttm.
> > */
> > static int ttm_tt_alloc_page_directory(struct ttm_tt *ttm)
>
--
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
WARNING: multiple messages have this Message-ID (diff)
From: Lee Jones <lee.jones@linaro.org>
To: "Christian König" <christian.koenig@amd.com>
Cc: David Airlie <airlied@linux.ie>,
dri-devel@lists.freedesktop.org, Huang Rui <ray.huang@amd.com>,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH 32/42] drm/ttm/ttm_tt: Demote kernel-doc header format abuses
Date: Tue, 17 Nov 2020 08:33:46 +0000 [thread overview]
Message-ID: <20201117083346.GB1869941@dell> (raw)
In-Reply-To: <bcb40255-312f-8cdb-28a8-7ee2e6596f90@amd.com>
On Mon, 16 Nov 2020, Christian König wrote:
> Am 16.11.20 um 18:41 schrieb Lee Jones:
> > Fixes the following W=1 kernel build warning(s):
> >
> > drivers/gpu/drm/ttm/ttm_tt.c:45: warning: Function parameter or member 'bo' not described in 'ttm_tt_create'
> > drivers/gpu/drm/ttm/ttm_tt.c:45: warning: Function parameter or member 'zero_alloc' not described in 'ttm_tt_create'
> > drivers/gpu/drm/ttm/ttm_tt.c:83: warning: Function parameter or member 'ttm' not described in 'ttm_tt_alloc_page_directory'
>
> Couldn't we rather describe the missing parameters? Shouldn't be much work.
My rule is; if a substantial attempt has been made to document
something, I'll patch it up. If little or no attempt has been made,
then it gets demoted.
Please feel free to document and upgrade them once more.
Bear in mind however, there is a script that reports on all files
which utilise kernel-doc notation but do not have matching references
from the Documentation area.
See: scripts/find-unused-docs.sh
> > Cc: Christian Koenig <christian.koenig@amd.com>
> > Cc: Huang Rui <ray.huang@amd.com>
> > Cc: David Airlie <airlied@linux.ie>
> > Cc: Daniel Vetter <daniel@ffwll.ch>
> > Cc: dri-devel@lists.freedesktop.org
> > Signed-off-by: Lee Jones <lee.jones@linaro.org>
> > ---
> > drivers/gpu/drm/ttm/ttm_tt.c | 4 ++--
> > 1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/drivers/gpu/drm/ttm/ttm_tt.c b/drivers/gpu/drm/ttm/ttm_tt.c
> > index cfd633c7e7643..da9eeffe0c6d7 100644
> > --- a/drivers/gpu/drm/ttm/ttm_tt.c
> > +++ b/drivers/gpu/drm/ttm/ttm_tt.c
> > @@ -38,7 +38,7 @@
> > #include <drm/drm_cache.h>
> > #include <drm/ttm/ttm_bo_driver.h>
> > -/**
> > +/*
> > * Allocates a ttm structure for the given BO.
> > */
> > int ttm_tt_create(struct ttm_buffer_object *bo, bool zero_alloc)
> > @@ -73,7 +73,7 @@ int ttm_tt_create(struct ttm_buffer_object *bo, bool zero_alloc)
> > return 0;
> > }
> > -/**
> > +/*
> > * Allocates storage for pointers to the pages that back the ttm.
> > */
> > static int ttm_tt_alloc_page_directory(struct ttm_tt *ttm)
>
--
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
next prev parent reply other threads:[~2020-11-17 8:34 UTC|newest]
Thread overview: 157+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-16 17:40 [PATCH v2 00/42] Rid W=1 warnings from GPU (non-Radeon) Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 01/42] drm/amd/amdgpu/atombios_encoders: Remove set but unused variable 'backlight_level' Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 20:51 ` Alex Deucher
2020-11-16 20:51 ` Alex Deucher
2020-11-16 20:51 ` Alex Deucher
2020-11-16 17:40 ` [PATCH 02/42] drm/armada/armada_overlay: Staticify local function 'armada_overlay_duplicate_state' Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 03/42] drm/drm_dp_mst_topology: Remove set but never used variable 'len' Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-17 17:29 ` Daniel Vetter
2020-11-17 17:29 ` Daniel Vetter
2020-11-17 18:12 ` Lee Jones
2020-11-17 18:12 ` Lee Jones
2020-11-17 18:13 ` Lee Jones
2020-11-17 18:13 ` Lee Jones
2020-11-17 19:13 ` Daniel Vetter
2020-11-17 19:13 ` Daniel Vetter
2020-11-16 17:40 ` [PATCH 04/42] drm/exynos/exynos7_drm_decon: Supply missing description for param 'ctx' Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 05/42] drm/exynos/exynos_drm_fimd: Add " Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 06/42] drm/exynos/exynos_drm_gsc: Supply missing description for 'num_limits' Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 07/42] drm/mediatek/mtk_dpi: Remove unused struct definition 'mtk_dpi_encoder_funcs' Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 08/42] drm/mediatek/mtk_disp_color: Fix formatting and provide missing member description Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 09/42] drm/mediatek/mtk_disp_ovl: " Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 10/42] drm/mediatek/mtk_disp_rdma: Fix formatting and supply missing struct " Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 11/42] drm/mediatek/mtk_drm_crtc: Demote seriously out-of-date struct header Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 12/42] drm/mediatek/mtk_drm_drv: Staticise local function invoked by reference Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 13/42] drm/meson/meson_venc: Make local function 'meson_venc_hdmi_get_dmt_vmode' static Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 14/42] drm/meson/meson_vclk: Make two local functions static Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 15/42] drm/msm/adreno/a6xx_gpu: Staticise local function 'a6xx_idle' Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 16/42] drm/msm/disp/mdp5/mdp5_crtc: Make local function 'mdp5_crtc_setup_pipeline()' static Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 17/42] drm/msm/disp/mdp5/mdp5_ctl: Demote non-conformant kernel-doc headers Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-17 19:12 ` [Freedreno] " Rob Clark
2020-11-17 19:12 ` Rob Clark
2020-11-16 17:40 ` [PATCH 18/42] drm/msm/disp/mdp5/mdp5_kms: Make local functions 'mdp5_{en,dis}able()' static Lee Jones
2020-11-16 17:40 ` [PATCH 18/42] drm/msm/disp/mdp5/mdp5_kms: Make local functions 'mdp5_{en, dis}able()' static Lee Jones
2020-11-16 17:40 ` [PATCH 19/42] drm/msm/disp/dpu1/dpu_core_perf: Remove set but unused variable 'dpu_cstate' Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 20/42] drm/msm/disp/dpu1/dpu_encoder: Remove a bunch of unused variables Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 21/42] drm/nouveau/nvkm/core/firmware: Fix formatting, provide missing param description Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-17 19:02 ` Daniel Vetter
2020-11-17 19:02 ` Daniel Vetter
2020-11-17 19:02 ` Daniel Vetter
2020-11-16 17:40 ` [PATCH 22/42] drm/pl111/pl111_display: Make local function static Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 23/42] drm/pl111/pl111_debugfs: Make local function 'pl111_debugfs_regs()' static Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 24/42] drm/rockchip/dw-mipi-dsi-rockchip: Demote non-conformant kernel-doc headers Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 25/42] drm/rockchip/rockchip_rgb: Consume our own header Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 26/42] drm/rockchip/rockchip_lvds: Fix struct document formatting Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 27/42] drm/selftests/test-drm_mm: Mark 'hole_end' as always_unused Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 28/42] drm/selftests/test-drm_framebuffer: Remove set but unused variable 'fb' Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 17:40 ` [PATCH 29/42] drm/selftests/test-drm_dp_mst_helper: Place 'struct drm_dp_sideband_msg_req_body' onto the heap Lee Jones
2020-11-16 17:40 ` Lee Jones
2020-11-16 20:53 ` Lyude Paul
2020-11-16 20:53 ` Lyude Paul
2020-11-17 8:29 ` Lee Jones
2020-11-17 8:29 ` Lee Jones
2020-11-16 17:41 ` [PATCH 30/42] drm/selftests/test-drm_dp_mst_helper: Move 'sideband_msg_req_encode_decode' " Lee Jones
2020-11-16 17:41 ` Lee Jones
2020-11-16 17:41 ` [PATCH 31/42] drm/ttm/ttm_bo: Fix one function header - demote lots of kernel-doc abuses Lee Jones
2020-11-16 17:41 ` Lee Jones
2020-11-16 20:33 ` Christian König
2020-11-16 20:33 ` Christian König
2020-11-17 19:11 ` Daniel Vetter
2020-11-17 19:11 ` Daniel Vetter
2020-11-16 17:41 ` [PATCH 32/42] drm/ttm/ttm_tt: Demote kernel-doc header format abuses Lee Jones
2020-11-16 17:41 ` Lee Jones
2020-11-16 20:32 ` Christian König
2020-11-16 20:32 ` Christian König
2020-11-17 8:33 ` Lee Jones [this message]
2020-11-17 8:33 ` Lee Jones
2020-11-17 19:14 ` Daniel Vetter
2020-11-17 19:14 ` Daniel Vetter
2020-11-16 17:41 ` [PATCH 33/42] drm/ttm/ttm_range_manager: Demote non-conformant kernel-doc header Lee Jones
2020-11-16 17:41 ` Lee Jones
2020-11-16 20:34 ` Christian König
2020-11-16 20:34 ` Christian König
2020-11-16 17:41 ` [PATCH 34/42] drm/v3d/v3d_drv: Remove unused static variable 'v3d_v3d_pm_ops' Lee Jones
2020-11-16 17:41 ` Lee Jones
2020-11-16 17:41 ` [PATCH 35/42] drm/v3d/v3d_gem: Provide descriptions for 'v3d_lookup_bos's params Lee Jones
2020-11-16 17:41 ` Lee Jones
2020-11-16 17:41 ` [PATCH 36/42] drm/v3d/v3d_sched: Demote non-conformant kernel-doc header Lee Jones
2020-11-16 17:41 ` Lee Jones
2020-11-16 17:41 ` [PATCH 37/42] drm/vc4/vc4_hdmi_regs: Mark some data sets as __maybe_unused Lee Jones
2020-11-16 17:41 ` Lee Jones
2020-11-16 17:41 ` [PATCH 38/42] drm/vc4/vc4_hdmi: Remove set but unused variable 'ret' Lee Jones
2020-11-16 17:41 ` Lee Jones
2020-11-17 19:40 ` Daniel Vetter
2020-11-17 19:40 ` Daniel Vetter
2020-11-16 17:41 ` [PATCH 39/42] drm/vc4/vc4_v3d: Demote non-conformant kernel-doc headers Lee Jones
2020-11-16 17:41 ` Lee Jones
2020-11-16 17:41 ` [PATCH 40/42] drm/vc4/vc4_debugfs: " Lee Jones
2020-11-16 17:41 ` Lee Jones
2020-11-16 17:41 ` [PATCH 41/42] gpu/ipu-v3/ipu-di: Strip out 2 unused 'di_sync_config' entries Lee Jones
2020-11-16 17:41 ` Lee Jones
2020-11-17 11:22 ` Philipp Zabel
2020-11-17 11:22 ` Philipp Zabel
2020-11-16 17:41 ` [PATCH 42/42] include/drm/drm_atomic: Make use of 'new_crtc_state' Lee Jones
2020-11-16 17:41 ` Lee Jones
2020-11-17 19:42 ` Daniel Vetter
2020-11-17 19:42 ` Daniel Vetter
2020-11-18 8:43 ` Lee Jones
2020-11-18 8:43 ` 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=20201117083346.GB1869941@dell \
--to=lee.jones@linaro.org \
--cc=airlied@linux.ie \
--cc=christian.koenig@amd.com \
--cc=daniel@ffwll.ch \
--cc=dri-devel@lists.freedesktop.org \
--cc=linux-kernel@vger.kernel.org \
--cc=ray.huang@amd.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.