[02/11] video: fbdev: kconfig: Remove blank help text
diff mbox

Message ID 20180131093434.20050-3-ulfalizer@gmail.com
State New
Headers show

Commit Message

Ulf Magnusson Jan. 31, 2018, 9:34 a.m. UTC
Blank help texts are probably either a typo, a Kconfig misunderstanding,
or some kind of half-committing to adding a help text (in which case a
TODO comment would be clearer, if the help text really can't be added
right away).

Best to remove them, IMO.

Signed-off-by: Ulf Magnusson <ulfalizer@gmail.com>
---
 drivers/video/fbdev/Kconfig | 1 -
 1 file changed, 1 deletion(-)

Comments

Bartlomiej Zolnierkiewicz Feb. 1, 2018, 3:52 p.m. UTC | #1
Hi,

On Wednesday, January 31, 2018 10:34:21 AM Ulf Magnusson wrote:
> Blank help texts are probably either a typo, a Kconfig misunderstanding,
> or some kind of half-committing to adding a help text (in which case a
> TODO comment would be clearer, if the help text really can't be added
> right away).
> 
> Best to remove them, IMO.

How about actually adding some meaningful help texts instead
(as a general rule each user visible option should have valid
help text)?

> Signed-off-by: Ulf Magnusson <ulfalizer@gmail.com>
> ---
>  drivers/video/fbdev/Kconfig | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/drivers/video/fbdev/Kconfig b/drivers/video/fbdev/Kconfig
> index 6962b4583fd7..11e699f1062b 100644
> --- a/drivers/video/fbdev/Kconfig
> +++ b/drivers/video/fbdev/Kconfig
> @@ -1156,7 +1156,6 @@ config FB_I810_I2C
>  	bool "Enable DDC Support"
>  	depends on FB_I810 && FB_I810_GTF
>  	select FB_DDC
> -	help

Please add a missing help text instead (take a look at FB_SAVAGE_I2C
config option to see how a valid help text entry should look like).

In the longer term we should consider removing *_I2C config options
and just make the main config options always enable I2C subsystem
directly if needed/useful (some fbdev drivers are doing it this way
already).

>  config FB_LE80578
>  	tristate "Intel LE80578 (Vermilion) support"

Best regards,
--
Bartlomiej Zolnierkiewicz
Samsung R&D Institute Poland
Samsung Electronics

--
To unsubscribe from this list: send the line "unsubscribe linux-kbuild" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Ulf Magnusson Feb. 1, 2018, 4:56 p.m. UTC | #2
On Thu, Feb 1, 2018 at 4:52 PM, Bartlomiej Zolnierkiewicz
<b.zolnierkie@samsung.com> wrote:
>
> Hi,
>
> On Wednesday, January 31, 2018 10:34:21 AM Ulf Magnusson wrote:
>> Blank help texts are probably either a typo, a Kconfig misunderstanding,
>> or some kind of half-committing to adding a help text (in which case a
>> TODO comment would be clearer, if the help text really can't be added
>> right away).
>>
>> Best to remove them, IMO.
>
> How about actually adding some meaningful help texts instead
> (as a general rule each user visible option should have valid
> help text)?
>
>> Signed-off-by: Ulf Magnusson <ulfalizer@gmail.com>
>> ---
>>  drivers/video/fbdev/Kconfig | 1 -
>>  1 file changed, 1 deletion(-)
>>
>> diff --git a/drivers/video/fbdev/Kconfig b/drivers/video/fbdev/Kconfig
>> index 6962b4583fd7..11e699f1062b 100644
>> --- a/drivers/video/fbdev/Kconfig
>> +++ b/drivers/video/fbdev/Kconfig
>> @@ -1156,7 +1156,6 @@ config FB_I810_I2C
>>       bool "Enable DDC Support"
>>       depends on FB_I810 && FB_I810_GTF
>>       select FB_DDC
>> -     help
>
> Please add a missing help text instead (take a look at FB_SAVAGE_I2C
> config option to see how a valid help text entry should look like).

The FB_I810_I2C option was added in 74f6ae84b23 ("[PATCH] i810fb: Add
i2c/DDC support"). What do you think about adding this bit from the
commit message as the help text?

  Add DDC/I2C support for i810fb.  This will allow the driver to get display
  information, especially for monitors with fickle timings.

I'm not familiar with this code, so I don't want to do too much
guessing myself. :)

>
> In the longer term we should consider removing *_I2C config options
> and just make the main config options always enable I2C subsystem
> directly if needed/useful (some fbdev drivers are doing it this way
> already).
>
>>  config FB_LE80578
>>       tristate "Intel LE80578 (Vermilion) support"
>
> Best regards,
> --
> Bartlomiej Zolnierkiewicz
> Samsung R&D Institute Poland
> Samsung Electronics
>

