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