Re: Documentation in Documentation/DocBook

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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 ***
--
To unsubscribe from this list: send the line "unsubscribe linux-fbdev" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[Index of Archives]     [Video for Linux]     [Linux USB Devel]     [Linux Audio Users]     [Yosemite Tourism]     [Linux Kernel]     [Linux SCSI]

  Powered by Linux