Cheers,
Ulf
--
To unsubscribe from this list: send the line "unsubscribe linux-kbuild" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Masahiro Yamada Feb. 1, 2018, 5:07 p.m. UTC | #3
2018-02-02 1:56 GMT+09:00 Ulf Magnusson <ulfalizer@gmail.com>:
> On Thu, Feb 1, 2018 at 4:52 PM, Bartlomiej Zolnierkiewicz
> <b.zolnierkie@samsung.com> wrote:
>>
>> Hi,
>>
>> On Wednesday, January 31, 2018 10:34:21 AM Ulf Magnusson wrote:
>>> Blank help texts are probably either a typo, a Kconfig misunderstanding,
>>> or some kind of half-committing to adding a help text (in which case a
>>> TODO comment would be clearer, if the help text really can't be added
>>> right away).
>>>
>>> Best to remove them, IMO.

FYI.

I picked up this patch to kbuild
because I need this to suppress warning messages
introduced by 11/11.

I am planning to send a PR for this series.
Bartlomiej Zolnierkiewicz Feb. 13, 2018, 12:31 p.m. UTC | #4
On Thursday, February 01, 2018 05:56:18 PM Ulf Magnusson wrote:
> On Thu, Feb 1, 2018 at 4:52 PM, Bartlomiej Zolnierkiewicz
> <b.zolnierkie@samsung.com> wrote:
> >
> > Hi,
> >
> > On Wednesday, January 31, 2018 10:34:21 AM Ulf Magnusson wrote:
> >> Blank help texts are probably either a typo, a Kconfig misunderstanding,
> >> or some kind of half-committing to adding a help text (in which case a
> >> TODO comment would be clearer, if the help text really can't be added
> >> right away).
> >>
> >> Best to remove them, IMO.
> >
> > How about actually adding some meaningful help texts instead
> > (as a general rule each user visible option should have valid
> > help text)?
> >
> >> Signed-off-by: Ulf Magnusson <ulfalizer@gmail.com>
> >> ---
> >>  drivers/video/fbdev/Kconfig | 1 -
> >>  1 file changed, 1 deletion(-)
> >>
> >> diff --git a/drivers/video/fbdev/Kconfig b/drivers/video/fbdev/Kconfig
> >> index 6962b4583fd7..11e699f1062b 100644
> >> --- a/drivers/video/fbdev/Kconfig
> >> +++ b/drivers/video/fbdev/Kconfig
> >> @@ -1156,7 +1156,6 @@ config FB_I810_I2C
> >>       bool "Enable DDC Support"
> >>       depends on FB_I810 && FB_I810_GTF
> >>       select FB_DDC
> >> -     help
> >
> > Please add a missing help text instead (take a look at FB_SAVAGE_I2C
> > config option to see how a valid help text entry should look like).
> 
> The FB_I810_I2C option was added in 74f6ae84b23 ("[PATCH] i810fb: Add
> i2c/DDC support"). What do you think about adding this bit from the
> commit message as the help text?
> 
>   Add DDC/I2C support for i810fb.  This will allow the driver to get display
>   information, especially for monitors with fickle timings.

Seems fine to me, please add:

    If unsure, say Y.

and send it as a proper patch.

> I'm not familiar with this code, so I don't want to do too much
> guessing myself. :)

:)

> > In the longer term we should consider removing *_I2C config options
> > and just make the main config options always enable I2C subsystem
> > directly if needed/useful (some fbdev drivers are doing it this way
> > already).
> >
> >>  config FB_LE80578
> >>       tristate "Intel LE80578 (Vermilion) support"
> >
> > Best regards,
> > --
> > Bartlomiej Zolnierkiewicz
> > Samsung R&D Institute Poland
> > Samsung Electronics
> >
> 
> Cheers,
> Ulf

Best regards,
--
Bartlomiej Zolnierkiewicz
Samsung R&D Institute Poland
Samsung Electronics

--
To unsubscribe from this list: send the line "unsubscribe linux-kbuild" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch
diff mbox

diff --git a/drivers/video/fbdev/Kconfig b/drivers/video/fbdev/Kconfig
index 6962b4583fd7..11e699f1062b 100644
--- a/drivers/video/fbdev/Kconfig
+++ b/drivers/video/fbdev/Kconfig
@@ -1156,7 +1156,6 @@  config FB_I810_I2C
 	bool "Enable DDC Support"
 	depends on FB_I810 && FB_I810_GTF
 	select FB_DDC
-	help
 
 config FB_LE80578
 	tristate "Intel LE80578 (Vermilion) support"