Attempting to clean-up W=1 kernel builds, which are currently
overwhelmingly riddled with niggly little warnings.
Lee Jones (8):
backlight: lms501kf03: Remove unused const variables
backlight: lcd: Add missing kerneldoc entry for 'struct device parent'
backlight: ili922x: Add missing kerneldoc descriptions for
CHECK_FREQ_REG() args
backlight: ili922x: Remove invalid use of kerneldoc syntax
backlight: ili922x: Add missing kerneldoc description for
ili922x_reg_dump()'s arg
backlight: backlight: Supply description for function args in existing
Kerneldocs
backlight: lm3630a_bl: Remove invalid checks for unsigned int < 0
backlight: qcom-wled: Remove unused configs for LED3 and LED4
drivers/video/backlight/backlight.c | 2 ++
drivers/video/backlight/ili922x.c | 8 ++++++--
drivers/video/backlight/lcd.c | 1 +
drivers/video/backlight/lm3630a_bl.c | 4 ++--
drivers/video/backlight/lms501kf03.c | 8 --------
drivers/video/backlight/qcom-wled.c | 8 --------
6 files changed, 11 insertions(+), 20 deletions(-)
--
2.25.1
Kerneldoc is for documenting function arguments and return values.
Prevents warnings like:
drivers/video/backlight/ili922x.c:127: warning: cannot understand function prototype: 'int ili922x_id = 1; '
drivers/video/backlight/ili922x.c:136: warning: cannot understand function prototype: 'struct ili922x '
Cc: <[email protected]>
Cc: Bartlomiej Zolnierkiewicz <[email protected]>
Cc: Software Engineering <[email protected]>
Signed-off-by: Lee Jones <[email protected]>
---
drivers/video/backlight/ili922x.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/drivers/video/backlight/ili922x.c b/drivers/video/backlight/ili922x.c
index 8cb4b9d3c3bba..cd41433b87aeb 100644
--- a/drivers/video/backlight/ili922x.c
+++ b/drivers/video/backlight/ili922x.c
@@ -123,7 +123,7 @@
#define set_tx_byte(b) (tx_invert ? ~(b) : b)
-/**
+/*
* ili922x_id - id as set by manufacturer
*/
static int ili922x_id = 1;
@@ -132,7 +132,7 @@ module_param(ili922x_id, int, 0);
static int tx_invert;
module_param(tx_invert, int, 0);
-/**
+/*
* driver's private structure
*/
struct ili922x {
--
2.25.1
This has been missing since the conversion to 'struct device' in 2007.
Cc: <[email protected]>
Cc: Bartlomiej Zolnierkiewicz <[email protected]>
Cc: Jamey Hicks <[email protected]>
Cc: Andrew Zabolotny <[email protected]>
Signed-off-by: Lee Jones <[email protected]>
---
drivers/video/backlight/lcd.c | 1 +
1 file changed, 1 insertion(+)
diff --git a/drivers/video/backlight/lcd.c b/drivers/video/backlight/lcd.c
index 78b0333586258..db56e465aaff3 100644
--- a/drivers/video/backlight/lcd.c
+++ b/drivers/video/backlight/lcd.c
@@ -179,6 +179,7 @@ ATTRIBUTE_GROUPS(lcd_device);
* lcd_device_register - register a new object of lcd_device class.
* @name: the name of the new object(must be the same as the name of the
* respective framebuffer device).
+ * @parent: pointer to the parent's struct device .
* @devdata: an optional pointer to be stored in the device. The
* methods may retrieve it by using lcd_get_data(ld).
* @ops: the lcd operations structure.
--
2.25.1
Hi Lee.
On Wed, Jun 24, 2020 at 03:57:13PM +0100, Lee Jones wrote:
> Attempting to clean-up W=1 kernel builds, which are currently
> overwhelmingly riddled with niggly little warnings.
>
> Lee Jones (8):
> backlight: lms501kf03: Remove unused const variables
> backlight: lcd: Add missing kerneldoc entry for 'struct device parent'
> backlight: ili922x: Add missing kerneldoc descriptions for
> CHECK_FREQ_REG() args
> backlight: ili922x: Remove invalid use of kerneldoc syntax
> backlight: ili922x: Add missing kerneldoc description for
> ili922x_reg_dump()'s arg
I wonder why these warnings show up as nothing pulls in this .c file.
Anyway I would suggest to drop using kerneldoc syntax for single drivers
like this - and the benefit here is low.
Now they are typed, otherwise this ahd been fine in a single patch.
> backlight: backlight: Supply description for function args in existing
> Kerneldocs
> backlight: lm3630a_bl: Remove invalid checks for unsigned int < 0
> backlight: qcom-wled: Remove unused configs for LED3 and LED4
The other fixes looks good.
They are all:
Acked-by: Sam Ravnborg <[email protected]>
Sam
> drivers/video/backlight/backlight.c | 2 ++
> drivers/video/backlight/ili922x.c | 8 ++++++--
> drivers/video/backlight/lcd.c | 1 +
> drivers/video/backlight/lm3630a_bl.c | 4 ++--
> drivers/video/backlight/lms501kf03.c | 8 --------
> drivers/video/backlight/qcom-wled.c | 8 --------
> 6 files changed, 11 insertions(+), 20 deletions(-)
>
> --
> 2.25.1
>
> _______________________________________________
> dri-devel mailing list
> [email protected]
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
On Wed, 24 Jun 2020, Sam Ravnborg wrote:
> Hi Lee.
>
> On Wed, Jun 24, 2020 at 03:57:13PM +0100, Lee Jones wrote:
> > Attempting to clean-up W=1 kernel builds, which are currently
> > overwhelmingly riddled with niggly little warnings.
> >
> > Lee Jones (8):
> > backlight: lms501kf03: Remove unused const variables
> > backlight: lcd: Add missing kerneldoc entry for 'struct device parent'
>
>
> > backlight: ili922x: Add missing kerneldoc descriptions for
> > CHECK_FREQ_REG() args
> > backlight: ili922x: Remove invalid use of kerneldoc syntax
> > backlight: ili922x: Add missing kerneldoc description for
> > ili922x_reg_dump()'s arg
> I wonder why these warnings show up as nothing pulls in this .c file.
> Anyway I would suggest to drop using kerneldoc syntax for single drivers
> like this - and the benefit here is low.
> Now they are typed, otherwise this ahd been fine in a single patch.
What do you mean by 'nothing pulls it in'?
> > backlight: backlight: Supply description for function args in existing
> > Kerneldocs
> > backlight: lm3630a_bl: Remove invalid checks for unsigned int < 0
> > backlight: qcom-wled: Remove unused configs for LED3 and LED4
>
> The other fixes looks good.
> They are all:
> Acked-by: Sam Ravnborg <[email protected]>
Thanks (although this should be Reviewed-by).
> > drivers/video/backlight/backlight.c | 2 ++
> > drivers/video/backlight/ili922x.c | 8 ++++++--
> > drivers/video/backlight/lcd.c | 1 +
> > drivers/video/backlight/lm3630a_bl.c | 4 ++--
> > drivers/video/backlight/lms501kf03.c | 8 --------
> > drivers/video/backlight/qcom-wled.c | 8 --------
> > 6 files changed, 11 insertions(+), 20 deletions(-)
> >
--
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
Hi Lee.
On Wed, Jun 24, 2020 at 04:43:21PM +0100, Lee Jones wrote:
> On Wed, 24 Jun 2020, Sam Ravnborg wrote:
>
> > Hi Lee.
> >
> > On Wed, Jun 24, 2020 at 03:57:13PM +0100, Lee Jones wrote:
> > > Attempting to clean-up W=1 kernel builds, which are currently
> > > overwhelmingly riddled with niggly little warnings.
> > >
> > > Lee Jones (8):
> > > backlight: lms501kf03: Remove unused const variables
> > > backlight: lcd: Add missing kerneldoc entry for 'struct device parent'
> >
> >
> > > backlight: ili922x: Add missing kerneldoc descriptions for
> > > CHECK_FREQ_REG() args
> > > backlight: ili922x: Remove invalid use of kerneldoc syntax
> > > backlight: ili922x: Add missing kerneldoc description for
> > > ili922x_reg_dump()'s arg
> > I wonder why these warnings show up as nothing pulls in this .c file.
> > Anyway I would suggest to drop using kerneldoc syntax for single drivers
> > like this - and the benefit here is low.
> > Now they are typed, otherwise this ahd been fine in a single patch.
>
> What do you mean by 'nothing pulls it in'?
There are no .rst files that includes any:
.. kernel-doc:: drivers/video/backlight/ili922x.c
so I do not see how the kernel-doc comments will be used by any
of the generated kernel-docs.
Sam
>
> > > backlight: backlight: Supply description for function args in existing
> > > Kerneldocs
> > > backlight: lm3630a_bl: Remove invalid checks for unsigned int < 0
> > > backlight: qcom-wled: Remove unused configs for LED3 and LED4
> >
> > The other fixes looks good.
> > They are all:
> > Acked-by: Sam Ravnborg <[email protected]>
>
> Thanks (although this should be Reviewed-by).
>
> > > drivers/video/backlight/backlight.c | 2 ++
> > > drivers/video/backlight/ili922x.c | 8 ++++++--
> > > drivers/video/backlight/lcd.c | 1 +
> > > drivers/video/backlight/lm3630a_bl.c | 4 ++--
> > > drivers/video/backlight/lms501kf03.c | 8 --------
> > > drivers/video/backlight/qcom-wled.c | 8 --------
> > > 6 files changed, 11 insertions(+), 20 deletions(-)
> > >
>
> --
> Lee Jones [李琼斯]
> Senior Technical Lead - Developer Services
> Linaro.org │ Open source software for Arm SoCs
> Follow Linaro: Facebook | Twitter | Blog
On Wed, 24 Jun 2020, Sam Ravnborg wrote:
> Hi Lee.
>
> On Wed, Jun 24, 2020 at 04:43:21PM +0100, Lee Jones wrote:
> > On Wed, 24 Jun 2020, Sam Ravnborg wrote:
> >
> > > Hi Lee.
> > >
> > > On Wed, Jun 24, 2020 at 03:57:13PM +0100, Lee Jones wrote:
> > > > Attempting to clean-up W=1 kernel builds, which are currently
> > > > overwhelmingly riddled with niggly little warnings.
> > > >
> > > > Lee Jones (8):
> > > > backlight: lms501kf03: Remove unused const variables
> > > > backlight: lcd: Add missing kerneldoc entry for 'struct device parent'
> > >
> > >
> > > > backlight: ili922x: Add missing kerneldoc descriptions for
> > > > CHECK_FREQ_REG() args
> > > > backlight: ili922x: Remove invalid use of kerneldoc syntax
> > > > backlight: ili922x: Add missing kerneldoc description for
> > > > ili922x_reg_dump()'s arg
> > > I wonder why these warnings show up as nothing pulls in this .c file.
> > > Anyway I would suggest to drop using kerneldoc syntax for single drivers
> > > like this - and the benefit here is low.
> > > Now they are typed, otherwise this ahd been fine in a single patch.
> >
> > What do you mean by 'nothing pulls it in'?
> There are no .rst files that includes any:
> .. kernel-doc:: drivers/video/backlight/ili922x.c
>
> so I do not see how the kernel-doc comments will be used by any
> of the generated kernel-docs.
Looks like a common problem (if it is actually a problem):
$ ./scripts/find-unused-docs.sh . | wc -l
1476
The role of this patch-set is not to eradicate unused kerneldoc
headers, but to ensure they are formatted correctly. W=1 builds
currently complain of ill formatted kerneldocs, which is currently
littering the build-log and masking some more important issues (which
I'm also trying to fix en route).
> > > > backlight: backlight: Supply description for function args in existing
> > > > Kerneldocs
> > > > backlight: lm3630a_bl: Remove invalid checks for unsigned int < 0
> > > > backlight: qcom-wled: Remove unused configs for LED3 and LED4
> > >
> > > The other fixes looks good.
> > > They are all:
> > > Acked-by: Sam Ravnborg <[email protected]>
> >
> > Thanks (although this should be Reviewed-by).
> >
> > > > drivers/video/backlight/backlight.c | 2 ++
> > > > drivers/video/backlight/ili922x.c | 8 ++++++--
> > > > drivers/video/backlight/lcd.c | 1 +
> > > > drivers/video/backlight/lm3630a_bl.c | 4 ++--
> > > > drivers/video/backlight/lms501kf03.c | 8 --------
> > > > drivers/video/backlight/qcom-wled.c | 8 --------
> > > > 6 files changed, 11 insertions(+), 20 deletions(-)
> > > >
> >
--
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
On Wed, Jun 24, 2020 at 03:57:15PM +0100, Lee Jones wrote:
> This has been missing since the conversion to 'struct device' in 2007.
>
> Cc: <[email protected]>
> Cc: Bartlomiej Zolnierkiewicz <[email protected]>
> Cc: Jamey Hicks <[email protected]>
> Cc: Andrew Zabolotny <[email protected]>
> Signed-off-by: Lee Jones <[email protected]>
Reviewed-by: Daniel Thompson <[email protected]>
> ---
> drivers/video/backlight/lcd.c | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/drivers/video/backlight/lcd.c b/drivers/video/backlight/lcd.c
> index 78b0333586258..db56e465aaff3 100644
> --- a/drivers/video/backlight/lcd.c
> +++ b/drivers/video/backlight/lcd.c
> @@ -179,6 +179,7 @@ ATTRIBUTE_GROUPS(lcd_device);
> * lcd_device_register - register a new object of lcd_device class.
> * @name: the name of the new object(must be the same as the name of the
> * respective framebuffer device).
> + * @parent: pointer to the parent's struct device .
> * @devdata: an optional pointer to be stored in the device. The
> * methods may retrieve it by using lcd_get_data(ld).
> * @ops: the lcd operations structure.
> --
> 2.25.1
>
On Wed, Jun 24, 2020 at 03:57:17PM +0100, Lee Jones wrote:
> Kerneldoc is for documenting function arguments and return values.
>
> Prevents warnings like:
>
> drivers/video/backlight/ili922x.c:127: warning: cannot understand function prototype: 'int ili922x_id = 1; '
> drivers/video/backlight/ili922x.c:136: warning: cannot understand function prototype: 'struct ili922x '
>
> Cc: <[email protected]>
> Cc: Bartlomiej Zolnierkiewicz <[email protected]>
> Cc: Software Engineering <[email protected]>
> Signed-off-by: Lee Jones <[email protected]>
Reviewed-by: Daniel Thompson <[email protected]>
> ---
> drivers/video/backlight/ili922x.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/video/backlight/ili922x.c b/drivers/video/backlight/ili922x.c
> index 8cb4b9d3c3bba..cd41433b87aeb 100644
> --- a/drivers/video/backlight/ili922x.c
> +++ b/drivers/video/backlight/ili922x.c
> @@ -123,7 +123,7 @@
>
> #define set_tx_byte(b) (tx_invert ? ~(b) : b)
>
> -/**
> +/*
> * ili922x_id - id as set by manufacturer
> */
> static int ili922x_id = 1;
> @@ -132,7 +132,7 @@ module_param(ili922x_id, int, 0);
> static int tx_invert;
> module_param(tx_invert, int, 0);
>
> -/**
> +/*
> * driver's private structure
> */
> struct ili922x {
> --
> 2.25.1
>
Hi Lee.
On Thu, Jun 25, 2020 at 09:03:37AM +0100, Lee Jones wrote:
> On Wed, 24 Jun 2020, Sam Ravnborg wrote:
>
> > Hi Lee.
> >
> > On Wed, Jun 24, 2020 at 04:43:21PM +0100, Lee Jones wrote:
> > > On Wed, 24 Jun 2020, Sam Ravnborg wrote:
> > >
> > > > Hi Lee.
> > > >
> > > > On Wed, Jun 24, 2020 at 03:57:13PM +0100, Lee Jones wrote:
> > > > > Attempting to clean-up W=1 kernel builds, which are currently
> > > > > overwhelmingly riddled with niggly little warnings.
> > > > >
> > > > > Lee Jones (8):
> > > > > backlight: lms501kf03: Remove unused const variables
> > > > > backlight: lcd: Add missing kerneldoc entry for 'struct device parent'
> > > >
> > > >
> > > > > backlight: ili922x: Add missing kerneldoc descriptions for
> > > > > CHECK_FREQ_REG() args
> > > > > backlight: ili922x: Remove invalid use of kerneldoc syntax
> > > > > backlight: ili922x: Add missing kerneldoc description for
> > > > > ili922x_reg_dump()'s arg
> > > > I wonder why these warnings show up as nothing pulls in this .c file.
> > > > Anyway I would suggest to drop using kerneldoc syntax for single drivers
> > > > like this - and the benefit here is low.
> > > > Now they are typed, otherwise this ahd been fine in a single patch.
> > >
> > > What do you mean by 'nothing pulls it in'?
> > There are no .rst files that includes any:
> > .. kernel-doc:: drivers/video/backlight/ili922x.c
> >
> > so I do not see how the kernel-doc comments will be used by any
> > of the generated kernel-docs.
>
> Looks like a common problem (if it is actually a problem):
>
> $ ./scripts/find-unused-docs.sh . | wc -l
> 1476
>
> The role of this patch-set is not to eradicate unused kerneldoc
> headers, but to ensure they are formatted correctly. W=1 builds
> currently complain of ill formatted kerneldocs, which is currently
> littering the build-log and masking some more important issues (which
> I'm also trying to fix en route).
My point is that I do not see why we should maintain correct kernel-doc
style comments for files that are not used to to generate kernel-doc.
It would serve us better to drop the kernel-doc style comments.
But thats just my opinion, feel free to ignore.
I digged a little and can see we run kernel-doc on all .c files
when we specify W=1 - which was a suprise to me.
That explains why I had not seen said warnings in my regular make
htmldocs runs.
Sam
>
> > > > > backlight: backlight: Supply description for function args in existing
> > > > > Kerneldocs
> > > > > backlight: lm3630a_bl: Remove invalid checks for unsigned int < 0
> > > > > backlight: qcom-wled: Remove unused configs for LED3 and LED4
> > > >
> > > > The other fixes looks good.
> > > > They are all:
> > > > Acked-by: Sam Ravnborg <[email protected]>
> > >
> > > Thanks (although this should be Reviewed-by).
> > >
> > > > > drivers/video/backlight/backlight.c | 2 ++
> > > > > drivers/video/backlight/ili922x.c | 8 ++++++--
> > > > > drivers/video/backlight/lcd.c | 1 +
> > > > > drivers/video/backlight/lm3630a_bl.c | 4 ++--
> > > > > drivers/video/backlight/lms501kf03.c | 8 --------
> > > > > drivers/video/backlight/qcom-wled.c | 8 --------
> > > > > 6 files changed, 11 insertions(+), 20 deletions(-)
> > > > >
> > >
>
> --
> Lee Jones [李琼斯]
> Senior Technical Lead - Developer Services
> Linaro.org │ Open source software for Arm SoCs
> Follow Linaro: Facebook | Twitter | Blog
On Wed, 24 Jun 2020, Lee Jones wrote:
> Attempting to clean-up W=1 kernel builds, which are currently
> overwhelmingly riddled with niggly little warnings.
>
> Lee Jones (8):
> backlight: lms501kf03: Remove unused const variables
> backlight: lcd: Add missing kerneldoc entry for 'struct device parent'
> backlight: ili922x: Add missing kerneldoc descriptions for
> CHECK_FREQ_REG() args
> backlight: ili922x: Remove invalid use of kerneldoc syntax
> backlight: ili922x: Add missing kerneldoc description for
> ili922x_reg_dump()'s arg
> backlight: backlight: Supply description for function args in existing
> Kerneldocs
> backlight: lm3630a_bl: Remove invalid checks for unsigned int < 0
> backlight: qcom-wled: Remove unused configs for LED3 and LED4
>
> drivers/video/backlight/backlight.c | 2 ++
> drivers/video/backlight/ili922x.c | 8 ++++++--
> drivers/video/backlight/lcd.c | 1 +
> drivers/video/backlight/lm3630a_bl.c | 4 ++--
> drivers/video/backlight/lms501kf03.c | 8 --------
> drivers/video/backlight/qcom-wled.c | 8 --------
> 6 files changed, 11 insertions(+), 20 deletions(-)
All applied to Backlight.
--
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog