diff options
Diffstat (limited to 'documentation/overview-manual')
3 files changed, 31 insertions, 31 deletions
diff --git a/documentation/overview-manual/overview-manual-concepts.rst b/documentation/overview-manual/overview-manual-concepts.rst index bbf2d0494e..d2e335e802 100644 --- a/documentation/overview-manual/overview-manual-concepts.rst +++ b/documentation/overview-manual/overview-manual-concepts.rst | |||
@@ -34,7 +34,7 @@ itself is of various types: | |||
34 | 34 | ||
35 | BitBake knows how to combine multiple data sources together and refers | 35 | BitBake knows how to combine multiple data sources together and refers |
36 | to each data source as a layer. For information on layers, see the | 36 | to each data source as a layer. For information on layers, see the |
37 | ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" | 37 | ":ref:`dev-manual/common-tasks:understanding and creating layers`" |
38 | section of the Yocto Project Development Tasks Manual. | 38 | section of the Yocto Project Development Tasks Manual. |
39 | 39 | ||
40 | Following are some brief details on these core components. For | 40 | Following are some brief details on these core components. For |
@@ -153,7 +153,7 @@ Conforming to a known structure allows BitBake to make assumptions | |||
153 | during builds on where to find types of metadata. You can find | 153 | during builds on where to find types of metadata. You can find |
154 | procedures and learn about tools (i.e. ``bitbake-layers``) for creating | 154 | procedures and learn about tools (i.e. ``bitbake-layers``) for creating |
155 | layers suitable for the Yocto Project in the | 155 | layers suitable for the Yocto Project in the |
156 | ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" | 156 | ":ref:`dev-manual/common-tasks:understanding and creating layers`" |
157 | section of the Yocto Project Development Tasks Manual. | 157 | section of the Yocto Project Development Tasks Manual. |
158 | 158 | ||
159 | OpenEmbedded Build System Concepts | 159 | OpenEmbedded Build System Concepts |
@@ -317,7 +317,7 @@ during the build. By default, the layers listed in this file include | |||
317 | layers minimally needed by the build system. However, you must manually | 317 | layers minimally needed by the build system. However, you must manually |
318 | add any custom layers you have created. You can find more information on | 318 | add any custom layers you have created. You can find more information on |
319 | working with the ``bblayers.conf`` file in the | 319 | working with the ``bblayers.conf`` file in the |
320 | ":ref:`dev-manual/dev-manual-common-tasks:enabling your layer`" | 320 | ":ref:`dev-manual/common-tasks:enabling your layer`" |
321 | section in the Yocto Project Development Tasks Manual. | 321 | section in the Yocto Project Development Tasks Manual. |
322 | 322 | ||
323 | The files ``site.conf`` and ``auto.conf`` are not created by the | 323 | The files ``site.conf`` and ``auto.conf`` are not created by the |
@@ -418,7 +418,7 @@ a ``README`` file as good practice and especially if the layer is to be | |||
418 | distributed, a configuration directory, and recipe directories. You can | 418 | distributed, a configuration directory, and recipe directories. You can |
419 | learn about the general structure for layers used with the Yocto Project | 419 | learn about the general structure for layers used with the Yocto Project |
420 | in the | 420 | in the |
421 | ":ref:`dev-manual/dev-manual-common-tasks:creating your own layer`" | 421 | ":ref:`dev-manual/common-tasks:creating your own layer`" |
422 | section in the | 422 | section in the |
423 | Yocto Project Development Tasks Manual. For a general discussion on | 423 | Yocto Project Development Tasks Manual. For a general discussion on |
424 | layers and the many layers from which you can draw, see the | 424 | layers and the many layers from which you can draw, see the |
@@ -827,7 +827,7 @@ For more information on how the source directories are created, see the | |||
827 | "`Source Fetching <#source-fetching-dev-environment>`__" section. For | 827 | "`Source Fetching <#source-fetching-dev-environment>`__" section. For |
828 | more information on how to create patches and how the build system | 828 | more information on how to create patches and how the build system |
829 | processes patches, see the | 829 | processes patches, see the |
830 | ":ref:`dev-manual/dev-manual-common-tasks:patching code`" | 830 | ":ref:`dev-manual/common-tasks:patching code`" |
831 | section in the | 831 | section in the |
832 | Yocto Project Development Tasks Manual. You can also see the | 832 | Yocto Project Development Tasks Manual. You can also see the |
833 | ":ref:`sdk-manual/sdk-extensible:use \`\`devtool modify\`\` to modify the source of an existing component`" | 833 | ":ref:`sdk-manual/sdk-extensible:use \`\`devtool modify\`\` to modify the source of an existing component`" |
@@ -1029,7 +1029,7 @@ stage of package installation, post installation scripts that are part | |||
1029 | of the packages are run. Any scripts that fail to run on the build host | 1029 | of the packages are run. Any scripts that fail to run on the build host |
1030 | are run on the target when the target system is first booted. If you are | 1030 | are run on the target when the target system is first booted. If you are |
1031 | using a | 1031 | using a |
1032 | :ref:`read-only root filesystem <dev-manual/dev-manual-common-tasks:creating a read-only root filesystem>`, | 1032 | :ref:`read-only root filesystem <dev-manual/common-tasks:creating a read-only root filesystem>`, |
1033 | all the post installation scripts must succeed on the build host during | 1033 | all the post installation scripts must succeed on the build host during |
1034 | the package installation phase since the root filesystem on the target | 1034 | the package installation phase since the root filesystem on the target |
1035 | is read-only. | 1035 | is read-only. |
@@ -1192,7 +1192,7 @@ varflag. If some other task depends on such a task, then that task will | |||
1192 | also always be considered out of date, which might not be what you want. | 1192 | also always be considered out of date, which might not be what you want. |
1193 | 1193 | ||
1194 | For details on how to view information about a task's signature, see the | 1194 | For details on how to view information about a task's signature, see the |
1195 | ":ref:`dev-manual/dev-manual-common-tasks:viewing task variable dependencies`" | 1195 | ":ref:`dev-manual/common-tasks:viewing task variable dependencies`" |
1196 | section in the Yocto Project Development Tasks Manual. | 1196 | section in the Yocto Project Development Tasks Manual. |
1197 | 1197 | ||
1198 | Setscene Tasks and Shared State | 1198 | Setscene Tasks and Shared State |
@@ -1626,15 +1626,15 @@ them if they are deemed to be valid. | |||
1626 | the shared state packages. Consequently, considerations exist that | 1626 | the shared state packages. Consequently, considerations exist that |
1627 | affect maintaining shared state feeds. For information on how the | 1627 | affect maintaining shared state feeds. For information on how the |
1628 | build system works with packages and can track incrementing ``PR`` | 1628 | build system works with packages and can track incrementing ``PR`` |
1629 | information, see the ":ref:`dev-manual/dev-manual-common-tasks:automatically incrementing a package version number`" | 1629 | information, see the ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" |
1630 | section in the Yocto Project Development Tasks Manual. | 1630 | section in the Yocto Project Development Tasks Manual. |
1631 | 1631 | ||
1632 | - The code in the build system that supports incremental builds is | 1632 | - The code in the build system that supports incremental builds is |
1633 | not simple code. For techniques that help you work around issues | 1633 | not simple code. For techniques that help you work around issues |
1634 | related to shared state code, see the | 1634 | related to shared state code, see the |
1635 | ":ref:`dev-manual/dev-manual-common-tasks:viewing metadata used to create the input signature of a shared state task`" | 1635 | ":ref:`dev-manual/common-tasks:viewing metadata used to create the input signature of a shared state task`" |
1636 | and | 1636 | and |
1637 | ":ref:`dev-manual/dev-manual-common-tasks:invalidating shared state to force a task to run`" | 1637 | ":ref:`dev-manual/common-tasks:invalidating shared state to force a task to run`" |
1638 | sections both in the Yocto Project Development Tasks Manual. | 1638 | sections both in the Yocto Project Development Tasks Manual. |
1639 | 1639 | ||
1640 | The rest of this section goes into detail about the overall incremental | 1640 | The rest of this section goes into detail about the overall incremental |
diff --git a/documentation/overview-manual/overview-manual-development-environment.rst b/documentation/overview-manual/overview-manual-development-environment.rst index 2421ec1a85..e03b4cdc62 100644 --- a/documentation/overview-manual/overview-manual-development-environment.rst +++ b/documentation/overview-manual/overview-manual-development-environment.rst | |||
@@ -66,7 +66,7 @@ to set up a CROPS machine, you effectively have access to a shell | |||
66 | environment that is similar to what you see when using a Linux-based | 66 | environment that is similar to what you see when using a Linux-based |
67 | development host. For the steps needed to set up a system using CROPS, | 67 | development host. For the steps needed to set up a system using CROPS, |
68 | see the | 68 | see the |
69 | ":ref:`dev-manual/dev-manual-start:setting up to use cross platforms (crops)`" | 69 | ":ref:`dev-manual/start:setting up to use cross platforms (crops)`" |
70 | section in | 70 | section in |
71 | the Yocto Project Development Tasks Manual. | 71 | the Yocto Project Development Tasks Manual. |
72 | 72 | ||
@@ -77,7 +77,7 @@ distribution on the system is one that supports the Yocto Project. You | |||
77 | also need to be sure that the correct set of host packages are installed | 77 | also need to be sure that the correct set of host packages are installed |
78 | that allow development using the Yocto Project. For the steps needed to | 78 | that allow development using the Yocto Project. For the steps needed to |
79 | set up a development host that runs Linux, see the | 79 | set up a development host that runs Linux, see the |
80 | ":ref:`dev-manual/dev-manual-start:setting up a native linux host`" | 80 | ":ref:`dev-manual/start:setting up a native linux host`" |
81 | section in the Yocto Project Development Tasks Manual. | 81 | section in the Yocto Project Development Tasks Manual. |
82 | 82 | ||
83 | Once your development host is set up to use the Yocto Project, several | 83 | Once your development host is set up to use the Yocto Project, several |
@@ -94,7 +94,7 @@ methods exist for you to do work in the Yocto Project environment: | |||
94 | through your Linux distribution and the Yocto Project. | 94 | through your Linux distribution and the Yocto Project. |
95 | 95 | ||
96 | For a general flow of the build procedures, see the | 96 | For a general flow of the build procedures, see the |
97 | ":ref:`dev-manual/dev-manual-common-tasks:building a simple image`" | 97 | ":ref:`dev-manual/common-tasks:building a simple image`" |
98 | section in the Yocto Project Development Tasks Manual. | 98 | section in the Yocto Project Development Tasks Manual. |
99 | 99 | ||
100 | - *Board Support Package (BSP) Development:* Development of BSPs | 100 | - *Board Support Package (BSP) Development:* Development of BSPs |
@@ -178,7 +178,7 @@ development: | |||
178 | :align: center | 178 | :align: center |
179 | 179 | ||
180 | For steps on how to view and access these upstream Git repositories, | 180 | For steps on how to view and access these upstream Git repositories, |
181 | see the ":ref:`dev-manual/dev-manual-start:accessing source repositories`" | 181 | see the ":ref:`dev-manual/start:accessing source repositories`" |
182 | Section in the Yocto Project Development Tasks Manual. | 182 | Section in the Yocto Project Development Tasks Manual. |
183 | 183 | ||
184 | - :yocto_dl:`Index of /releases: </releases>` This is an index | 184 | - :yocto_dl:`Index of /releases: </releases>` This is an index |
@@ -192,7 +192,7 @@ development: | |||
192 | :align: center | 192 | :align: center |
193 | 193 | ||
194 | For steps on how to view and access these files, see the | 194 | For steps on how to view and access these files, see the |
195 | ":ref:`dev-manual/dev-manual-start:accessing index of releases`" | 195 | ":ref:`dev-manual/start:accessing index of releases`" |
196 | section in the Yocto Project Development Tasks Manual. | 196 | section in the Yocto Project Development Tasks Manual. |
197 | 197 | ||
198 | - *"DOWNLOADS" page for the* :yocto_home:`Yocto Project Website <>` *:* | 198 | - *"DOWNLOADS" page for the* :yocto_home:`Yocto Project Website <>` *:* |
@@ -207,7 +207,7 @@ development: | |||
207 | :align: center | 207 | :align: center |
208 | 208 | ||
209 | For steps on how to use the "DOWNLOADS" page, see the | 209 | For steps on how to use the "DOWNLOADS" page, see the |
210 | ":ref:`dev-manual/dev-manual-start:using the downloads page`" | 210 | ":ref:`dev-manual/start:using the downloads page`" |
211 | section in the Yocto Project Development Tasks Manual. | 211 | section in the Yocto Project Development Tasks Manual. |
212 | 212 | ||
213 | Git Workflows and the Yocto Project | 213 | Git Workflows and the Yocto Project |
@@ -242,7 +242,7 @@ and so forth. | |||
242 | 242 | ||
243 | For information on finding out who is responsible for (maintains) a | 243 | For information on finding out who is responsible for (maintains) a |
244 | particular area of code in the Yocto Project, see the | 244 | particular area of code in the Yocto Project, see the |
245 | ":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" | 245 | ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" |
246 | section of the Yocto Project Development Tasks Manual. | 246 | section of the Yocto Project Development Tasks Manual. |
247 | 247 | ||
248 | The Yocto Project ``poky`` Git repository also has an upstream | 248 | The Yocto Project ``poky`` Git repository also has an upstream |
@@ -274,7 +274,7 @@ push them into the "contrib" area and subsequently request that the | |||
274 | maintainer include them into an upstream branch. This process is called | 274 | maintainer include them into an upstream branch. This process is called |
275 | "submitting a patch" or "submitting a change." For information on | 275 | "submitting a patch" or "submitting a change." For information on |
276 | submitting patches and changes, see the | 276 | submitting patches and changes, see the |
277 | ":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" | 277 | ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" |
278 | section in the Yocto Project Development Tasks Manual. | 278 | section in the Yocto Project Development Tasks Manual. |
279 | 279 | ||
280 | In summary, a single point of entry exists for changes into a "master" | 280 | In summary, a single point of entry exists for changes into a "master" |
@@ -341,7 +341,7 @@ Book <http://book.git-scm.com>`__. | |||
341 | the ``scripts`` folder of the | 341 | the ``scripts`` folder of the |
342 | :term:`Source Directory`. For information | 342 | :term:`Source Directory`. For information |
343 | on how to use these scripts, see the | 343 | on how to use these scripts, see the |
344 | ":ref:`dev-manual/dev-manual-common-tasks:using scripts to push a change upstream and request a pull`" | 344 | ":ref:`dev-manual/common-tasks:using scripts to push a change upstream and request a pull`" |
345 | section in the Yocto Project Development Tasks Manual. | 345 | section in the Yocto Project Development Tasks Manual. |
346 | 346 | ||
347 | - *Patch Workflow:* This workflow allows you to notify the maintainer | 347 | - *Patch Workflow:* This workflow allows you to notify the maintainer |
@@ -350,7 +350,7 @@ Book <http://book.git-scm.com>`__. | |||
350 | this type of change, you format the patch and then send the email | 350 | this type of change, you format the patch and then send the email |
351 | using the Git commands ``git format-patch`` and ``git send-email``. | 351 | using the Git commands ``git format-patch`` and ``git send-email``. |
352 | For information on how to use these scripts, see the | 352 | For information on how to use these scripts, see the |
353 | ":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" | 353 | ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" |
354 | section in the Yocto Project Development Tasks Manual. | 354 | section in the Yocto Project Development Tasks Manual. |
355 | 355 | ||
356 | Git | 356 | Git |
@@ -376,7 +376,7 @@ commands. | |||
376 | page, see http://git-scm.com/download. | 376 | page, see http://git-scm.com/download. |
377 | 377 | ||
378 | - For information beyond the introductory nature in this section, | 378 | - For information beyond the introductory nature in this section, |
379 | see the ":ref:`dev-manual/dev-manual-start:locating yocto project source files`" | 379 | see the ":ref:`dev-manual/start:locating yocto project source files`" |
380 | section in the Yocto Project Development Tasks Manual. | 380 | section in the Yocto Project Development Tasks Manual. |
381 | 381 | ||
382 | Repositories, Tags, and Branches | 382 | Repositories, Tags, and Branches |
@@ -408,7 +408,7 @@ You can create a local copy of any repository by "cloning" it with the | |||
408 | an identical copy of the repository on your development system. Once you | 408 | an identical copy of the repository on your development system. Once you |
409 | have a local copy of a repository, you can take steps to develop | 409 | have a local copy of a repository, you can take steps to develop |
410 | locally. For examples on how to clone Git repositories, see the | 410 | locally. For examples on how to clone Git repositories, see the |
411 | ":ref:`dev-manual/dev-manual-start:locating yocto project source files`" | 411 | ":ref:`dev-manual/start:locating yocto project source files`" |
412 | section in the Yocto Project Development Tasks Manual. | 412 | section in the Yocto Project Development Tasks Manual. |
413 | 413 | ||
414 | It is important to understand that Git tracks content change and not | 414 | It is important to understand that Git tracks content change and not |
@@ -661,5 +661,5 @@ Project uses in the ``meta/files/common-licenses`` directory in your | |||
661 | For information that can help you maintain compliance with various open | 661 | For information that can help you maintain compliance with various open |
662 | source licensing during the lifecycle of a product created using the | 662 | source licensing during the lifecycle of a product created using the |
663 | Yocto Project, see the | 663 | Yocto Project, see the |
664 | ":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`" | 664 | ":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" |
665 | section in the Yocto Project Development Tasks Manual. | 665 | section in the Yocto Project Development Tasks Manual. |
diff --git a/documentation/overview-manual/overview-manual-yp-intro.rst b/documentation/overview-manual/overview-manual-yp-intro.rst index d6488c6211..a6568d1c8e 100644 --- a/documentation/overview-manual/overview-manual-yp-intro.rst +++ b/documentation/overview-manual/overview-manual-yp-intro.rst | |||
@@ -130,7 +130,7 @@ Project: | |||
130 | arbitrarily include packages. | 130 | arbitrarily include packages. |
131 | 131 | ||
132 | - *License Manifest:* The Yocto Project provides a :ref:`license | 132 | - *License Manifest:* The Yocto Project provides a :ref:`license |
133 | manifest <dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle>` | 133 | manifest <dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle>` |
134 | for review by people who need to track the use of open source | 134 | for review by people who need to track the use of open source |
135 | licenses (e.g. legal teams). | 135 | licenses (e.g. legal teams). |
136 | 136 | ||
@@ -228,7 +228,7 @@ your Metadata, the easier it is to cope with future changes. | |||
228 | 228 | ||
229 | - Layers support the inclusion of technologies, hardware components, | 229 | - Layers support the inclusion of technologies, hardware components, |
230 | and software components. The :ref:`Yocto Project | 230 | and software components. The :ref:`Yocto Project |
231 | Compatible <dev-manual/dev-manual-common-tasks:making sure your layer is compatible with yocto project>` | 231 | Compatible <dev-manual/common-tasks:making sure your layer is compatible with yocto project>` |
232 | designation provides a minimum level of standardization that | 232 | designation provides a minimum level of standardization that |
233 | contributes to a strong ecosystem. "YP Compatible" is applied to | 233 | contributes to a strong ecosystem. "YP Compatible" is applied to |
234 | appropriate products and software components such as BSPs, other | 234 | appropriate products and software components such as BSPs, other |
@@ -274,7 +274,7 @@ of the ``poky`` repository, you will see several layers: ``meta``, | |||
274 | layer. | 274 | layer. |
275 | 275 | ||
276 | For procedures on how to create layers, see the | 276 | For procedures on how to create layers, see the |
277 | ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" | 277 | ":ref:`dev-manual/common-tasks:understanding and creating layers`" |
278 | section in the Yocto Project Development Tasks Manual. | 278 | section in the Yocto Project Development Tasks Manual. |
279 | 279 | ||
280 | Components and Tools | 280 | Components and Tools |
@@ -357,7 +357,7 @@ activities using the Yocto Project: | |||
357 | (BitBake and | 357 | (BitBake and |
358 | OE-Core) automatically generates upgrades for recipes that are based | 358 | OE-Core) automatically generates upgrades for recipes that are based |
359 | on new versions of the recipes published upstream. See | 359 | on new versions of the recipes published upstream. See |
360 | :ref:`dev-manual/dev-manual-common-tasks:using the auto upgrade helper (auh)` | 360 | :ref:`dev-manual/common-tasks:using the auto upgrade helper (auh)` |
361 | for how to set it up. | 361 | for how to set it up. |
362 | 362 | ||
363 | - *Recipe Reporting System:* The Recipe Reporting System tracks recipe | 363 | - *Recipe Reporting System:* The Recipe Reporting System tracks recipe |
@@ -601,7 +601,7 @@ Project. | |||
601 | 601 | ||
602 | For information on how to set up a Build Host on a system running | 602 | For information on how to set up a Build Host on a system running |
603 | Linux as its native operating system, see the | 603 | Linux as its native operating system, see the |
604 | ":ref:`dev-manual/dev-manual-start:setting up a native linux host`" | 604 | ":ref:`dev-manual/start:setting up a native linux host`" |
605 | section in the Yocto Project Development Tasks Manual. | 605 | section in the Yocto Project Development Tasks Manual. |
606 | 606 | ||
607 | - *CROss PlatformS (CROPS):* Typically, you use | 607 | - *CROss PlatformS (CROPS):* Typically, you use |
@@ -621,7 +621,7 @@ Project. | |||
621 | system natively running Linux. | 621 | system natively running Linux. |
622 | 622 | ||
623 | For information on how to set up a Build Host with CROPS, see the | 623 | For information on how to set up a Build Host with CROPS, see the |
624 | ":ref:`dev-manual/dev-manual-start:setting up to use cross platforms (crops)`" | 624 | ":ref:`dev-manual/start:setting up to use cross platforms (crops)`" |
625 | section in the Yocto Project Development Tasks Manual. | 625 | section in the Yocto Project Development Tasks Manual. |
626 | 626 | ||
627 | - *Windows Subsystem For Linux (WSLv2):* You may use Windows Subsystem | 627 | - *Windows Subsystem For Linux (WSLv2):* You may use Windows Subsystem |
@@ -638,7 +638,7 @@ Project. | |||
638 | virtualization technology. | 638 | virtualization technology. |
639 | 639 | ||
640 | For information on how to set up a Build Host with WSLv2, see the | 640 | For information on how to set up a Build Host with WSLv2, see the |
641 | ":ref:`dev-manual/dev-manual-start:setting up to use windows subsystem for linux (wslv2)`" | 641 | ":ref:`dev-manual/start:setting up to use windows subsystem for linux (wslv2)`" |
642 | section in the Yocto Project Development Tasks Manual. | 642 | section in the Yocto Project Development Tasks Manual. |
643 | 643 | ||
644 | - *Toaster:* Regardless of what your Build Host is running, you can use | 644 | - *Toaster:* Regardless of what your Build Host is running, you can use |
@@ -824,7 +824,7 @@ helpful for getting started: | |||
824 | Project. | 824 | Project. |
825 | 825 | ||
826 | For more detailed information on layers, see the | 826 | For more detailed information on layers, see the |
827 | ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" | 827 | ":ref:`dev-manual/common-tasks:understanding and creating layers`" |
828 | section in the Yocto Project Development Tasks Manual. For a | 828 | section in the Yocto Project Development Tasks Manual. For a |
829 | discussion specifically on BSP Layers, see the | 829 | discussion specifically on BSP Layers, see the |
830 | ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto | 830 | ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto |