blob: 57b42c68e44d7328f6355461393fc70c614f7c4b [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 Meng7114d892019-10-27 05:19:45 -070018User-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
Simon Glass8ad7cfe2023-02-05 15:30:52 -070028 learn/index
Heinrich Schuchardtd2472de2020-12-12 08:50:37 +010029 usage/index
Bin Meng7114d892019-10-27 05:19:45 -070030
Heinrich Schuchardt932b8f82020-04-24 23:31:20 +020031Developer-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
Bin Mengd9756c42019-07-18 00:33:48 -070042
Bin Mengc8fe9162019-07-18 00:33:46 -070043U-Boot API documentation
44------------------------
Mario Six78a88f72018-07-10 08:40:17 +020045
Bin Mengc8fe9162019-07-18 00:33:46 -070046These 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
Bin Mengf0e608b2019-07-18 00:33:47 -070056
Bin Mengd8381382019-07-18 00:34:02 -070057Architecture-specific doc
58-------------------------
59
60These books provide programming details about architecture-specific
61implementation.
62
63.. toctree::
64 :maxdepth: 2
65
66 arch/index
67
Bin Meng428c3f52019-07-18 00:34:04 -070068Board-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
Sam Protsenko586a1bf2020-01-24 17:53:44 +020079Android-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
Simon Glass2d0423a2021-03-15 18:11:20 +130091Chromium OS-specific doc
92------------------------
93
94.. toctree::
95 :maxdepth: 2
96
97 chromium/index
98
Bin Mengf0e608b2019-07-18 00:33:47 -070099Indices and tables
100==================
101
102* :ref:`genindex`