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

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

[Inaky Perez-Gonzalez]

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

Signed-off-by: Inaky Perez-Gonzalez <inaky@linux.intel.com>
Cc: Randy Dunlapy <randy.dunlap@intel.com>
---
 include/net/wimax.h |    3 +++
 1 files changed, 3 insertions(+), 0 deletions(-)

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

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

[David Miller]

From: Inaky Perez-Gonzalez <inaky@linux.intel.com>
Date: Thu,  8 Jan 2009 12:50:27 -0800

> Reported by Randy Dunlap from a warning in the v2.6.29 merge window
> tree as of 2009/1/8.
> 
> Signed-off-by: Inaky Perez-Gonzalez <inaky@linux.intel.com>

Applied, thanks.

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

[Inaky Perez-Gonzalez]

On Thursday 08 January 2009, David Miller wrote:
> From: Inaky Perez-Gonzalez <inaky@linux.intel.com>
> Date: Thu,  8 Jan 2009 12:50:27 -0800
>
> > Reported by Randy Dunlap from a warning in the v2.6.29 merge window
> > tree as of 2009/1/8.
> >
> > Signed-off-by: Inaky Perez-Gonzalez <inaky@linux.intel.com>
>
> 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,

-- 
Inaky

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

[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.

Signed-off-by: Inaky Perez-Gonzalez <inaky@linux.intel.com>
Cc: Randy Dunlap <randy.dunlap@oracle.com>
---
 include/net/wimax.h |    3 +++
 1 files changed, 3 insertions(+), 0 deletions(-)

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

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

[Randy Dunlap]

Inaky Perez-Gonzalez wrote:
> 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.
> 
> Signed-off-by: Inaky Perez-Gonzalez <inaky@linux.intel.com>
> Cc: Randy Dunlap <randy.dunlap@oracle.com>
> ---
>  include/net/wimax.h |    3 +++
>  1 files changed, 3 insertions(+), 0 deletions(-)
> 
> diff --git a/include/net/wimax.h b/include/net/wimax.h
> index 1602614..073809c 100644
> --- a/include/net/wimax.h
> +++ b/include/net/wimax.h
> @@ -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)

> + *
>   * Description:
>   * This structure defines a common interface to access all WiMAX
>   * devices from different vendors and provides a common API as well as


-- 
~Randy

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

[Inaky Perez-Gonzalez]

On Thursday 08 January 2009, Randy Dunlap wrote:
> Inaky Perez-Gonzalez wrote:
>...
> > diff --git a/include/net/wimax.h b/include/net/wimax.h
> > index 1602614..073809c 100644
> > --- a/include/net/wimax.h
> > +++ b/include/net/wimax.h
> > @@ -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.

-- 
Inaky

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

[Inaky Perez-Gonzalez]

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(-)

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
-- 
1.5.6.5

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

[Inaky Perez-Gonzalez]

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(-)

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
-- 
1.5.6.5

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

[David Miller]

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.