diff options
author | Randy Dunlap <randy.dunlap@oracle.com> | 2007-10-16 23:31:20 -0700 |
---|---|---|
committer | Linus Torvalds <torvalds@woody.linux-foundation.org> | 2007-10-17 08:43:05 -0700 |
commit | 6b5b55f6c404fa730a09a8254eb19f5a038afcc2 (patch) | |
tree | 7d8398dbe550f13dcd2c6fb8116dc7393bfd2f2b /Documentation/sparse.txt | |
parent | 51448e2ad72c3cdb50e4118edc47fbcbcc1d03d3 (diff) | |
download | blackbird-obmc-linux-6b5b55f6c404fa730a09a8254eb19f5a038afcc2.tar.gz blackbird-obmc-linux-6b5b55f6c404fa730a09a8254eb19f5a038afcc2.zip |
kernel-doc: fix doc blocks and html
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.
However, that left a problem with <p> ($blankline_html) being processed
thru xml_escape(), converting it to <p>, which isn't good for the
generated html output (the <p> should remain unchanged), so this patch also
introduces the notion of "local" kernel-doc meta-characters
('\\\\mnemonic:'), which are converted to html just before writing the
stream to its output file.
Please report any problems that you (anyone) see in "highlighting" in any
output mode (text, man, html, xml).
Also update copyright to include me.
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Cc: Johannes Berg <johannes@sipsolutions.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'Documentation/sparse.txt')
0 files changed, 0 insertions, 0 deletions