Skip to contentSkip to conversation

wimax: fix kernel-doc for debufs_dentry member of struct wimax_dev

PATCH Applied Inaky Perez-Gonzalez 3 participants 9 messages Jan 8, 2009 – Jan 10, 2009

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 wimax: fix kernel-doc for debufs_dentry member of struct wimax_dev

Reported by Randy Dunlap from a warning in the v2.6.29 merge window tree as of 2009/1/8.

---
 include/net/wimax.h |    3 +++
 1 files changed, 3 insertions(+), 0 deletions(-)
include/net/wimax.h +3 -0
index 1602614..073809c 100644
@@ -323,6 +323,9 @@ struct input_dev;
  *
  * @rf_hw: [private] State of the hardware radio switch (OFF/ON)
  *
+ * @debufs_dentry: [private] Used to hook up a debugfs entry. This
+ *     shows up in the debugfs root as wimax:DEVICENAME.
+ *
  * Description:
  * This structure defines a common interface to access all WiMAX
  * devices from different vendors and provides a common API as well as
Signature · 1 line
1.5.6.5
#2 lore raw
Quoted 9 lines · David Miller

From: Inaky Perez-Gonzalez <[email protected]>
Date: Thu, 8 Jan 2009 12:50:27 -0800

Quoted 4 lines

Reported by Randy Dunlap from a warning in the v2.6.29 merge window tree as of 2009/1/8.

Applied, thanks.

Just sent an update with Randy's email address corrected, but other than that, it has zero changes (I had mistyped it to intel.com instead of oracle.com).

Thanks,

Signature · 1 line
Inaky
#3 lore raw

PATCH 1/1 wimax: fix kernel-doc for debufs_dentry member of struct wimax_dev [v2]

In reply to Inaky Perez-Gonzalez

Reported by Randy Dunlap from a warning in the v2.6.29 merge window tree as of 2009/1/8.

v2 fixes Randy Dunlap's email address.

---
 include/net/wimax.h |    3 +++
 1 files changed, 3 insertions(+), 0 deletions(-)
include/net/wimax.h +3 -0
index 1602614..073809c 100644
@@ -323,6 +323,9 @@ struct input_dev;
  *
  * @rf_hw: [private] State of the hardware radio switch (OFF/ON)
  *
+ * @debufs_dentry: [private] Used to hook up a debugfs entry. This
+ *     shows up in the debugfs root as wimax:DEVICENAME.
+ *
  * Description:
  * This structure defines a common interface to access all WiMAX
  * devices from different vendors and provides a common API as well as
Signature · 1 line
1.5.6.5
#4 lore raw

Re: [PATCH] wimax: fix kernel-doc for debufs_dentry member of struct wimax_dev [v2]

Quoted 16 lines · Inaky Perez-Gonzalez

Reported by Randy Dunlap from a warning in the v2.6.29 merge window tree as of 2009/1/8.

v2 fixes Randy Dunlap's email address.

---
 include/net/wimax.h |    3 +++
 1 files changed, 3 insertions(+), 0 deletions(-)
include/net/wimax.h +0 -0
index 1602614..073809c 100644

include/net/wimax.h struct input_dev; · line 327

Quoted 5 lines
include/net/wimax.h +2 -0
@@ -323,6 +323,9 @@ struct input_dev;
  *
  * @rf_hw: [private] State of the hardware radio switch (OFF/ON)
  *
+ * @debufs_dentry: [private] Used to hook up a debugfs entry. This
+ *     shows up in the debugfs root as wimax:DEVICENAME.

Inaky, this was supposed to be @debugfs_dentry. (typo)

Quoted 4 lines
include/net/wimax.h +1 -0
+ *
  * Description:
  * This structure defines a common interface to access all WiMAX
  * devices from different vendors and provides a common API as well as
Signature · 1 line
~Randy
#5 lore raw

Re: [PATCH] wimax: fix kernel-doc for debufs_dentry member of struct wimax_dev [v2]

