From: Stephen Hemminger <shemminger@linux-foundation.org>
To: linux-kernel@vger.kernel.org
Subject: Documentation files in html format?
Date: Thu, 9 Aug 2007 11:31:22 +0100 [thread overview]
Message-ID: <20070809113122.3aa508e4@oldman.hamilton.local> (raw)
Since the network device documentation needs a rewrite, I was thinking
of using basic html format instead of just plain text. But since this would
be starting an new precedent for kernel documentation, some it seemed
like a worthwhile topic for discussion.
Advantages of html:
* basic formatting like lists, italics, etc
* easier to integrate into other places and retain formatting
* ability to link documents and to external sources easier
Downsides:
* can become too formatted and unclear
* accessibility and translation issues?
* even more style issues
next reply other threads:[~2007-08-09 10:30 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-08-09 10:31 Stephen Hemminger [this message]
2007-08-09 10:49 ` Documentation files in html format? Jan Engelhardt
2007-08-09 13:08 ` Hans-Jürgen Koch
2007-08-09 13:22 ` Stephen Hemminger
2007-08-09 15:26 ` Andi Kleen
2007-08-09 14:37 ` Rene Herman
2007-08-09 15:15 ` Jarek Poplawski
2007-08-09 19:10 ` Francois Romieu
2007-08-09 19:30 ` Andi Kleen
2007-08-09 22:27 ` Francois Romieu
2007-08-10 0:15 ` Rene Herman
2007-08-10 7:40 ` Sam Ravnborg
2007-08-10 13:52 ` Stefan Richter
2007-08-10 20:12 ` Sam Ravnborg
2007-08-10 23:27 ` Rene Herman
2007-08-11 6:31 ` Stefan Richter
2007-08-11 19:12 ` Rene Herman
2007-08-11 15:53 ` Jan Engelhardt
2007-08-11 22:55 ` Randy Dunlap
2007-08-12 3:11 ` Randy Dunlap
2007-08-12 3:27 ` Sam Ravnborg
2007-09-01 18:39 ` Oleg Verych
2007-08-09 17:56 ` Bob Copeland
2007-08-09 19:14 ` Stefan Richter
2007-08-09 19:58 ` Brennan Ashton
2007-08-09 20:03 ` Jesper Juhl
2007-08-09 20:08 ` Jan Engelhardt
2007-08-10 20:17 ` Willy Tarreau
2007-08-10 20:40 ` J. Bruce Fields
2007-08-10 20:51 ` Willy Tarreau
2007-08-10 23:08 ` Sam Ravnborg
2007-08-11 5:33 ` Willy Tarreau
2007-08-11 14:19 ` J. Bruce Fields
2007-08-11 14:17 ` Willy Tarreau
2007-08-11 23:00 ` Randy Dunlap
2007-08-12 3:12 ` Randy Dunlap
2007-08-12 13:10 ` Stefan Richter
2007-08-12 15:43 ` Sam Ravnborg
2007-08-12 18:25 ` Stefan Richter
2007-08-11 23:12 ` Randy Dunlap
2007-08-12 3:12 ` Randy Dunlap
[not found] <8QdB3-87O-7@gated-at.bofh.it>
[not found] ` <8QdUr-5j-11@gated-at.bofh.it>
2007-08-09 12:34 ` Bodo Eggert
2007-08-09 12:41 ` Jan Engelhardt
2007-08-09 13:29 ` Bodo Eggert
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=20070809113122.3aa508e4@oldman.hamilton.local \
--to=shemminger@linux-foundation.org \
--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