summaryrefslogtreecommitdiffstats
path: root/documentation/overview-manual/overview-manual-yp-intro.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/overview-manual/overview-manual-yp-intro.rst')
-rw-r--r--documentation/overview-manual/overview-manual-yp-intro.rst82
1 files changed, 35 insertions, 47 deletions
diff --git a/documentation/overview-manual/overview-manual-yp-intro.rst b/documentation/overview-manual/overview-manual-yp-intro.rst
index 1a71308fc0..13ff7e9f0e 100644
--- a/documentation/overview-manual/overview-manual-yp-intro.rst
+++ b/documentation/overview-manual/overview-manual-yp-intro.rst
@@ -113,7 +113,7 @@ Project:
113 development. 113 development.
114 114
115- *Releases According to a Strict Schedule:* Major releases occur on a 115- *Releases According to a Strict Schedule:* Major releases occur on a
116 `six-month cycle <&YOCTO_DOCS_REF_URL;#ref-release-process>`__ 116 :doc:`six-month cycle <../ref-manual/ref-release-process>`
117 predictably in October and April. The most recent two releases 117 predictably in October and April. The most recent two releases
118 support point releases to address common vulnerabilities and 118 support point releases to address common vulnerabilities and
119 exposures. This predictability is crucial for projects based on the 119 exposures. This predictability is crucial for projects based on the
@@ -131,8 +131,8 @@ Project:
131 in what order to support dependencies, other build systems can 131 in what order to support dependencies, other build systems can
132 arbitrarily include packages. 132 arbitrarily include packages.
133 133
134- *License Manifest:* The Yocto Project provides a `license 134- *License Manifest:* The Yocto Project provides a :ref:`license
135 manifest <&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle>`__ 135 manifest <dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle>`
136 for review by people who need to track the use of open source 136 for review by people who need to track the use of open source
137 licenses (e.g.legal teams). 137 licenses (e.g.legal teams).
138 138
@@ -154,10 +154,8 @@ developing using the Yocto Project:
154 changes need to be made for your particular design can require a 154 changes need to be made for your particular design can require a
155 significant amount of research and investigation. For information 155 significant amount of research and investigation. For information
156 that helps you transition from trying out the Yocto Project to using 156 that helps you transition from trying out the Yocto Project to using
157 it for your project, see the "`What I wish I'd 157 it for your project, see the ":ref:`what-i-wish-id-known:what i wish i'd known about yocto project`" and
158 Known <&YOCTO_DOCS_URL;/what-i-wish-id-known/>`__" and 158 ":ref:`transitioning-to-a-custom-environment:transitioning to a custom environment for systems development`"
159 "`Transitioning to a Custom Environment for Systems
160 Development <&YOCTO_DOCS_URL;/transitioning-to-a-custom-environment/>`__"
161 documents on the Yocto Project website. 159 documents on the Yocto Project website.
162 160
163- *Project Workflow Could Be Confusing:* The `Yocto Project 161- *Project Workflow Could Be Confusing:* The `Yocto Project
@@ -233,8 +231,8 @@ your Metadata, the easier it is to cope with future changes.
233 validated. 231 validated.
234 232
235 - Layers support the inclusion of technologies, hardware components, 233 - Layers support the inclusion of technologies, hardware components,
236 and software components. The `Yocto Project 234 and software components. The :ref:`Yocto Project
237 Compatible <&YOCTO_DOCS_DEV_URL;#making-sure-your-layer-is-compatible-with-yocto-project>`__ 235 Compatible <dev-manual/dev-manual-common-tasks:making sure your layer is compatible with yocto project>`
238 designation provides a minimum level of standardization that 236 designation provides a minimum level of standardization that
239 contributes to a strong ecosystem. "YP Compatible" is applied to 237 contributes to a strong ecosystem. "YP Compatible" is applied to
240 appropriate products and software components such as BSPs, other 238 appropriate products and software components such as BSPs, other
@@ -280,9 +278,8 @@ view <https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/>`__ of the
280``meta-yocto-bsp``. Each of these repositories represents a distinct 278``meta-yocto-bsp``. Each of these repositories represents a distinct
281layer. 279layer.
282 280
283For procedures on how to create layers, see the "`Understanding and 281For procedures on how to create layers, see the
284Creating 282":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`"
285Layers <&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers>`__"
286section in the Yocto Project Development Tasks Manual. 283section in the Yocto Project Development Tasks Manual.
287 284
288Components and Tools 285Components and Tools
@@ -292,7 +289,7 @@ The Yocto Project employs a collection of components and tools used by
292the project itself, by project developers, and by those using the Yocto 289the project itself, by project developers, and by those using the Yocto
293Project. These components and tools are open source projects and 290Project. These components and tools are open source projects and
294metadata that are separate from the reference distribution 291metadata that are separate from the reference distribution
295(`Poky <&YOCTO_DOCS_REF_URL;#poky>`__) and the 292(:term:`Poky`) and the
296:term:`OpenEmbedded Build System`. Most of the 293:term:`OpenEmbedded Build System`. Most of the
297components and tools are downloaded separately. 294components and tools are downloaded separately.
298 295
@@ -336,8 +333,8 @@ applications using the Yocto Project:
336 333
337 You can read about the ``devtool`` workflow in the Yocto Project 334 You can read about the ``devtool`` workflow in the Yocto Project
338 Application Development and Extensible Software Development Kit 335 Application Development and Extensible Software Development Kit
339 (eSDK) Manual in the "`Using ``devtool`` in Your SDK 336 (eSDK) Manual in the
340 Workflow' <&YOCTO_DOCS_SDK_URL;#using-devtool-in-your-sdk-workflow>`__" 337 ":ref:`sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow`"
341 section. 338 section.
342 339
343- *Extensible Software Development Kit (eSDK):* The eSDK provides a 340- *Extensible Software Development Kit (eSDK):* The eSDK provides a
@@ -349,14 +346,12 @@ applications using the Yocto Project:
349 experience supplemented with the powerful set of ``devtool`` commands 346 experience supplemented with the powerful set of ``devtool`` commands
350 tailored for the Yocto Project environment. 347 tailored for the Yocto Project environment.
351 348
352 For information on the eSDK, see the `Yocto Project Application 349 For information on the eSDK, see the :doc:`../sdk-manual/sdk-manual` Manual.
353 Development and the Extensible Software Development Kit
354 (eSDK) <&YOCTO_DOCS_SDK_URL;>`__ Manual.
355 350
356- *Toaster:* Toaster is a web interface to the Yocto Project 351- *Toaster:* Toaster is a web interface to the Yocto Project
357 OpenEmbedded build system. Toaster allows you to configure, run, and 352 OpenEmbedded build system. Toaster allows you to configure, run, and
358 view information about builds. For information on Toaster, see the 353 view information about builds. For information on Toaster, see the
359 `Toaster User Manual <&YOCTO_DOCS_TOAST_URL;>`__. 354 :doc:`../toaster-manual/toaster-manual`.
360 355
361.. _gs-production-tools: 356.. _gs-production-tools:
362 357
@@ -406,7 +401,7 @@ activities using the Yocto Project:
406 benefit of the development community. 401 benefit of the development community.
407 402
408 You can learn more about the AutoBuilder used by the Yocto Project 403 You can learn more about the AutoBuilder used by the Yocto Project
409 `here <&YOCTO_AB_URL;>`__. 404 Autobuilder :doc:`here <../test-manual/test-manual-understand-autobuilder>`.
410 405
411- *Cross-Prelink:* Prelinking is the process of pre-computing the load 406- *Cross-Prelink:* Prelinking is the process of pre-computing the load
412 addresses and link tables generated by the dynamic linker as compared 407 addresses and link tables generated by the dynamic linker as compared
@@ -595,8 +590,8 @@ Linux.
595Development Methods 590Development Methods
596=================== 591===================
597 592
598The Yocto Project development environment usually involves a `Build 593The Yocto Project development environment usually involves a
599Host <&YOCTO_DOCS_REF_URL;#hardware-build-system-term>`__ and target 594:term:`Build Host` and target
600hardware. You use the Build Host to build images and develop 595hardware. You use the Build Host to build images and develop
601applications, while you use the target hardware to test deployed 596applications, while you use the target hardware to test deployed
602software. 597software.
@@ -622,8 +617,8 @@ Project.
622 supported Linux distribution. 617 supported Linux distribution.
623 618
624 For information on how to set up a Build Host on a system running 619 For information on how to set up a Build Host on a system running
625 Linux as its native operating system, see the "`Setting Up a Native 620 Linux as its native operating system, see the
626 Linux Host <&YOCTO_DOCS_DEV_URL;#setting-up-a-native-linux-host>`__" 621 ":ref:`dev-manual/dev-manual-start:setting up a native linux host`"
627 section in the Yocto Project Development Tasks Manual. 622 section in the Yocto Project Development Tasks Manual.
628 623
629- *CROss PlatformS (CROPS):* Typically, you use 624- *CROss PlatformS (CROPS):* Typically, you use
@@ -643,9 +638,8 @@ Project.
643 system natively running Linux. 638 system natively running Linux.
644 639
645 For information on how to set up a Build Host with CROPS, see the 640 For information on how to set up a Build Host with CROPS, see the
646 "`Setting Up to Use CROss PlatformS 641 ":ref:`dev-manual/dev-manual-start:setting up to use cross platforms (crops)`"
647 (CROPS) <&YOCTO_DOCS_DEV_URL;#setting-up-to-use-crops>`__" section in 642 section in the Yocto Project Development Tasks Manual.
648 the Yocto Project Development Tasks Manual.
649 643
650- *Windows Subsystem For Linux (WSLv2):* You may use Windows Subsystem 644- *Windows Subsystem For Linux (WSLv2):* You may use Windows Subsystem
651 For Linux v2 to set up a build host using Windows 10. 645 For Linux v2 to set up a build host using Windows 10.
@@ -661,9 +655,8 @@ Project.
661 virtualization technology. 655 virtualization technology.
662 656
663 For information on how to set up a Build Host with WSLv2, see the 657 For information on how to set up a Build Host with WSLv2, see the
664 "`Setting Up to Use Windows Subsystem For 658 ":ref:dev-manual/dev-manual-start:setting up to use windows subsystem for linux (wslv2)`"
665 Linux <&YOCTO_DOCS_DEV_URL;#setting-up-to-use-wsl>`__" section in the 659 section in the Yocto Project Development Tasks Manual.
666 Yocto Project Development Tasks Manual.
667 660
668- *Toaster:* Regardless of what your Build Host is running, you can use 661- *Toaster:* Regardless of what your Build Host is running, you can use
669 Toaster to develop software using the Yocto Project. Toaster is a web 662 Toaster to develop software using the Yocto Project. Toaster is a web
@@ -673,8 +666,8 @@ Project.
673 builds is collected and stored in a database. You can use Toaster to 666 builds is collected and stored in a database. You can use Toaster to
674 configure and start builds on multiple remote build servers. 667 configure and start builds on multiple remote build servers.
675 668
676 For information about and how to use Toaster, see the `Toaster User 669 For information about and how to use Toaster, see the
677 Manual <&YOCTO_DOCS_TOAST_URL;>`__. 670 :doc:`../toaster-manual/toaster-manual`.
678 671
679.. _reference-embedded-distribution: 672.. _reference-embedded-distribution:
680 673
@@ -686,7 +679,7 @@ Project's reference distribution or Reference OS Kit. Poky contains the
686:term:`OpenEmbedded Build System` 679:term:`OpenEmbedded Build System`
687(:term:`BitBake` and 680(:term:`BitBake` and
688:term:`OpenEmbedded-Core (OE-Core)`) as well as a set 681:term:`OpenEmbedded-Core (OE-Core)`) as well as a set
689of `metadata <&YOCTO_DOCS_REF_URL;#metadata>`__ to get you started 682of :term:`Metadata` to get you started
690building your own distro. In other words, Poky is a base specification 683building your own distro. In other words, Poky is a base specification
691of the functionality needed for a typical embedded system as well as the 684of the functionality needed for a typical embedded system as well as the
692components from the Yocto Project that allow you to build a distribution 685components from the Yocto Project that allow you to build a distribution
@@ -747,8 +740,7 @@ Poky has a regular, well established, six-month release cycle under its
747own version. Major releases occur at the same time major releases (point 740own version. Major releases occur at the same time major releases (point
748releases) occur for the Yocto Project, which are typically in the Spring 741releases) occur for the Yocto Project, which are typically in the Spring
749and Fall. For more information on the Yocto Project release schedule and 742and Fall. For more information on the Yocto Project release schedule and
750cadence, see the "`Yocto Project Releases and the Stable Release 743cadence, see the ":doc:`../ref-manual/ref-release-process`" chapter in the
751Process <&YOCTO_DOCS_REF_URL;#ref-release-process>`__" chapter in the
752Yocto Project Reference Manual. 744Yocto Project Reference Manual.
753 745
754Much has been said about Poky being a "default configuration." A default 746Much has been said about Poky being a "default configuration." A default
@@ -827,8 +819,8 @@ Some Basic Terms
827================ 819================
828 820
829It helps to understand some basic fundamental terms when learning the 821It helps to understand some basic fundamental terms when learning the
830Yocto Project. Although a list of terms exists in the "`Yocto Project 822Yocto Project. Although a list of terms exists in the ":doc:`Yocto Project
831Terms <&YOCTO_DOCS_REF_URL;#ref-terms>`__" section of the Yocto Project 823Terms <../ref-manual/ref-terms>`" section of the Yocto Project
832Reference Manual, this section provides the definitions of some terms 824Reference Manual, this section provides the definitions of some terms
833helpful for getting started: 825helpful for getting started:
834 826
@@ -842,9 +834,7 @@ helpful for getting started:
842 application developers. This eSDK allows developers to incorporate 834 application developers. This eSDK allows developers to incorporate
843 their library and programming changes back into the image to make 835 their library and programming changes back into the image to make
844 their code available to other application developers. For information 836 their code available to other application developers. For information
845 on the eSDK, see the `Yocto Project Application Development and the 837 on the eSDK, see the :doc:`../sdk-manual/sdk-manual` manual.
846 Extensible Software Development Kit (eSDK) <&YOCTO_DOCS_SDK_URL;>`__
847 manual.
848 838
849- *Layer:* A collection of related recipes. Layers allow you to 839- *Layer:* A collection of related recipes. Layers allow you to
850 consolidate related metadata to customize your build. Layers also 840 consolidate related metadata to customize your build. Layers also
@@ -855,12 +845,11 @@ helpful for getting started:
855 them. You can search the Layer Index for layers used within Yocto 845 them. You can search the Layer Index for layers used within Yocto
856 Project. 846 Project.
857 847
858 For more detailed information on layers, see the "`Understanding and 848 For more detailed information on layers, see the
859 Creating 849 ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`"
860 Layers <&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers>`__"
861 section in the Yocto Project Development Tasks Manual. For a 850 section in the Yocto Project Development Tasks Manual. For a
862 discussion specifically on BSP Layers, see the "`BSP 851 discussion specifically on BSP Layers, see the
863 Layers <&YOCTO_DOCS_BSP_URL;#bsp-layers>`__" section in the Yocto 852 ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto
864 Project Board Support Packages (BSP) Developer's Guide. 853 Project Board Support Packages (BSP) Developer's Guide.
865 854
866- *Metadata:* A key element of the Yocto Project is the Metadata that 855- *Metadata:* A key element of the Yocto Project is the Metadata that
@@ -913,8 +902,7 @@ helpful for getting started:
913 902
914 It is worth noting that the term "package" can, in general, have 903 It is worth noting that the term "package" can, in general, have
915 subtle meanings. For example, the packages referred to in the 904 subtle meanings. For example, the packages referred to in the
916 "`Required Packages for the Build 905 ":ref:`ref-manual/ref-system-requirements:required packages for the build host`"
917 Host <&YOCTO_DOCS_REF_URL;#required-packages-for-the-build-host>`__"
918 section in the Yocto Project Reference Manual are compiled binaries 906 section in the Yocto Project Reference Manual are compiled binaries
919 that, when installed, add functionality to your Linux distribution. 907 that, when installed, add functionality to your Linux distribution.
920 908