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.
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?
Yours,
Linus Walleij
ST-Ericsson SA
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 ***