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

From: Randy Dunlap
Date: Sun Feb 25 2018 - 13:13:50 EST


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@xxxxxxxxx>
> Signed-off-by: Miguel Ojeda <miguel.ojeda.sandonis@xxxxxxxxx>
> ---
> 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.

> * @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