linux-kernel - Re: [PATCH 02/11] video: fbdev: kconfig: Remove blank help text

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <CAFkk2KQxPnwMKmvhCoKQ0BBciTc5JKqjJqHGHAMR5uHF0w13sg@mail.gmail.com>
Date:   Thu, 1 Feb 2018 17:56:18 +0100
From:   Ulf Magnusson <ulfalizer@...il.com>
To:     Bartlomiej Zolnierkiewicz <b.zolnierkie@...sung.com>
Cc:     Linux Kbuild mailing list <linux-kbuild@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Masahiro Yamada <yamada.masahiro@...ionext.com>,
        "Luis R . Rodriguez" <mcgrof@...nel.org>,
        Randy Dunlap <rdunlap@...radead.org>,
        Dan Carpenter <dan.carpenter@...cle.com>,
        Paul Bolle <pebolle@...cali.nl>, Arnd Bergmann <arnd@...db.de>,
        Michal Simek <michal.simek@...inx.com>,
        Hans de Goede <j.w.r.degoede@...il.com>,
        dri-devel@...ts.freedesktop.org, linux-fbdev@...r.kernel.org
Subject: Re: [PATCH 02/11] video: fbdev: kconfig: Remove blank help text

On Thu, Feb 1, 2018 at 4:52 PM, Bartlomiej Zolnierkiewicz
<b.zolnierkie@...sung.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@...il.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