index.rst 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. .. SPDX-License-Identifier: GPL-2.0+
  2. .. _u-boot_doc:
  3. The U-Boot Documentation
  4. ========================
  5. This is the top level of the U-Boot's documentation tree. U-Boot
  6. documentation, like the U-Boot itself, is very much a work in progress;
  7. that is especially true as we work to integrate our many scattered
  8. documents into a coherent whole. Please note that improvements to the
  9. documentation are welcome; join the U-Boot list at http://lists.denx.de
  10. if you want to help out.
  11. .. toctree::
  12. :maxdepth: 2
  13. User-oriented documentation
  14. ---------------------------
  15. The following manuals are written for *users* of the U-Boot - those who are
  16. trying to get it to work optimally on a given system.
  17. .. toctree::
  18. :maxdepth: 2
  19. build/index
  20. usage/index
  21. Developer-oriented documentation
  22. --------------------------------
  23. The following manuals are written for *developers* of the U-Boot - those who
  24. want to contribute to U-Boot.
  25. .. toctree::
  26. :maxdepth: 2
  27. develop/index
  28. Unified Extensible Firmware (UEFI)
  29. ----------------------------------
  30. U-Boot provides an implementation of the UEFI API allowing to run UEFI
  31. compliant software like Linux, GRUB, and iPXE. Furthermore U-Boot itself
  32. can be run an UEFI payload.
  33. .. toctree::
  34. :maxdepth: 2
  35. uefi/index
  36. Driver-Model documentation
  37. --------------------------
  38. The following holds information on the U-Boot device driver framework:
  39. driver-model, including the design details of itself and several driver
  40. subsystems.
  41. .. toctree::
  42. :maxdepth: 2
  43. driver-model/index
  44. U-Boot API documentation
  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. .. toctree::
  52. :maxdepth: 2
  53. api/index
  54. Architecture-specific doc
  55. -------------------------
  56. These books provide programming details about architecture-specific
  57. implementation.
  58. .. toctree::
  59. :maxdepth: 2
  60. arch/index
  61. Board-specific doc
  62. ------------------
  63. These books provide details about board-specific information. They are
  64. organized in a vendor subdirectory.
  65. .. toctree::
  66. :maxdepth: 2
  67. board/index
  68. Android-specific doc
  69. --------------------
  70. These books provide information about booting the Android OS from U-Boot,
  71. manipulating Android images from U-Boot shell and discusses other
  72. Android-specific features available in U-Boot.
  73. .. toctree::
  74. :maxdepth: 2
  75. android/index
  76. Indices and tables
  77. ==================
  78. * :ref:`genindex`