]> git.dujemihanovic.xyz Git - u-boot.git/commit
doc: Replace DocBook with sphinx-based docs
authorMario Six <mario.six@gdsys.cc>
Tue, 10 Jul 2018 06:40:17 +0000 (08:40 +0200)
committerTom Rini <trini@konsulko.com>
Mon, 23 Jul 2018 18:33:21 +0000 (14:33 -0400)
commit78a88f7930becb78afef09c1237a8e4edc1b01e1
treeb4c1d5c08749423c742f2c1bb43d1be0704bc0a5
parent5448ff33f281cc4832395109c53effc7593bbfeb
doc: Replace DocBook with sphinx-based docs

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, 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@gdsys.cc>
26 files changed:
Documentation/.gitignore [new file with mode: 0644]
Documentation/Makefile [new file with mode: 0644]
Documentation/conf.py [new file with mode: 0644]
Documentation/index.rst [new file with mode: 0644]
Documentation/media/Makefile [new file with mode: 0644]
Documentation/media/linker_lists.h.rst.exceptions [new file with mode: 0644]
Documentation/sphinx-static/theme_overrides.css [new file with mode: 0644]
Documentation/sphinx/cdomain.py [new file with mode: 0644]
Documentation/sphinx/kernel_include.py [new file with mode: 0755]
Documentation/sphinx/kerneldoc.py [new file with mode: 0644]
Documentation/sphinx/kfigure.py [new file with mode: 0644]
Documentation/sphinx/load_config.py [new file with mode: 0644]
Documentation/sphinx/parse-headers.pl [new file with mode: 0755]
Documentation/sphinx/requirements.txt [new file with mode: 0644]
Documentation/sphinx/rstFlatTable.py [new file with mode: 0755]
Makefile
doc/DocBook/.gitignore [deleted file]
doc/DocBook/Makefile [deleted file]
doc/DocBook/docbook.css [deleted file]
doc/DocBook/efi.tmpl [deleted file]
doc/DocBook/linker_lists.tmpl [deleted file]
doc/DocBook/stdio.tmpl [deleted file]
doc/DocBook/stylesheet.xsl [deleted file]
include/linker_lists.h
lib/efi_loader/efi_boottime.c
scripts/kernel-doc