index.rst 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  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. U-Boot API documentation
  29. ------------------------
  30. These books get into the details of how specific U-Boot subsystems work
  31. from the point of view of a U-Boot developer. Much of the information here
  32. is taken directly from the U-Boot source, with supplemental material added
  33. as needed (or at least as we managed to add it - probably *not* all that is
  34. needed).
  35. .. toctree::
  36. :maxdepth: 2
  37. api/index
  38. Architecture-specific doc
  39. -------------------------
  40. These books provide programming details about architecture-specific
  41. implementation.
  42. .. toctree::
  43. :maxdepth: 2
  44. arch/index
  45. Machine-specific doc
  46. --------------------
  47. These books provide programming details about machine-specific
  48. implementation.
  49. .. toctree::
  50. :maxdepth: 2
  51. imx/index
  52. Board-specific doc
  53. ------------------
  54. These books provide details about board-specific information. They are
  55. organized in a vendor subdirectory.
  56. .. toctree::
  57. :maxdepth: 2
  58. board/index
  59. Android-specific doc
  60. --------------------
  61. These books provide information about booting the Android OS from U-Boot,
  62. manipulating Android images from U-Boot shell and discusses other
  63. Android-specific features available in U-Boot.
  64. .. toctree::
  65. :maxdepth: 2
  66. android/index
  67. Chromium OS-specific doc
  68. ------------------------
  69. .. toctree::
  70. :maxdepth: 2
  71. chromium/index
  72. Indices and tables
  73. ==================
  74. * :ref:`genindex`