Patchwork wimax: fix typo in kernel-doc for debugfs_dentry in struct wimax_dev

login
register
mail settings
Submitter Inaky Perez-Gonzalez
Date Jan. 9, 2009, 5:34 p.m.
Message ID <1231522440-30059-1-git-send-email-inaky@linux.intel.com>
Download mbox | patch
Permalink /patch/17559/
State Accepted
Delegated to: David Miller
Headers show

Comments

Inaky Perez-Gonzalez - Jan. 9, 2009, 5:34 p.m.
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.

Signed-off-by: Inaky Perez-Gonzalez <inaky@linux.intel.com>
Cc: Randy Dunlap <randy.dunlap@oracle.com>
---
 include/net/wimax.h |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)
David Miller - Jan. 10, 2009, 7:09 a.m.
From: Inaky Perez-Gonzalez <inaky@linux.intel.com>
Date: Fri,  9 Jan 2009 09:34:00 -0800

> 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.
> 
> Signed-off-by: Inaky Perez-Gonzalez <inaky@linux.intel.com>

Applied.
--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch

diff --git a/include/net/wimax.h b/include/net/wimax.h
index 073809c..6b3824e 100644
--- a/include/net/wimax.h
+++ b/include/net/wimax.h
@@ -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