dev-manual-intro.rst 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. .. SPDX-License-Identifier: CC-BY-SA-2.0-UK
  2. ******************************************
  3. The Yocto Project Development Tasks Manual
  4. ******************************************
  5. .. _dev-welcome:
  6. Welcome
  7. =======
  8. Welcome to the Yocto Project Development Tasks Manual! This manual
  9. provides relevant procedures necessary for developing in the Yocto
  10. Project environment (i.e. developing embedded Linux images and
  11. user-space applications that run on targeted devices). The manual groups
  12. related procedures into higher-level sections. Procedures can consist of
  13. high-level steps or low-level steps depending on the topic.
  14. This manual provides the following:
  15. - Procedures that help you get going with the Yocto Project. For
  16. example, procedures that show you how to set up a build host and work
  17. with the Yocto Project source repositories.
  18. - Procedures that show you how to submit changes to the Yocto Project.
  19. Changes can be improvements, new features, or bug fixes.
  20. - Procedures related to "everyday" tasks you perform while developing
  21. images and applications using the Yocto Project. For example,
  22. procedures to create a layer, customize an image, write a new recipe,
  23. and so forth.
  24. This manual does not provide the following:
  25. - Redundant Step-by-step Instructions: For example, the
  26. :doc:`../sdk-manual/sdk-manual` manual contains detailed
  27. instructions on how to install an SDK, which is used to develop
  28. applications for target hardware.
  29. - Reference or Conceptual Material: This type of material resides in an
  30. appropriate reference manual. For example, system variables are
  31. documented in the :doc`../ref-manual/ref-manual`.
  32. - Detailed Public Information Not Specific to the Yocto Project: For
  33. example, exhaustive information on how to use the Source Control
  34. Manager Git is better covered with Internet searches and official Git
  35. Documentation than through the Yocto Project documentation.
  36. Other Information
  37. =================
  38. Because this manual presents information for many different topics,
  39. supplemental information is recommended for full comprehension. For
  40. introductory information on the Yocto Project, see the
  41. :yocto_home:`Yocto Project Website <>`. If you want to build an image with no
  42. knowledge of Yocto Project as a way of quickly testing it out, see the
  43. :doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document.
  44. For a comprehensive list of links and other documentation, see the
  45. ":ref:`ref-manual/resources:links and related documentation`"
  46. section in the Yocto Project Reference Manual.