diff mbox series

[v2,01/28] video: Fix kernel-doc warnings in of_display_timing + of_videomode

Message ID 20201128224114.1033617-2-sam@ravnborg.org (mailing list archive)
State New, archived
Headers show
Series drivers/video: W=1 warning fixes | expand

Commit Message

Sam Ravnborg Nov. 28, 2020, 10:40 p.m. UTC
Fix kernel-doc warnings reported when using W=1.

v2:
  - Improve subject (Lee)

Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
Cc: Lee Jones <lee.jones@linaro.org>
Cc: linux-fbdev@vger.kernel.org
---
 drivers/video/of_display_timing.c | 1 +
 drivers/video/of_videomode.c      | 8 ++++----
 2 files changed, 5 insertions(+), 4 deletions(-)

Comments

Thomas Zimmermann Nov. 29, 2020, 10:01 a.m. UTC | #1
Am 28.11.20 um 23:40 schrieb Sam Ravnborg:
> Fix kernel-doc warnings reported when using W=1.
> 
> v2:
>    - Improve subject (Lee)
> 
> Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
> Cc: Lee Jones <lee.jones@linaro.org>
> Cc: linux-fbdev@vger.kernel.org
> ---
>   drivers/video/of_display_timing.c | 1 +
>   drivers/video/of_videomode.c      | 8 ++++----
>   2 files changed, 5 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/video/of_display_timing.c b/drivers/video/of_display_timing.c
> index abc9ada798ee..f93b6abbe258 100644
> --- a/drivers/video/of_display_timing.c
> +++ b/drivers/video/of_display_timing.c
> @@ -52,6 +52,7 @@ static int parse_timing_property(const struct device_node *np, const char *name,
>   /**
>    * of_parse_display_timing - parse display_timing entry from device_node
>    * @np: device_node with the properties
> + * @dt: display_timing that contains the result. I may be partially written in case of errors
>    **/
>   static int of_parse_display_timing(const struct device_node *np,
>   		struct display_timing *dt)
> diff --git a/drivers/video/of_videomode.c b/drivers/video/of_videomode.c
> index 67aff2421c29..a5bb02f02b44 100644
> --- a/drivers/video/of_videomode.c
> +++ b/drivers/video/of_videomode.c
> @@ -13,10 +13,10 @@
>   #include <video/videomode.h>
>   
>   /**
> - * of_get_videomode - get the videomode #<index> from devicetree

What's wrong with this line? We use the dash in lots of places?

Besides this,

Acked-by: Thomas Zimmermann <tzimmermann@suse.de>

> - * @np - devicenode with the display_timings
> - * @vm - set to return value
> - * @index - index into list of display_timings
> + * of_get_videomode: get the videomode #<index> from devicetree
> + * @np: devicenode with the display_timings
> + * @vm: set to return value
> + * @index: index into list of display_timings
>    *	    (Set this to OF_USE_NATIVE_MODE to use whatever mode is
>    *	     specified as native mode in the DT.)
>    *
>
Sam Ravnborg Nov. 29, 2020, 11:22 a.m. UTC | #2
On Sun, Nov 29, 2020 at 11:01:13AM +0100, Thomas Zimmermann wrote:
> 
> 
> Am 28.11.20 um 23:40 schrieb Sam Ravnborg:
> > Fix kernel-doc warnings reported when using W=1.
> > 
> > v2:
> >    - Improve subject (Lee)
> > 
> > Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
> > Cc: Lee Jones <lee.jones@linaro.org>
> > Cc: linux-fbdev@vger.kernel.org
> > ---
> >   drivers/video/of_display_timing.c | 1 +
> >   drivers/video/of_videomode.c      | 8 ++++----
> >   2 files changed, 5 insertions(+), 4 deletions(-)
> > 
> > diff --git a/drivers/video/of_display_timing.c b/drivers/video/of_display_timing.c
> > index abc9ada798ee..f93b6abbe258 100644
> > --- a/drivers/video/of_display_timing.c
> > +++ b/drivers/video/of_display_timing.c
> > @@ -52,6 +52,7 @@ static int parse_timing_property(const struct device_node *np, const char *name,
> >   /**
> >    * of_parse_display_timing - parse display_timing entry from device_node
> >    * @np: device_node with the properties
> > + * @dt: display_timing that contains the result. I may be partially written in case of errors
> >    **/
> >   static int of_parse_display_timing(const struct device_node *np,
> >   		struct display_timing *dt)
> > diff --git a/drivers/video/of_videomode.c b/drivers/video/of_videomode.c
> > index 67aff2421c29..a5bb02f02b44 100644
> > --- a/drivers/video/of_videomode.c
> > +++ b/drivers/video/of_videomode.c
> > @@ -13,10 +13,10 @@
> >   #include <video/videomode.h>
> >   /**
> > - * of_get_videomode - get the videomode #<index> from devicetree
> 
> What's wrong with this line? We use the dash in lots of places?
I think my OCD kicked in and I made all lines use ':'.
I will re-add the dash when I apply.

> 
> Besides this,
> 
> Acked-by: Thomas Zimmermann <tzimmermann@suse.de>

	Thanks
Sam Ravnborg Nov. 29, 2020, 9:43 p.m. UTC | #3
On Sat, Nov 28, 2020 at 11:40:47PM +0100, Sam Ravnborg wrote:
> Fix kernel-doc warnings reported when using W=1.
> 
> v2:
>   - Improve subject (Lee)
> 
> Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
> Cc: Lee Jones <lee.jones@linaro.org>
> Cc: linux-fbdev@vger.kernel.org

Applied to drm-misc-next after fixing nit that Thomas pointed out.

	Sam
diff mbox series

Patch

diff --git a/drivers/video/of_display_timing.c b/drivers/video/of_display_timing.c
index abc9ada798ee..f93b6abbe258 100644
--- a/drivers/video/of_display_timing.c
+++ b/drivers/video/of_display_timing.c
@@ -52,6 +52,7 @@  static int parse_timing_property(const struct device_node *np, const char *name,
 /**
  * of_parse_display_timing - parse display_timing entry from device_node
  * @np: device_node with the properties
+ * @dt: display_timing that contains the result. I may be partially written in case of errors
  **/
 static int of_parse_display_timing(const struct device_node *np,
 		struct display_timing *dt)
diff --git a/drivers/video/of_videomode.c b/drivers/video/of_videomode.c
index 67aff2421c29..a5bb02f02b44 100644
--- a/drivers/video/of_videomode.c
+++ b/drivers/video/of_videomode.c
@@ -13,10 +13,10 @@ 
 #include <video/videomode.h>
 
 /**
- * of_get_videomode - get the videomode #<index> from devicetree
- * @np - devicenode with the display_timings
- * @vm - set to return value
- * @index - index into list of display_timings
+ * of_get_videomode: get the videomode #<index> from devicetree
+ * @np: devicenode with the display_timings
+ * @vm: set to return value
+ * @index: index into list of display_timings
  *	    (Set this to OF_USE_NATIVE_MODE to use whatever mode is
  *	     specified as native mode in the DT.)
  *