All of lore.kernel.org
 help / color / mirror / Atom feed
From: Inaky Perez-Gonzalez <inaky@linux.intel.com>
To: wimax@linuxwimax.org, netdev@vger.kernel.org
Cc: Randy Dunlap <randy.dunlap@oracle.com>
Subject: [PATCH] wimax: fix typo in kernel-doc for debugfs_dentry in struct wimax_dev
Date: Fri,  9 Jan 2009 09:34:00 -0800	[thread overview]
Message-ID: <1231522440-30059-1-git-send-email-inaky@linux.intel.com> (raw)
In-Reply-To: <4966E268.20101@oracle.com>

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

  parent reply	other threads:[~2009-01-09 17:34 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-01-08 20:50 [PATCH] wimax: fix kernel-doc for debufs_dentry member of struct wimax_dev Inaky Perez-Gonzalez
2009-01-08 20:57 ` David Miller
2009-01-08 21:02   ` Inaky Perez-Gonzalez
2009-01-08 20:59 ` [PATCH] wimax: fix kernel-doc for debufs_dentry member of struct wimax_dev [v2] Inaky Perez-Gonzalez
2009-01-09  5:36   ` Randy Dunlap
2009-01-09  7:23     ` Inaky Perez-Gonzalez
2009-01-09  8:41       ` [PATCH] wimax: fix typo in kernel-doc for debugfs_dentry in struct wimax_dev Inaky Perez-Gonzalez
2009-01-09 17:34     ` Inaky Perez-Gonzalez [this message]
2009-01-10  7:09       ` David Miller

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1231522440-30059-1-git-send-email-inaky@linux.intel.com \
    --to=inaky@linux.intel.com \
    --cc=netdev@vger.kernel.org \
    --cc=randy.dunlap@oracle.com \
    --cc=wimax@linuxwimax.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.