123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101 |
- .. SPDX-License-Identifier: GPL-2.0+
- .. _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
- 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
- usage/index
- 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
- 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).
- .. toctree::
- :maxdepth: 2
- api/index
- Architecture-specific doc
- -------------------------
- These books provide programming details about architecture-specific
- implementation.
- .. toctree::
- :maxdepth: 2
- arch/index
- Board-specific doc
- ------------------
- These books provide details about board-specific information. They are
- organized in a vendor subdirectory.
- .. toctree::
- :maxdepth: 2
- board/index
- 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
- Chromium OS-specific doc
- ------------------------
- .. toctree::
- :maxdepth: 2
- chromium/index
- Indices and tables
- ==================
- * :ref:`genindex`
|