| Message ID | 20201127195825.858960-2-sam@ravnborg.org (mailing list archive) |
|---|---|
| State | Superseded, archived |
| Headers | show |
| Series | drivers/video: W=1 warning fixes | expand |
On Fri, 27 Nov 2020, Sam Ravnborg wrote: > Fix trivial W=1 warnings. > Update kernel-doc to avoid the warnings. Can you put what's being fixed in the subject line please? "fix w=1 warnings" is very bland and this it is unlikely to be the only w=1 warning that gets fixed in these files, so has a high likely hood of having an identical subject-line as a previous/future patch. With regards to the latter point; I have personally found subject lines to be a pretty reliable way of maintaining/backporting older kernels. The nomenclature here would taint that pretty readily. > Signed-off-by: Sam Ravnborg <sam@ravnborg.org> > Cc: Sam Ravnborg <sam@ravnborg.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 > - * @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.) > *
Hi Lee, On Sat, Nov 28, 2020 at 08:28:20AM +0000, Lee Jones wrote: > On Fri, 27 Nov 2020, Sam Ravnborg wrote: > > > Fix trivial W=1 warnings. > > Update kernel-doc to avoid the warnings. > > Can you put what's being fixed in the subject line please? > > "fix w=1 warnings" is very bland and this it is unlikely to be the > only w=1 warning that gets fixed in these files, so has a high likely > hood of having an identical subject-line as a previous/future patch. > > With regards to the latter point; I have personally found subject > lines to be a pretty reliable way of maintaining/backporting older > kernels. The nomenclature here would taint that pretty readily. Thanks for the feedback and the background for your comment. Will fix them all for v2, Sam
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.) *
Fix trivial W=1 warnings. Update kernel-doc to avoid the warnings. Signed-off-by: Sam Ravnborg <sam@ravnborg.org> Cc: Sam Ravnborg <sam@ravnborg.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(-)