blob: 3500e68556b9e10cb8496676410561c749692ae5 [file] [log] [blame]
Heinrich Schuchardt04459782018-07-29 13:45:47 +02001.. SPDX-License-Identifier: GPL-2.0+
Mario Six78a88f72018-07-10 08:40:17 +02002
Bin Mengf0e608b2019-07-18 00:33:47 -07003.. _u-boot_doc:
4
5The U-Boot Documentation
6========================
7
8This is the top level of the U-Boot's documentation tree. U-Boot
9documentation, like the U-Boot itself, is very much a work in progress;
10that is especially true as we work to integrate our many scattered
11documents into a coherent whole. Please note that improvements to the
12documentation are welcome; join the U-Boot list at http://lists.denx.de
13if you want to help out.
14
15.. toctree::
16 :maxdepth: 2
Mario Six78a88f72018-07-10 08:40:17 +020017
Bin Mengc8fe9162019-07-18 00:33:46 -070018U-Boot API documentation
19------------------------
Mario Six78a88f72018-07-10 08:40:17 +020020
Bin Mengc8fe9162019-07-18 00:33:46 -070021These books get into the details of how specific U-Boot subsystems work
22from the point of view of a U-Boot developer. Much of the information here
23is taken directly from the U-Boot source, with supplemental material added
24as needed (or at least as we managed to add it - probably *not* all that is
25needed).
26
27.. toctree::
28 :maxdepth: 2
29
30 api/index
Bin Mengf0e608b2019-07-18 00:33:47 -070031
32Indices and tables
33==================
34
35* :ref:`genindex`