Quoted 14 lines · Randy Dunlap

Inaky Perez-Gonzalez wrote:
...

include/net/wimax.h struct input_dev; · line 327

Quoted 10 lines
include/net/wimax.h +2 -0
index 1602614..073809c 100644
@@ -323,6 +323,9 @@ struct input_dev;
  *
  * @rf_hw: [private] State of the hardware radio switch (OFF/ON)
  *
+ * @debufs_dentry: [private] Used to hook up a debugfs entry. This
+ *     shows up in the debugfs root as wimax:DEVICENAME.

Inaky, this was supposed to be @debugfs_dentry. (typo)

Geeze, some days I really really really should not get out of bed and much less get anywhere near anything with keys, not even a calculator.

Fix available in
git://git.kernel.org/pub/scm/linux/kernel/git/inaky/wimax.git, patch coming.

Signature · 1 line
Inaky
#6 lore raw

PATCH 1/1 wimax: fix typo in kernel-doc for debugfs_dentry in struct wimax_dev

The kernel-doc was referring to member @debufs_dentry instead of @debugfs_dentry.

Reported by Randy Dunlap http://marc.info/?l=linux-netdev&m=123147942302885&w=2

As well, escape the colon in the field's text description, as it is causing the generated text to be erraticly broken up (with paragraphs moved down). Could not find a reason why it is happening so, even when other field descriptions use colons and work as expected.

---
 include/net/wimax.h |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)
include/net/wimax.h +2 -2
index 073809c..6b3824e 100644
@@ -323,8 +323,8 @@ struct input_dev;
  *
  * @rf_hw: [private] State of the hardware radio switch (OFF/ON)
  *
- * @debufs_dentry: [private] Used to hook up a debugfs entry. This
- *     shows up in the debugfs root as wimax:DEVICENAME.
+ * @debugfs_dentry: [private] Used to hook up a debugfs entry. This
+ *     shows up in the debugfs root as wimax\:DEVICENAME.
  *
  * Description:
  * This structure defines a common interface to access all WiMAX
Signature · 1 line
1.5.6.5
#7 lore raw

PATCH 1/1 wimax: fix typo in kernel-doc for debugfs_dentry in struct wimax_dev

In reply to Randy Dunlap

The kernel-doc was referring to member @debufs_dentry instead of @debugfs_dentry.

Reported by Randy Dunlap http://marc.info/?l=linux-netdev&m=123147942302885&w=2

As well, escape the colon in the field's text description, as it is causing the generated text to be erraticly broken up (with paragraphs moved down). Could not find a reason why it is happening so, even when other field descriptions use colons and work as expected.

---
 include/net/wimax.h |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)
include/net/wimax.h +2 -2
index 073809c..6b3824e 100644
@@ -323,8 +323,8 @@ struct input_dev;
  *
  * @rf_hw: [private] State of the hardware radio switch (OFF/ON)
  *
- * @debufs_dentry: [private] Used to hook up a debugfs entry. This
- *     shows up in the debugfs root as wimax:DEVICENAME.
+ * @debugfs_dentry: [private] Used to hook up a debugfs entry. This
+ *     shows up in the debugfs root as wimax\:DEVICENAME.
  *
  * Description:
  * This structure defines a common interface to access all WiMAX
Signature · 1 line
1.5.6.5
maintainer Applied
#8 lore raw

Re: [PATCH] wimax: fix typo in kernel-doc for debugfs_dentry in struct wimax_dev

From: Inaky Perez-Gonzalez <[email protected]>
Date: Fri, 9 Jan 2009 09:34:00 -0800

Quoted 11 lines

The kernel-doc was referring to member @debufs_dentry instead of @debugfs_dentry.

Reported by Randy Dunlap http://marc.info/?l=linux-netdev&m=123147942302885&w=2

As well, escape the colon in the field's text description, as it is causing the generated text to be erraticly broken up (with paragraphs moved down). Could not find a reason why it is happening so, even when other field descriptions use colons and work as expected.

Applied.