projects / J-u-boot.git / blame
| Commit | Line | Data |
|---|---|---|
| 04459788 | 1 | .. SPDX-License-Identifier: GPL-2.0+ |
| 78a88f79 | 2 | |
| f0e608bc BM |
3 | .. _u-boot_doc: |
| 4 | ||
| 5 | The U-Boot Documentation | |
| 6 | ======================== | |
| 7 | ||
| 8 | This is the top level of the U-Boot's documentation tree. U-Boot | |
| 9 | documentation, like the U-Boot itself, is very much a work in progress; | |
| 10 | that is especially true as we work to integrate our many scattered | |
| 11 | documents into a coherent whole. Please note that improvements to the | |
| 12 | documentation are welcome; join the U-Boot list at http://lists.denx.de | |
| 13 | if you want to help out. | |
| 14 | ||
| 15 | .. toctree:: | |
| 16 | :maxdepth: 2 | |
| 78a88f79 | 17 | |
| 7114d89e BM |
18 | User-oriented documentation |
| 19 | --------------------------- | |
| 20 | ||
| 21 | The following manuals are written for *users* of the U-Boot - those who are | |
| 22 | trying to get it to work optimally on a given system. | |
| 23 | ||
| 24 | .. toctree:: | |
| 25 | :maxdepth: 2 | |
| 26 | ||
| 27 | build/index | |
| 8ad7cfec | 28 | learn/index |
| d2472ded | 29 | usage/index |
| 7114d89e | 30 | |
| 932b8f8c HS |
31 | Developer-oriented documentation |
| 32 | -------------------------------- | |
| 33 | ||
| 34 | The following manuals are written for *developers* of the U-Boot - those who | |
| 35 | want to contribute to U-Boot. | |
| 36 | ||
| 37 | .. toctree:: | |
| 38 | :maxdepth: 2 | |
| 39 | ||
| 40 | develop/index | |
| 41 | ||
| d9756c41 | 42 | |
| c8fe916c BM |
43 | U-Boot API documentation |
| 44 | ------------------------ | |
| 45 | ||
| 46 | These books get into the details of how specific U-Boot subsystems work | |
| 47 | from the point of view of a U-Boot developer. Much of the information here | |
| 48 | is taken directly from the U-Boot source, with supplemental material added | |
| 49 | as needed (or at least as we managed to add it - probably *not* all that is | |
| 50 | needed). | |
| 51 | ||
| 04459788 | 52 | .. toctree:: |
| c8fe916c | 53 | :maxdepth: 2 |
| 78a88f79 | 54 | |
| c8fe916c | 55 | api/index |
| f0e608bc | 56 | |
| d8381386 BM |
57 | Architecture-specific doc |
| 58 | ------------------------- | |
| 59 | ||
| 60 | These books provide programming details about architecture-specific | |
| 61 | implementation. | |
| 62 | ||
| 63 | .. toctree:: | |
| 64 | :maxdepth: 2 | |
| 65 | ||
| 66 | arch/index | |
| 67 | ||
| 428c3f55 BM |
68 | Board-specific doc |
| 69 | ------------------ | |
| 70 | ||
| 71 | These books provide details about board-specific information. They are | |
| 72 | organized in a vendor subdirectory. | |
| 73 | ||
| 74 | .. toctree:: | |
| 75 | :maxdepth: 2 | |
| 76 | ||
| 77 | board/index | |
| 78 | ||
| 586a1bf5 SP |
79 | Android-specific doc |
| 80 | -------------------- | |
| 81 | ||
| 82 | These books provide information about booting the Android OS from U-Boot, | |
| 83 | manipulating Android images from U-Boot shell and discusses other | |
| 84 | Android-specific features available in U-Boot. | |
| 85 | ||
| 86 | .. toctree:: | |
| 87 | :maxdepth: 2 | |
| 88 | ||
| 89 | android/index | |
| 90 | ||
| 2d0423af SG |
91 | Chromium OS-specific doc |
| 92 | ------------------------ | |
| 93 | ||
| 94 | .. toctree:: | |
| 95 | :maxdepth: 2 | |
| 96 | ||
| 97 | chromium/index | |
| 98 | ||
| f0e608bc BM |
99 | Indices and tables |
| 100 | ================== | |
| 101 | ||
| 93d1721b HS |
102 | .. toctree:: |
| 103 | :maxdepth: 1 | |
| 104 | ||
| 105 | genindex |