[U-Boot] [PATCH RFC] doc: Replace DocBook with sphinx-based docs

Tom Rini trini at konsulko.com
Mon Jun 18 19:04:50 UTC 2018


On Thu, Jun 14, 2018 at 10:44:53AM +0200, Mario Six wrote:

> The Linux kernel moved to sphinx-based documentation and got rid of the
> DocBook based documentation quite a while ago. Hence, the DocBook
> documentation for U-Boot should be converted as well.
> 
> To achieve this, import the necessary files from Linux v4.17-r6, and
> convert the current DocBook documentation (three files altogether) to
> sphinx/reStructuredText.
> 
> For now, all old DocBook documentation was merged into a single
> handbook, tentatively named "U-Boot Hacker Manual".
> 
> For some source files, the documentation style was changed to comply
> with kernel-doc; no functional changes were applied.
> 
> Signed-off-by: Mario Six <mario.six at gdsys.cc>

I like this idea, thanks for doing it.  While I wish more stuff was done
for DocBook, and rST isn't my favorite style, it's worth I think
strongly considering the switch to as I expect some of my own usage
issues to be better by now or be addressed sooner rather than later as
more people pick up the tools, find problems, and fix them.

-- 
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20180618/8ed2b8f8/attachment.sig>


More information about the U-Boot mailing list