index.rst 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  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. Driver-Model documentation
  14. --------------------------
  15. The following holds information on the U-Boot device driver framework:
  16. driver-model, including the design details of itself and several driver
  17. subsystems.
  18. .. toctree::
  19. :maxdepth: 2
  20. driver-model/index
  21. U-Boot API documentation
  22. ------------------------
  23. These books get into the details of how specific U-Boot subsystems work
  24. from the point of view of a U-Boot developer. Much of the information here
  25. is taken directly from the U-Boot source, with supplemental material added
  26. as needed (or at least as we managed to add it - probably *not* all that is
  27. needed).
  28. .. toctree::
  29. :maxdepth: 2
  30. api/index
  31. Architecture-specific doc
  32. -------------------------
  33. These books provide programming details about architecture-specific
  34. implementation.
  35. .. toctree::
  36. :maxdepth: 2
  37. arch/index
  38. Board-specific doc
  39. ------------------
  40. These books provide details about board-specific information. They are
  41. organized in a vendor subdirectory.
  42. .. toctree::
  43. :maxdepth: 2
  44. board/index
  45. Indices and tables
  46. ==================
  47. * :ref:`genindex`