summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-12-03 22:38:41 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-12-09 12:21:27 +0000
commit3240a59758e918afa79d14c961492d6f98cc3d85 (patch)
treec9a278f665319c0eccd6c3fb5e4133d17b309699 /documentation/dev-manual
parent11c048fbeae7d3eb12c43bd14953cb64b3de53bd (diff)
downloadpoky-3240a59758e918afa79d14c961492d6f98cc3d85.tar.gz
overview-manual: remove 'overview-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: 4f489a40bb00be018e419802a76fec9dbee3f255) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/common-tasks.rst40
-rw-r--r--documentation/dev-manual/start.rst16
2 files changed, 28 insertions, 28 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index fe3667bfb9..abeb1ed9c3 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -18,7 +18,7 @@ The OpenEmbedded build system supports organizing
18Layers allow you to isolate different types of customizations from each 18Layers allow you to isolate different types of customizations from each
19other. For introductory information on the Yocto Project Layer Model, 19other. For introductory information on the Yocto Project Layer Model,
20see the 20see the
21":ref:`overview-manual/overview-manual-yp-intro:the yocto project layer model`" 21":ref:`overview-manual/yp-intro:the yocto project layer model`"
22section in the Yocto Project Overview and Concepts Manual. 22section in the Yocto Project Overview and Concepts Manual.
23 23
24Creating Your Own Layer 24Creating Your Own Layer
@@ -1319,7 +1319,7 @@ to determine how well the build went.
1319 ``log.do_fetch``, and ``log.do_compile``). 1319 ``log.do_fetch``, and ``log.do_compile``).
1320 1320
1321You can find more information about the build process in 1321You can find more information about the build process in
1322":doc:`/overview-manual/overview-manual-development-environment`" 1322":doc:`/overview-manual/development-environment`"
1323chapter of the Yocto Project Overview and Concepts Manual. 1323chapter of the Yocto Project Overview and Concepts Manual.
1324 1324
1325Fetching Code 1325Fetching Code
@@ -1330,7 +1330,7 @@ files. Fetching is controlled mainly through the
1330:term:`SRC_URI` variable. Your recipe 1330:term:`SRC_URI` variable. Your recipe
1331must have a ``SRC_URI`` variable that points to where the source is 1331must have a ``SRC_URI`` variable that points to where the source is
1332located. For a graphical representation of source locations, see the 1332located. For a graphical representation of source locations, see the
1333":ref:`overview-manual/overview-manual-concepts:sources`" section in 1333":ref:`overview-manual/concepts:sources`" section in
1334the Yocto Project Overview and Concepts Manual. 1334the Yocto Project Overview and Concepts Manual.
1335 1335
1336The :ref:`ref-tasks-fetch` task uses 1336The :ref:`ref-tasks-fetch` task uses
@@ -1599,7 +1599,7 @@ package "example" contains "libexample" and another package "mypackage"
1599contains a binary that links to "libexample" then the OpenEmbedded build 1599contains a binary that links to "libexample" then the OpenEmbedded build
1600system will automatically add a runtime dependency to "mypackage" on 1600system will automatically add a runtime dependency to "mypackage" on
1601"example"). See the 1601"example"). See the
1602":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" 1602":ref:`overview-manual/concepts:automatically added runtime dependencies`"
1603section in the Yocto Project Overview and Concepts Manual for further 1603section in the Yocto Project Overview and Concepts Manual for further
1604details. 1604details.
1605 1605
@@ -2486,7 +2486,7 @@ Reference Manual's variable glossary.
2486 2486
2487 - Using ``DEPENDS`` also allows runtime dependencies between 2487 - Using ``DEPENDS`` also allows runtime dependencies between
2488 packages to be added automatically. See the 2488 packages to be added automatically. See the
2489 ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" 2489 ":ref:`overview-manual/concepts:automatically added runtime dependencies`"
2490 section in the Yocto Project Overview and Concepts Manual for more 2490 section in the Yocto Project Overview and Concepts Manual for more
2491 information. 2491 information.
2492 2492
@@ -3658,7 +3658,7 @@ build host running Linux.
3658The build process creates an entire Linux distribution from source and 3658The build process creates an entire Linux distribution from source and
3659places it in your :term:`Build Directory` under 3659places it in your :term:`Build Directory` under
3660``tmp/deploy/images``. For detailed information on the build process 3660``tmp/deploy/images``. For detailed information on the build process
3661using BitBake, see the ":ref:`overview-manual/overview-manual-concepts:images`" section in the 3661using BitBake, see the ":ref:`overview-manual/concepts:images`" section in the
3662Yocto Project Overview and Concepts Manual. 3662Yocto Project Overview and Concepts Manual.
3663 3663
3664The following figure and list overviews the build process: 3664The following figure and list overviews the build process:
@@ -5490,7 +5490,7 @@ Using an Existing Kickstart File
5490 5490
5491If you do not want to create your own kickstart file, you can use an 5491If you do not want to create your own kickstart file, you can use an
5492existing file provided by the Wic installation. As shipped, kickstart 5492existing file provided by the Wic installation. As shipped, kickstart
5493files can be found in the :ref:`overview-manual/overview-manual-development-environment:yocto project source repositories` in the 5493files can be found in the :ref:`overview-manual/development-environment:yocto project source repositories` in the
5494following two locations: 5494following two locations:
5495:: 5495::
5496 5496
@@ -6526,7 +6526,7 @@ revision, respectively). The values are highly dependent on the policies
6526and procedures of a given distribution and package feed. 6526and procedures of a given distribution and package feed.
6527 6527
6528Because the OpenEmbedded build system uses 6528Because the OpenEmbedded build system uses
6529":ref:`signatures <overview-manual/overview-manual-concepts:checksums (signatures)>`", which are 6529":ref:`signatures <overview-manual/concepts:checksums (signatures)>`", which are
6530unique to a given build, the build system knows when to rebuild 6530unique to a given build, the build system knows when to rebuild
6531packages. All the inputs into a given task are represented by a 6531packages. All the inputs into a given task are represented by a
6532signature, which can trigger a rebuild when different. Thus, the build 6532signature, which can trigger a rebuild when different. Thus, the build
@@ -6600,7 +6600,7 @@ Quality <#maintaining-build-output-quality>`__" section.
6600 use a PR Service while others do not leads to obvious problems. 6600 use a PR Service while others do not leads to obvious problems.
6601 6601
6602 For more information on shared state, see the 6602 For more information on shared state, see the
6603 ":ref:`overview-manual/overview-manual-concepts:shared state cache`" 6603 ":ref:`overview-manual/concepts:shared state cache`"
6604 section in the Yocto Project Overview and Concepts Manual. 6604 section in the Yocto Project Overview and Concepts Manual.
6605 6605
6606Manually Bumping PR 6606Manually Bumping PR
@@ -6767,7 +6767,7 @@ multiple times if you have more than one set of modules to package.
6767 6767
6768For more examples that show how to use ``do_split_packages``, see the 6768For more examples that show how to use ``do_split_packages``, see the
6769``connman.inc`` file in the ``meta/recipes-connectivity/connman/`` 6769``connman.inc`` file in the ``meta/recipes-connectivity/connman/``
6770directory of the ``poky`` :ref:`source repository <overview-manual/overview-manual-development-environment:yocto project source repositories>`. You can 6770directory of the ``poky`` :ref:`source repository <overview-manual/development-environment:yocto project source repositories>`. You can
6771also find examples in ``meta/classes/kernel.bbclass``. 6771also find examples in ``meta/classes/kernel.bbclass``.
6772 6772
6773Following is a reference that shows ``do_split_packages`` mandatory and 6773Following is a reference that shows ``do_split_packages`` mandatory and
@@ -8080,7 +8080,7 @@ variable to "1" at the end of your ``conf/local.conf`` file found in the
8080Enabling build history as 8080Enabling build history as
8081previously described causes the OpenEmbedded build system to collect 8081previously described causes the OpenEmbedded build system to collect
8082build output information and commit it as a single commit to a local 8082build output information and commit it as a single commit to a local
8083:ref:`overview-manual/overview-manual-development-environment:git` repository. 8083:ref:`overview-manual/development-environment:git` repository.
8084 8084
8085.. note:: 8085.. note::
8086 8086
@@ -9394,7 +9394,7 @@ BitBake has determined by doing the following:
9394 ${BUILDDIR}/tmp/stamps/i586-poky-linux/db/6.0.30-r1.do_fetch.sigdata.7c048c18222b16ff0bcee2000ef648b1 9394 ${BUILDDIR}/tmp/stamps/i586-poky-linux/db/6.0.30-r1.do_fetch.sigdata.7c048c18222b16ff0bcee2000ef648b1
9395 9395
9396 For tasks that are accelerated through the shared state 9396 For tasks that are accelerated through the shared state
9397 (:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`) cache, an 9397 (:ref:`sstate <overview-manual/concepts:shared state cache>`) cache, an
9398 additional ``siginfo`` file is written into 9398 additional ``siginfo`` file is written into
9399 :term:`SSTATE_DIR` along with 9399 :term:`SSTATE_DIR` along with
9400 the cached task output. The ``siginfo`` files contain exactly the 9400 the cached task output. The ``siginfo`` files contain exactly the
@@ -9461,15 +9461,15 @@ files, see the "`Viewing Task Variable
9461Dependencies <#dev-viewing-task-variable-dependencies>`__" section. 9461Dependencies <#dev-viewing-task-variable-dependencies>`__" section.
9462 9462
9463For conceptual information on shared state, see the 9463For conceptual information on shared state, see the
9464":ref:`overview-manual/overview-manual-concepts:shared state`" 9464":ref:`overview-manual/concepts:shared state`"
9465section in the Yocto Project Overview and Concepts Manual. 9465section in the Yocto Project Overview and Concepts Manual.
9466 9466
9467Invalidating Shared State to Force a Task to Run 9467Invalidating Shared State to Force a Task to Run
9468------------------------------------------------ 9468------------------------------------------------
9469 9469
9470The OpenEmbedded build system uses 9470The OpenEmbedded build system uses
9471:ref:`checksums <overview-manual/overview-manual-concepts:checksums (signatures)>` and 9471:ref:`checksums <overview-manual/concepts:checksums (signatures)>` and
9472:ref:`overview-manual/overview-manual-concepts:shared state` cache to avoid unnecessarily 9472:ref:`overview-manual/concepts:shared state` cache to avoid unnecessarily
9473rebuilding tasks. Collectively, this scheme is known as "shared state 9473rebuilding tasks. Collectively, this scheme is known as "shared state
9474code". 9474code".
9475 9475
@@ -9530,7 +9530,7 @@ tasks (including tasks from other recipes) that the specified task
9530depends on will be run before the task. Even when you manually specify a 9530depends on will be run before the task. Even when you manually specify a
9531task to run with ``-c``, BitBake will only run the task if it considers 9531task to run with ``-c``, BitBake will only run the task if it considers
9532it "out of date". See the 9532it "out of date". See the
9533":ref:`overview-manual/overview-manual-concepts:stamp files and the rerunning of tasks`" 9533":ref:`overview-manual/concepts:stamp files and the rerunning of tasks`"
9534section in the Yocto Project Overview and Concepts Manual for how 9534section in the Yocto Project Overview and Concepts Manual for how
9535BitBake determines whether a task is "out of date". 9535BitBake determines whether a task is "out of date".
9536 9536
@@ -10458,7 +10458,7 @@ Yocto general mailing list or on the openembedded-devel mailing list.
10458You can also push a change upstream and request a maintainer to pull the 10458You can also push a change upstream and request a maintainer to pull the
10459change into the component's upstream repository. You do this by pushing 10459change into the component's upstream repository. You do this by pushing
10460to a contribution repository that is upstream. See the 10460to a contribution repository that is upstream. See the
10461":ref:`overview-manual/overview-manual-development-environment:git workflows and the yocto project`" 10461":ref:`overview-manual/development-environment:git workflows and the yocto project`"
10462section in the Yocto Project Overview and Concepts Manual for additional 10462section in the Yocto Project Overview and Concepts Manual for additional
10463concepts on working in the Yocto Project development environment. 10463concepts on working in the Yocto Project development environment.
10464 10464
@@ -10707,7 +10707,7 @@ been followed:
10707 located in the :term:`Source Directory` at 10707 located in the :term:`Source Directory` at
10708 ``meta/conf/distro/include``, to see who is responsible for code. 10708 ``meta/conf/distro/include``, to see who is responsible for code.
10709 10709
10710 - *Search by File:* Using :ref:`overview-manual/overview-manual-development-environment:git`, you can 10710 - *Search by File:* Using :ref:`overview-manual/development-environment:git`, you can
10711 enter the following command to bring up a short list of all 10711 enter the following command to bring up a short list of all
10712 commits against a specific file: 10712 commits against a specific file:
10713 :: 10713 ::
@@ -10856,7 +10856,7 @@ follows:
10856Working With Licenses 10856Working With Licenses
10857===================== 10857=====================
10858 10858
10859As mentioned in the ":ref:`overview-manual/overview-manual-development-environment:licensing`" 10859As mentioned in the ":ref:`overview-manual/development-environment:licensing`"
10860section in the Yocto Project Overview and Concepts Manual, open source 10860section in the Yocto Project Overview and Concepts Manual, open source
10861projects are open to the public and they consequently have different 10861projects are open to the public and they consequently have different
10862licensing structures in place. This section describes the mechanism by 10862licensing structures in place. This section describes the mechanism by
@@ -11299,7 +11299,7 @@ By releasing the version of the OpenEmbedded build system and the layers
11299used during the build, you will be providing both compilation scripts 11299used during the build, you will be providing both compilation scripts
11300and the source code modifications in one step. 11300and the source code modifications in one step.
11301 11301
11302If the deployment team has a :ref:`overview-manual/overview-manual-concepts:bsp layer` 11302If the deployment team has a :ref:`overview-manual/concepts:bsp layer`
11303and a distro layer, and those 11303and a distro layer, and those
11304those layers are used to patch, compile, package, or modify (in any way) 11304those layers are used to patch, compile, package, or modify (in any way)
11305any open source software included in your released images, you might be 11305any open source software included in your released images, you might be
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst
index 8244d68ed0..a26d2a3ead 100644
--- a/documentation/dev-manual/start.rst
+++ b/documentation/dev-manual/start.rst
@@ -78,7 +78,7 @@ particular working environment and set of practices.
78 developing under the control of an SCM system that is compatible 78 developing under the control of an SCM system that is compatible
79 with the OpenEmbedded build system is advisable. Of all of the SCMs 79 with the OpenEmbedded build system is advisable. Of all of the SCMs
80 supported by BitBake, the Yocto Project team strongly recommends using 80 supported by BitBake, the Yocto Project team strongly recommends using
81 :ref:`overview-manual/overview-manual-development-environment:git`. 81 :ref:`overview-manual/development-environment:git`.
82 Git is a distributed system 82 Git is a distributed system
83 that is easy to back up, allows you to work remotely, and then 83 that is easy to back up, allows you to work remotely, and then
84 connects back to the infrastructure. 84 connects back to the infrastructure.
@@ -165,7 +165,7 @@ particular working environment and set of practices.
165 - Highlights when commits break the build. 165 - Highlights when commits break the build.
166 166
167 - Populates an :ref:`sstate 167 - Populates an :ref:`sstate
168 cache <overview-manual/overview-manual-concepts:shared state cache>` from which 168 cache <overview-manual/concepts:shared state cache>` from which
169 developers can pull rather than requiring local builds. 169 developers can pull rather than requiring local builds.
170 170
171 - Allows commit hook triggers, which trigger builds when commits 171 - Allows commit hook triggers, which trigger builds when commits
@@ -218,17 +218,17 @@ particular working environment and set of practices.
218 some best practices exist within the Yocto Project development 218 some best practices exist within the Yocto Project development
219 environment. Consider the following: 219 environment. Consider the following:
220 220
221 - Use :ref:`overview-manual/overview-manual-development-environment:git` as the source control 221 - Use :ref:`overview-manual/development-environment:git` as the source control
222 system. 222 system.
223 223
224 - Maintain your Metadata in layers that make sense for your 224 - Maintain your Metadata in layers that make sense for your
225 situation. See the ":ref:`overview-manual/overview-manual-yp-intro:the yocto project layer model`" 225 situation. See the ":ref:`overview-manual/yp-intro:the yocto project layer model`"
226 section in the Yocto Project Overview and Concepts Manual and the 226 section in the Yocto Project Overview and Concepts Manual and the
227 ":ref:`dev-manual/common-tasks:understanding and creating layers`" 227 ":ref:`dev-manual/common-tasks:understanding and creating layers`"
228 section for more information on layers. 228 section for more information on layers.
229 229
230 - Separate the project's Metadata and code by using separate Git 230 - Separate the project's Metadata and code by using separate Git
231 repositories. See the ":ref:`overview-manual/overview-manual-development-environment:yocto project source repositories`" 231 repositories. See the ":ref:`overview-manual/development-environment:yocto project source repositories`"
232 section in the Yocto Project Overview and Concepts Manual for 232 section in the Yocto Project Overview and Concepts Manual for
233 information on these repositories. See the "`Locating Yocto 233 information on these repositories. See the "`Locating Yocto
234 Project Source Files <#locating-yocto-project-source-files>`__" 234 Project Source Files <#locating-yocto-project-source-files>`__"
@@ -572,11 +572,11 @@ files you'll need to work with the Yocto Project.
572.. note:: 572.. note::
573 573
574 - For concepts and introductory information about Git as it is used 574 - For concepts and introductory information about Git as it is used
575 in the Yocto Project, see the ":ref:`overview-manual/overview-manual-development-environment:git`" 575 in the Yocto Project, see the ":ref:`overview-manual/development-environment:git`"
576 section in the Yocto Project Overview and Concepts Manual. 576 section in the Yocto Project Overview and Concepts Manual.
577 577
578 - For concepts on Yocto Project source repositories, see the 578 - For concepts on Yocto Project source repositories, see the
579 ":ref:`overview-manual/overview-manual-development-environment:yocto project source repositories`" 579 ":ref:`overview-manual/development-environment:yocto project source repositories`"
580 section in the Yocto Project Overview and Concepts Manual." 580 section in the Yocto Project Overview and Concepts Manual."
581 581
582Accessing Source Repositories 582Accessing Source Repositories
@@ -722,7 +722,7 @@ files is referred to as the :term:`Source Directory`
722in the Yocto Project documentation. 722in the Yocto Project documentation.
723 723
724The preferred method of creating your Source Directory is by using 724The preferred method of creating your Source Directory is by using
725:ref:`overview-manual/overview-manual-development-environment:git` to clone a local copy of the upstream 725:ref:`overview-manual/development-environment:git` to clone a local copy of the upstream
726``poky`` repository. Working from a cloned copy of the upstream 726``poky`` repository. Working from a cloned copy of the upstream
727repository allows you to contribute back into the Yocto Project or to 727repository allows you to contribute back into the Yocto Project or to
728simply work with the latest software on a development branch. Because 728simply work with the latest software on a development branch. Because