From: Randy Dunlap <randy.dunlap@oracle.com>
To: lkml <linux-kernel@vger.kernel.org>
Cc: johannes@sipsolutions.net, akpm <akpm@linux-foundation.org>
Subject: Re: kernel-doc: fix doc blocks and html
Date: Fri, 31 Aug 2007 21:06:43 -0700 [thread overview]
Message-ID: <20070831210643.d5e2b5b1.randy.dunlap@oracle.com> (raw)
In-Reply-To: <20070831205845.0a935dc5.randy.dunlap@oracle.com>
On Fri, 31 Aug 2007 20:58:45 -0700 Randy Dunlap wrote:
> From: Randy Dunlap <randy.dunlap@oracle.com>
>
> Cc: johannes@sipsolutions.net
>
> Johannes Berg reports (Thanks!) that &struct names are not highlighted in
> html output format when they are inside a DOC: block.
>
> DOC: blocks were not escaped thru xml_escape() like other kernel-doc
> comments were. Fixed that.
Johannes is using a feature of kernel-doc that I wasn't even familiar
with, also one that no one else is using. I'm sure that Johannes can
point us to some source code and generated output for it though.
If you want to see a little of it in source code form, 2 net drivers
use it, but then they aren't processed by kernel-doc for generated
output. They are drivers/net/3c501.c & 3c527.c. Look for the
"DOC:" comment blocks.
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
next prev parent reply other threads:[~2007-09-01 4:09 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-09-01 3:58 [PATCH/RFC] " Randy Dunlap
2007-09-01 4:06 ` Randy Dunlap [this message]
2007-09-01 9:14 ` Johannes Berg
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=20070831210643.d5e2b5b1.randy.dunlap@oracle.com \
--to=randy.dunlap@oracle.com \
--cc=akpm@linux-foundation.org \
--cc=johannes@sipsolutions.net \
--cc=linux-kernel@vger.kernel.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®