diff mbox series

drm: Fix htmldocs warnings in drm_fourcc.c

Message ID 20181107205546.216088-1-sean@poorly.run (mailing list archive)
State New, archived
Headers show
Series drm: Fix htmldocs warnings in drm_fourcc.c | expand

Commit Message

Sean Paul Nov. 7, 2018, 8:55 p.m. UTC
From: Sean Paul <seanpaul@chromium.org>

Add a description for dev and remove the excess one for native. Fixes
the following warnings:

../drivers/gpu/drm/drm_fourcc.c:112: warning: Function parameter or member 'dev' not described in 'drm_driver_legacy_fb_format'
../drivers/gpu/drm/drm_fourcc.c:112: warning: Excess function parameter 'native' description in 'drm_driver_legacy_fb_format'

Fixes: 059b5eb5d955 ("drm: move native byte order quirk to new drm_driver_legacy_fb_format function")
Cc: Gerd Hoffmann <kraxel@redhat.com>
Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: Sean Paul <seanpaul@chromium.org>
---
 drivers/gpu/drm/drm_fourcc.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Daniel Vetter Nov. 7, 2018, 9:13 p.m. UTC | #1
On Wed, Nov 07, 2018 at 03:55:33PM -0500, Sean Paul wrote:
> From: Sean Paul <seanpaul@chromium.org>
> 
> Add a description for dev and remove the excess one for native. Fixes
> the following warnings:
> 
> ../drivers/gpu/drm/drm_fourcc.c:112: warning: Function parameter or member 'dev' not described in 'drm_driver_legacy_fb_format'
> ../drivers/gpu/drm/drm_fourcc.c:112: warning: Excess function parameter 'native' description in 'drm_driver_legacy_fb_format'
> 
> Fixes: 059b5eb5d955 ("drm: move native byte order quirk to new drm_driver_legacy_fb_format function")
> Cc: Gerd Hoffmann <kraxel@redhat.com>
> Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
> Signed-off-by: Sean Paul <seanpaul@chromium.org>

Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>

> ---
>  drivers/gpu/drm/drm_fourcc.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/gpu/drm/drm_fourcc.c b/drivers/gpu/drm/drm_fourcc.c
> index 90a1c846fc25..8aaa5e86a979 100644
> --- a/drivers/gpu/drm/drm_fourcc.c
> +++ b/drivers/gpu/drm/drm_fourcc.c
> @@ -97,9 +97,9 @@ EXPORT_SYMBOL(drm_mode_legacy_fb_format);
>  
>  /**
>   * drm_driver_legacy_fb_format - compute drm fourcc code from legacy description
> + * @dev: DRM device
>   * @bpp: bits per pixels
>   * @depth: bit depth per pixel
> - * @native: use host native byte order
>   *
>   * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
>   * Unlike drm_mode_legacy_fb_format() this looks at the drivers mode_config,
> -- 
> Sean Paul, Software Engineer, Google / Chromium OS
>
Sean Paul Nov. 7, 2018, 9:25 p.m. UTC | #2
On Wed, Nov 7, 2018 at 4:13 PM Daniel Vetter <daniel@ffwll.ch> wrote:
>
> On Wed, Nov 07, 2018 at 03:55:33PM -0500, Sean Paul wrote:
> > From: Sean Paul <seanpaul@chromium.org>
> >
> > Add a description for dev and remove the excess one for native. Fixes
> > the following warnings:
> >
> > ../drivers/gpu/drm/drm_fourcc.c:112: warning: Function parameter or member 'dev' not described in 'drm_driver_legacy_fb_format'
> > ../drivers/gpu/drm/drm_fourcc.c:112: warning: Excess function parameter 'native' description in 'drm_driver_legacy_fb_format'
> >
> > Fixes: 059b5eb5d955 ("drm: move native byte order quirk to new drm_driver_legacy_fb_format function")
> > Cc: Gerd Hoffmann <kraxel@redhat.com>
> > Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
> > Signed-off-by: Sean Paul <seanpaul@chromium.org>
>
> Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
>

Applied to -misc-fixes, thanks for the quick review!

Sean


> > ---
> >  drivers/gpu/drm/drm_fourcc.c | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/drivers/gpu/drm/drm_fourcc.c b/drivers/gpu/drm/drm_fourcc.c
> > index 90a1c846fc25..8aaa5e86a979 100644
> > --- a/drivers/gpu/drm/drm_fourcc.c
> > +++ b/drivers/gpu/drm/drm_fourcc.c
> > @@ -97,9 +97,9 @@ EXPORT_SYMBOL(drm_mode_legacy_fb_format);
> >
> >  /**
> >   * drm_driver_legacy_fb_format - compute drm fourcc code from legacy description
> > + * @dev: DRM device
> >   * @bpp: bits per pixels
> >   * @depth: bit depth per pixel
> > - * @native: use host native byte order
> >   *
> >   * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
> >   * Unlike drm_mode_legacy_fb_format() this looks at the drivers mode_config,
> > --
> > Sean Paul, Software Engineer, Google / Chromium OS
> >
>
> --
> Daniel Vetter
> Software Engineer, Intel Corporation
> http://blog.ffwll.ch
diff mbox series

Patch

diff --git a/drivers/gpu/drm/drm_fourcc.c b/drivers/gpu/drm/drm_fourcc.c
index 90a1c846fc25..8aaa5e86a979 100644
--- a/drivers/gpu/drm/drm_fourcc.c
+++ b/drivers/gpu/drm/drm_fourcc.c
@@ -97,9 +97,9 @@  EXPORT_SYMBOL(drm_mode_legacy_fb_format);
 
 /**
  * drm_driver_legacy_fb_format - compute drm fourcc code from legacy description
+ * @dev: DRM device
  * @bpp: bits per pixels
  * @depth: bit depth per pixel
- * @native: use host native byte order
  *
  * Computes a drm fourcc pixel format code for the given @bpp/@depth values.
  * Unlike drm_mode_legacy_fb_format() this looks at the drivers mode_config,