Skip to contentSkip to conversation

auxdisplay: arm-charlcd: Fix struct charlcd doc line

PATCH Superseded Miguel Ojeda 2 participants 3 messages Feb 25, 2018 Auxiliary display drivers

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 auxdisplay: arm-charlcd: Fix struct charlcd doc line

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

---
Please let me know if anyone does not want this in 4.17.

 drivers/auxdisplay/arm-charlcd.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/auxdisplay/arm-charlcd.c +2 -0
index b3176ee92b90..27cf08a05e93 100644
@@ -54,12 +54,14 @@
 #define HD_BUSY_FLAG			0x80U
 
 /**
+ * struct charlcd
  * @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;
Signature · 1 line
2.14.1
#1 lore raw
Quoted 21 lines · Miguel Ojeda

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

---
Please let me know if anyone does not want this in 4.17.

 drivers/auxdisplay/arm-charlcd.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/auxdisplay/arm-charlcd.c +0 -0
index b3176ee92b90..27cf08a05e93 100644

drivers/auxdisplay/arm-charlcd.c line 57

Quoted 4 lines
drivers/auxdisplay/arm-charlcd.c +1 -0
@@ -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.

drivers/auxdisplay/arm-charlcd.c line 67

Quoted 11 lines
drivers/auxdisplay/arm-charlcd.c +1 -0
  * @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,

Signature · 1 line
~Randy
#2 lore raw
Quoted 24 lines · Randy Dunlap
Quoted 23 lines · Miguel Ojeda

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

---
Please let me know if anyone does not want this in 4.17.

 drivers/auxdisplay/arm-charlcd.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/auxdisplay/arm-charlcd.c +0 -0
index b3176ee92b90..27cf08a05e93 100644
@@ -54,12 +54,14 @@
 #define HD_BUSY_FLAG                 0x80U
 
Quoted 8 lines

drivers/auxdisplay/arm-charlcd.c line 57

Quoted 2 lines
drivers/auxdisplay/arm-charlcd.c +1 -0
 /**
+ * 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

Quoted 15 lines

drivers/auxdisplay/arm-charlcd.c line 67

Quoted 11 lines
drivers/auxdisplay/arm-charlcd.c +1 -0
  * @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