From: "Yoshinori K. Okuji" <okuji@enbug.org>
To: The development of GRUB 2 <grub-devel@gnu.org>
Subject: Re: Documentation.
Date: Fri, 25 Jun 2004 00:03:53 +0200 [thread overview]
Message-ID: <200406250003.53439.okuji@enbug.org> (raw)
In-Reply-To: <20040624171029.GA19940@artax.karlin.mff.cuni.cz>
On Thursday 24 June 2004 19:10, Tomas Ebenlendr wrote:
> So here is the question: what format? (and what names?).
Use plain text. It's good enough for this purpose. If you need a more
complex one, use texinfo. Texinfo is the standard documentation tool
for GNU, and many GNU programmers are used to it.
Regardless of whatever tool you use, the most important thing in
documentation is "not to make it out of dated". This is really
difficult. Indeed, I gave up keeping information on internals of GRUB
Legacy in the manual. Maintaining good documentation costs the same as
maintaining good code. So, I'd recommend that you keep your
documentation as simple as you can.
Okuji
next prev parent reply other threads:[~2004-06-24 22:01 UTC|newest]
Thread overview: 50+ messages / expand[flat|nested] mbox.gz Atom feed top
2004-06-24 17:10 Documentation Tomas Ebenlendr
2004-06-24 22:03 ` Yoshinori K. Okuji [this message]
2004-06-25 13:17 ` Documentation Jeroen Dekkers
2004-06-26 15:05 ` Documentation Yoshinori K. Okuji
-- strict thread matches above, loose matches on Subject: below --
2020-06-06 17:09 Documentation G.W. Haywood
2020-06-07 21:23 ` Documentation Pablo Neira Ayuso
2020-06-10 12:55 ` Documentation G.W. Haywood
2017-03-27 5:53 documentation Julia Lawall
2011-04-13 23:33 Documentation Eugene Shatsky
2011-04-14 4:44 ` Documentation Jonáš Vidra
2011-04-14 13:54 ` Documentation Edward Shishkin
2011-01-31 21:39 documentation Roberto Spadim
2011-01-31 21:43 ` documentation Mathias Burén
2011-01-31 21:58 ` documentation NeilBrown
2011-01-31 22:14 ` documentation Roberto Spadim
2011-02-01 9:37 ` documentation hansbkk
2011-02-01 13:49 ` documentation Roberto Spadim
2010-12-01 18:00 Documentation David Lambert
2010-12-01 18:06 ` Documentation Stefan Schmidt
2010-12-01 18:39 ` Documentation David Lambert
2010-12-01 18:54 ` Documentation Stefan Schmidt
2010-12-01 22:46 ` Documentation Robert Foerster
2010-12-02 20:37 ` Documentation David Lambert
2010-12-02 20:52 ` Documentation Robert Foerster
2010-12-03 7:35 ` Documentation Christophe Aeschlimann
2010-03-14 0:17 Documentation Giuseppe Macrì
2006-02-10 8:20 Documentation Nico -telmich- Schottelius
2005-10-24 19:05 Documentation Vagin Andrey S.
2004-05-27 13:12 Documentation Alexander E. Patrakov
2004-05-28 23:25 ` Documentation Greg KH
2004-06-02 6:11 ` Documentation Niko Sauer
2004-05-15 14:28 Documentation Jody
2004-05-17 13:35 ` Documentation Andrey Romanenko
2004-05-17 13:40 ` Documentation Miguel Bolanos
2003-06-06 13:20 Documentation Matthew Wilcox
2002-08-29 9:39 documentation vandana mehtani
2002-08-29 15:46 ` documentation Dave Wilhardt
2002-04-24 14:26 documentation Guilhem Tardy
2002-04-24 16:58 ` documentation Takashi Iwai
2002-04-24 19:32 ` documentation Guilhem Tardy
2002-04-26 17:54 ` documentation Takashi Iwai
2002-05-03 16:11 ` documentation Guilhem Tardy
2002-05-03 16:22 ` documentation Paul Davis
2002-05-03 16:28 ` documentation Takashi Iwai
2002-03-22 15:32 Documentation Gopakumar.C.E
2002-03-30 7:42 ` Documentation Ralf Baechle
2002-02-02 9:18 Documentation Guillaume Chamberland-Larose
2002-02-02 10:39 ` Documentation Yven J. Leist
2002-02-05 18:18 ` Documentation Randy.Dunlap
2001-11-15 18:03 Documentation war
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=200406250003.53439.okuji@enbug.org \
--to=okuji@enbug.org \
--cc=grub-devel@gnu.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.