index.rst 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  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. Developer-oriented documentation
  21. --------------------------------
  22. The following manuals are written for *developers* of the U-Boot - those who
  23. want to contribute to U-Boot.
  24. .. toctree::
  25. :maxdepth: 2
  26. develop/index
  27. Unified Extensible Firmware (UEFI)
  28. ----------------------------------
  29. U-Boot provides an implementation of the UEFI API allowing to run UEFI
  30. compliant software like Linux, GRUB, and iPXE. Furthermore U-Boot itself
  31. can be run an UEFI payload.
  32. .. toctree::
  33. :maxdepth: 2
  34. uefi/index
  35. Driver-Model documentation
  36. --------------------------
  37. The following holds information on the U-Boot device driver framework:
  38. driver-model, including the design details of itself and several driver
  39. subsystems.
  40. .. toctree::
  41. :maxdepth: 2
  42. driver-model/index
  43. U-Boot API documentation
  44. ------------------------
  45. These books get into the details of how specific U-Boot subsystems work
  46. from the point of view of a U-Boot developer. Much of the information here
  47. is taken directly from the U-Boot source, with supplemental material added
  48. as needed (or at least as we managed to add it - probably *not* all that is
  49. needed).
  50. .. toctree::
  51. :maxdepth: 2
  52. api/index
  53. Architecture-specific doc
  54. -------------------------
  55. These books provide programming details about architecture-specific
  56. implementation.
  57. .. toctree::
  58. :maxdepth: 2
  59. arch/index
  60. Board-specific doc
  61. ------------------
  62. These books provide details about board-specific information. They are
  63. organized in a vendor subdirectory.
  64. .. toctree::
  65. :maxdepth: 2
  66. board/index
  67. Android-specific doc
  68. --------------------
  69. These books provide information about booting the Android OS from U-Boot,
  70. manipulating Android images from U-Boot shell and discusses other
  71. Android-specific features available in U-Boot.
  72. .. toctree::
  73. :maxdepth: 2
  74. android/index
  75. Indices and tables
  76. ==================
  77. * :ref:`genindex`