From: Randy Dunlap <rdunlap@xenotime.net>
To: linux-fbdev@vger.kernel.org
Subject: Re: Documentation in Documentation/DocBook
Date: Wed, 05 May 2010 17:48:57 +0000 [thread overview]
Message-ID: <20100505104857.0b018d0e.rdunlap@xenotime.net> (raw)
In-Reply-To: <CEE6BB42CAD6E947908279175AF8470A025A636CED@EXDCVYMBSTM006.EQ1STM.local>
On Tue, 4 May 2010 16:41:30 +0200 Linus WALLEIJ wrote:
> Hi,
>
> we're developing a framebuffer driver for the
> ST-Ericsson U8500.
>
> We really like formatted documentation so we put
> that in DocBook format in Documentation/DocBook/*.
> This has the upside that it's easy to include
> Kerneldoc headers etc into the documentation.
Yes, that's a good advantage.
> However most of the FB documentation up to now
> is in Documentation/fb/*.
>
> What is best for the FB subsystem: some nice
> Kerneldoc or a regular textfile?
Hi,
If the documentation needs pretty formatting, then use docbook.
If plain text is sufficient, then just use that.
In the end, I would just do whichever you are more comfortable with.
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
prev parent reply other threads:[~2010-05-05 17:48 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-05-04 14:41 Documentation in Documentation/DocBook Linus WALLEIJ
2010-05-05 17:48 ` Randy Dunlap [this message]
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=20100505104857.0b018d0e.rdunlap@xenotime.net \
--to=rdunlap@xenotime.net \
--cc=linux-fbdev@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;
as well as URLs for NNTP newsgroup(s).