Mirrors/u-boot
2
0
Fork 0
mirror of https://github.com/AsahiLinux/u-boot synced 2024-12-01 00:49:43 +00:00
Code Issues Projects Releases Packages Wiki Activity
u-boot/doc/index.rst

103 lines
2.2 KiB
ReStructuredText
Raw Permalink Normal View History

doc: add structure to Sphinx generated docs Create separate html pages for linker lists, the serial subsystem, and the EFI subsystem. Add a table of content. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2018-07-29 11:45:47 +00:00
.. SPDX-License-Identifier: GPL-2.0+
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>
2018-07-10 06:40:17 +00:00
doc: Add top-level description about U-Boot documentation This updates the index.rst to add top-level description about U-Boot documentation. Words are taken from Linux kernel docs and modified for U-Boot. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2019-07-18 07:33:47 +00:00
.. _u-boot_doc:
The U-Boot Documentation
========================
This is the top level of the U-Boot's documentation tree. U-Boot
documentation, like the U-Boot itself, is very much a work in progress;
that is especially true as we work to integrate our many scattered
documents into a coherent whole. Please note that improvements to the
documentation are welcome; join the U-Boot list at http://lists.denx.de
if you want to help out.
.. toctree::
:maxdepth: 2
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>
2018-07-10 06:40:17 +00:00
doc: Add documentation for how to build U-Boot host tools This adds a reST document for how to build U-Boot host tools, including information for both Linux and Windows. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-10-27 12:19:45 +00:00
User-oriented documentation
---------------------------
The following manuals are written for *users* of the U-Boot - those who are
trying to get it to work optimally on a given system.
.. toctree::
:maxdepth: 2
build/index
doc: Link to some useful talks Talks are a great way to learn about U-Boot and have been lost now that the Denx Wiki has gone away. These are stored at elinux.org so link to that . Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Sean Anderson <seanga2@gmail.com>
2023-02-05 22:30:52 +00:00
learn/index
doc: move pstore.rst to usage/pstore.rst Let's have a separate chapter dedicated to using U-Boot. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-12-12 07:50:37 +00:00
usage/index
doc: Add documentation for how to build U-Boot host tools This adds a reST document for how to build U-Boot host tools, including information for both Linux and Windows. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-10-27 12:19:45 +00:00
doc: describe the analysis of crash dumps Provide an overview of the analysis of U-Boot crash dumps. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Acked-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
2020-04-24 21:31:20 +00:00
Developer-oriented documentation
--------------------------------
The following manuals are written for *developers* of the U-Boot - those who
want to contribute to U-Boot.
.. toctree::
:maxdepth: 2
develop/index
doc: Add driver-model to Sphinx TOC tree Add index.rst for driver model. More docs will be added later. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glkpk@gmx.de>
2019-07-18 07:33:48 +00:00
doc: Move existing rst files into api sub-directory Currently the Sphinx doc only contains API descriptions of several U-Boot subsystems. For future extension, group these existing docs into an API sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2019-07-18 07:33:46 +00:00
U-Boot API documentation
------------------------
These books get into the details of how specific U-Boot subsystems work
from the point of view of a U-Boot developer. Much of the information here
is taken directly from the U-Boot source, with supplemental material added
as needed (or at least as we managed to add it - probably *not* all that is
needed).
doc: add structure to Sphinx generated docs Create separate html pages for linker lists, the serial subsystem, and the EFI subsystem. Add a table of content. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2018-07-29 11:45:47 +00:00
.. toctree::
doc: Move existing rst files into api sub-directory Currently the Sphinx doc only contains API descriptions of several U-Boot subsystems. For future extension, group these existing docs into an API sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2019-07-18 07:33:46 +00:00
:maxdepth: 2
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>
2018-07-10 06:40:17 +00:00
doc: Move existing rst files into api sub-directory Currently the Sphinx doc only contains API descriptions of several U-Boot subsystems. For future extension, group these existing docs into an API sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2019-07-18 07:33:46 +00:00
api/index
doc: Add top-level description about U-Boot documentation This updates the index.rst to add top-level description about U-Boot documentation. Words are taken from Linux kernel docs and modified for U-Boot. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2019-07-18 07:33:47 +00:00
doc: Add architecture specific info to Sphinx TOC tree Add index.rst for architecture specific info. More docs will be added later. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2019-07-18 07:34:02 +00:00
Architecture-specific doc
-------------------------
These books provide programming details about architecture-specific
implementation.
.. toctree::
:maxdepth: 2
arch/index
doc: Add board specific info to Sphinx TOC tree Add index.rst for board. More docs will be added later. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2019-07-18 07:34:04 +00:00
Board-specific doc
------------------
These books provide details about board-specific information. They are
organized in a vendor subdirectory.
.. toctree::
:maxdepth: 2
board/index
doc: android: Convert to Sphinx format Convert Android documentation from regular txt format to Sphinx (RST). Also add Android index.rst file and reference it in root index.rst, so that Android documentation is visible. Test: $ make htmldocs $ xdg-open doc/output/index.html Signed-off-by: Sam Protsenko <joe.skb7@gmail.com> Signed-off-by: Lokesh Vutla <lokeshvutla@ti.com>
2020-01-24 15:53:44 +00:00
Android-specific doc
--------------------
These books provide information about booting the Android OS from U-Boot,
manipulating Android images from U-Boot shell and discusses other
Android-specific features available in U-Boot.
.. toctree::
:maxdepth: 2
android/index
doc: Convert Chromium OS docs to rst Move this documentation over to reST. Move the example files into a files/ directory so they are still separate. Do a few minor updates while we are here: - Tidy up sandbox build instructions - Update my github account name - Add some talks and links Signed-off-by: Simon Glass <sjg@chromium.org>
2021-03-15 05:11:20 +00:00
Chromium OS-specific doc
------------------------
.. toctree::
:maxdepth: 2
chromium/index
doc: Add top-level description about U-Boot documentation This updates the index.rst to add top-level description about U-Boot documentation. Words are taken from Linux kernel docs and modified for U-Boot. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2019-07-18 07:33:47 +00:00
Indices and tables
==================
* :ref:`genindex`
Reference in a new issue Copy permalink