1.. SPDX-License-Identifier: GPL-2.0+
2
3.. _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
17
18User-oriented documentation
19---------------------------
20
21The following manuals are written for *users* of the U-Boot - those who are
22trying to get it to work optimally on a given system.
23
24.. toctree::
25   :maxdepth: 2
26
27   build/index
28   usage/index
29
30Developer-oriented documentation
31--------------------------------
32
33The following manuals are written for *developers* of the U-Boot - those who
34want to contribute to U-Boot.
35
36.. toctree::
37   :maxdepth: 2
38
39   develop/index
40
41
42U-Boot API documentation
43------------------------
44
45These books get into the details of how specific U-Boot subsystems work
46from the point of view of a U-Boot developer.  Much of the information here
47is taken directly from the U-Boot source, with supplemental material added
48as needed (or at least as we managed to add it - probably *not* all that is
49needed).
50
51.. toctree::
52   :maxdepth: 2
53
54   api/index
55
56Architecture-specific doc
57-------------------------
58
59These books provide programming details about architecture-specific
60implementation.
61
62.. toctree::
63   :maxdepth: 2
64
65   arch/index
66
67Board-specific doc
68------------------
69
70These books provide details about board-specific information. They are
71organized in a vendor subdirectory.
72
73.. toctree::
74   :maxdepth: 2
75
76   board/index
77
78Android-specific doc
79--------------------
80
81These books provide information about booting the Android OS from U-Boot,
82manipulating Android images from U-Boot shell and discusses other
83Android-specific features available in U-Boot.
84
85.. toctree::
86   :maxdepth: 2
87
88   android/index
89
90Chromium OS-specific doc
91------------------------
92
93.. toctree::
94   :maxdepth: 2
95
96   chromium/index
97
98Indices and tables
99==================
100
101* :ref:`genindex`
102