summaryrefslogtreecommitdiffstats
path: root/documentation/overview-manual
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-12-03 22:38:38 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-12-09 12:21:27 +0000
commitaf6f5d821d39b50c3c4b45a593324346fce0d723 (patch)
tree872369e16adfff81fc49b7e8f550cae8905916b7 /documentation/overview-manual
parentc684a7a6d50754d577e0ff68a6fb6ed493b8f93e (diff)
downloadpoky-af6f5d821d39b50c3c4b45a593324346fce0d723.tar.gz
dev-manual: remove 'dev-manual' from filenames
All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: 00a9244587e2e63f2a5197ed0dfc89cb330f9275) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/overview-manual')
-rw-r--r--documentation/overview-manual/overview-manual-concepts.rst20
-rw-r--r--documentation/overview-manual/overview-manual-development-environment.rst26
-rw-r--r--documentation/overview-manual/overview-manual-yp-intro.rst16
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
35BitBake knows how to combine multiple data sources together and refers 35BitBake knows how to combine multiple data sources together and refers
36to each data source as a layer. For information on layers, see the 36to 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`"
38section of the Yocto Project Development Tasks Manual. 38section of the Yocto Project Development Tasks Manual.
39 39
40Following are some brief details on these core components. For 40Following are some brief details on these core components. For
@@ -153,7 +153,7 @@ Conforming to a known structure allows BitBake to make assumptions
153during builds on where to find types of metadata. You can find 153during builds on where to find types of metadata. You can find
154procedures and learn about tools (i.e. ``bitbake-layers``) for creating 154procedures and learn about tools (i.e. ``bitbake-layers``) for creating
155layers suitable for the Yocto Project in the 155layers 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`"
157section of the Yocto Project Development Tasks Manual. 157section of the Yocto Project Development Tasks Manual.
158 158
159OpenEmbedded Build System Concepts 159OpenEmbedded Build System Concepts
@@ -317,7 +317,7 @@ during the build. By default, the layers listed in this file include
317layers minimally needed by the build system. However, you must manually 317layers minimally needed by the build system. However, you must manually
318add any custom layers you have created. You can find more information on 318add any custom layers you have created. You can find more information on
319working with the ``bblayers.conf`` file in the 319working 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`"
321section in the Yocto Project Development Tasks Manual. 321section in the Yocto Project Development Tasks Manual.
322 322
323The files ``site.conf`` and ``auto.conf`` are not created by the 323The 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
418distributed, a configuration directory, and recipe directories. You can 418distributed, a configuration directory, and recipe directories. You can
419learn about the general structure for layers used with the Yocto Project 419learn about the general structure for layers used with the Yocto Project
420in the 420in the
421":ref:`dev-manual/dev-manual-common-tasks:creating your own layer`" 421":ref:`dev-manual/common-tasks:creating your own layer`"
422section in the 422section in the
423Yocto Project Development Tasks Manual. For a general discussion on 423Yocto Project Development Tasks Manual. For a general discussion on
424layers and the many layers from which you can draw, see the 424layers 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
828more information on how to create patches and how the build system 828more information on how to create patches and how the build system
829processes patches, see the 829processes patches, see the
830":ref:`dev-manual/dev-manual-common-tasks:patching code`" 830":ref:`dev-manual/common-tasks:patching code`"
831section in the 831section in the
832Yocto Project Development Tasks Manual. You can also see the 832Yocto 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
1029of the packages are run. Any scripts that fail to run on the build host 1029of the packages are run. Any scripts that fail to run on the build host
1030are run on the target when the target system is first booted. If you are 1030are run on the target when the target system is first booted. If you are
1031using a 1031using 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>`,
1033all the post installation scripts must succeed on the build host during 1033all the post installation scripts must succeed on the build host during
1034the package installation phase since the root filesystem on the target 1034the package installation phase since the root filesystem on the target
1035is read-only. 1035is read-only.
@@ -1192,7 +1192,7 @@ varflag. If some other task depends on such a task, then that task will
1192also always be considered out of date, which might not be what you want. 1192also always be considered out of date, which might not be what you want.
1193 1193
1194For details on how to view information about a task's signature, see the 1194For 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`"
1196section in the Yocto Project Development Tasks Manual. 1196section in the Yocto Project Development Tasks Manual.
1197 1197
1198Setscene Tasks and Shared State 1198Setscene 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
1640The rest of this section goes into detail about the overall incremental 1640The 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
66environment that is similar to what you see when using a Linux-based 66environment that is similar to what you see when using a Linux-based
67development host. For the steps needed to set up a system using CROPS, 67development host. For the steps needed to set up a system using CROPS,
68see the 68see 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)`"
70section in 70section in
71the Yocto Project Development Tasks Manual. 71the Yocto Project Development Tasks Manual.
72 72
@@ -77,7 +77,7 @@ distribution on the system is one that supports the Yocto Project. You
77also need to be sure that the correct set of host packages are installed 77also need to be sure that the correct set of host packages are installed
78that allow development using the Yocto Project. For the steps needed to 78that allow development using the Yocto Project. For the steps needed to
79set up a development host that runs Linux, see the 79set 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`"
81section in the Yocto Project Development Tasks Manual. 81section in the Yocto Project Development Tasks Manual.
82 82
83Once your development host is set up to use the Yocto Project, several 83Once 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
213Git Workflows and the Yocto Project 213Git 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
248The Yocto Project ``poky`` Git repository also has an upstream 248The Yocto Project ``poky`` Git repository also has an upstream
@@ -274,7 +274,7 @@ push them into the "contrib" area and subsequently request that the
274maintainer include them into an upstream branch. This process is called 274maintainer 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
276submitting patches and changes, see the 276submitting 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`"
278section in the Yocto Project Development Tasks Manual. 278section in the Yocto Project Development Tasks Manual.
279 279
280In summary, a single point of entry exists for changes into a "master" 280In 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
356Git 356Git
@@ -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
382Repositories, Tags, and Branches 382Repositories, Tags, and Branches
@@ -408,7 +408,7 @@ You can create a local copy of any repository by "cloning" it with the
408an identical copy of the repository on your development system. Once you 408an identical copy of the repository on your development system. Once you
409have a local copy of a repository, you can take steps to develop 409have a local copy of a repository, you can take steps to develop
410locally. For examples on how to clone Git repositories, see the 410locally. 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`"
412section in the Yocto Project Development Tasks Manual. 412section in the Yocto Project Development Tasks Manual.
413 413
414It is important to understand that Git tracks content change and not 414It 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
661For information that can help you maintain compliance with various open 661For information that can help you maintain compliance with various open
662source licensing during the lifecycle of a product created using the 662source licensing during the lifecycle of a product created using the
663Yocto Project, see the 663Yocto 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`"
665section in the Yocto Project Development Tasks Manual. 665section 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``,
274layer. 274layer.
275 275
276For procedures on how to create layers, see the 276For 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`"
278section in the Yocto Project Development Tasks Manual. 278section in the Yocto Project Development Tasks Manual.
279 279
280Components and Tools 280Components 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