index.rst 2.2 KB

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