Messages in this thread | | | Date | Sat, 7 Nov 2020 15:13:42 +0000 | From | Lee Jones <> | Subject | Re: [PATCH 17/19] drm/radeon/radeon_kms: Fix misnaming of 'radeon_info_ioctl's dev param |
| |
On Sat, 07 Nov 2020, Sam Ravnborg wrote:
> Hi Lee, > > On Fri, Nov 06, 2020 at 09:49:47PM +0000, Lee Jones wrote: > > Fixes the following W=1 kernel build warning(s): > > > > drivers/gpu/drm/radeon/radeon_kms.c:226: warning: Function parameter or member 'dev' not described in 'radeon_info_ioctl' > > drivers/gpu/drm/radeon/radeon_kms.c:226: warning: Excess function parameter 'rdev' description in 'radeon_info_ioctl' > > > > Cc: Alex Deucher <alexander.deucher@amd.com> > > Cc: "Christian König" <christian.koenig@amd.com> > > Cc: David Airlie <airlied@linux.ie> > > Cc: Daniel Vetter <daniel@ffwll.ch> > > Cc: amd-gfx@lists.freedesktop.org > > Cc: dri-devel@lists.freedesktop.org > > Signed-off-by: Lee Jones <lee.jones@linaro.org> > > --- > > drivers/gpu/drm/radeon/radeon_kms.c | 2 +- > > 1 file changed, 1 insertion(+), 1 deletion(-) > > > > diff --git a/drivers/gpu/drm/radeon/radeon_kms.c b/drivers/gpu/drm/radeon/radeon_kms.c > > index 0d8fbabffcead..21c206795c364 100644 > > --- a/drivers/gpu/drm/radeon/radeon_kms.c > > +++ b/drivers/gpu/drm/radeon/radeon_kms.c > > @@ -213,7 +213,7 @@ static void radeon_set_filp_rights(struct drm_device *dev, > > /** > > * radeon_info_ioctl - answer a device specific request. > > * > > - * @rdev: radeon device pointer > > + * @dev: radeon device pointer > > * @data: request object > > * @filp: drm filp > > * > > Delete all the kernel-doc annotation as we do not pull this file into > the kernel-doc anyway. > > Keep the /* Answer a device specific request */ part. > > At least thats what I see as the best way to deal with it.
Demoting all headers, even if they are conformant, it not the way to go. Some contributors/maintainers prefer to keep the kernel-doc (pretty colours, automated checking [a la, this patch!] and the-like) formatting, even if they are not directly referenced from /Documentation.
For now, so long as the build is happy, I am happy.
If you wish to make the build unhappy about this, you should take up the argument to encompass `scripts/find-unused-docs.sh` into it.
-- Lee Jones [李琼斯] Senior Technical Lead - Developer Services Linaro.org │ Open source software for Arm SoCs Follow Linaro: Facebook | Twitter | Blog
| |