linux-kernel - Re: [PATCH] auxdisplay: arm-charlcd: Fix struct charlcd doc line

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] [day] [month] [year] [list]

Message-ID: <CANiq72mL1yUOJkWDaPRkV2hirnfaUZ_D_dSx8m7g4VcJC=mioQ@mail.gmail.com>
Date:   Sun, 25 Feb 2018 20:49:55 +0100
From:   Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     Linus Walleij <triad@...lth.se>,
        linux-kernel <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] auxdisplay: arm-charlcd: Fix struct charlcd doc line

On Sun, Feb 25, 2018 at 7:13 PM, Randy Dunlap <rdunlap@...radead.org> wrote:
> On 02/25/2018 04:46 AM, Miguel Ojeda wrote:
>> There was a missing first line and a missing member,
>> which gave a warning under W=1:
>>
>>     CC      drivers/auxdisplay/arm-charlcd.o
>>   drivers/auxdisplay/arm-charlcd.c:57: warning: Cannot understand
>>    * @dev: a pointer back to containing device on line 57 - I thought
>>   it was a doc line
>>
>> Cc: Linus Walleij <triad@...lth.se>
>> Signed-off-by: Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
>> ---
>> Please let me know if anyone does not want this in 4.17.
>>
>>  drivers/auxdisplay/arm-charlcd.c | 2 ++
>>  1 file changed, 2 insertions(+)
>>
>> diff --git a/drivers/auxdisplay/arm-charlcd.c b/drivers/auxdisplay/arm-charlcd.c
>> index b3176ee92b90..27cf08a05e93 100644
>> --- a/drivers/auxdisplay/arm-charlcd.c
>> +++ b/drivers/auxdisplay/arm-charlcd.c
>> @@ -54,12 +54,14 @@
>>  #define HD_BUSY_FLAG                 0x80U
>>
>>  /**
>> + * struct charlcd
>
> Can you make that more like:
>  * struct charlcd - <some brief description>
>
> please.  And merged soon would be fine.
>

Sure! I will do:

 /**
+ * struct charlcd - Private data structure
  * @dev: a pointer back to containing device

Cheers,
Miguel

>>   * @dev: a pointer back to containing device
>>   * @phybase: the offset to the controller in physical memory
>>   * @physize: the size of the physical page
>>   * @virtbase: the offset to the controller in virtual memory
>>   * @irq: reserved interrupt number
>>   * @complete: completion structure for the last LCD command
>> + * @init_work: delayed work structure to initialize the display on boot
>>   */
>>  struct charlcd {
>>       struct device *dev;
>>
>
> thanks,
> --
> ~Randy