diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-12-03 22:38:41 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-12-09 12:21:27 +0000 |
commit | 3240a59758e918afa79d14c961492d6f98cc3d85 (patch) | |
tree | c9a278f665319c0eccd6c3fb5e4133d17b309699 /documentation/dev-manual/start.rst | |
parent | 11c048fbeae7d3eb12c43bd14953cb64b3de53bd (diff) | |
download | poky-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/start.rst')
-rw-r--r-- | documentation/dev-manual/start.rst | 16 |
1 files changed, 8 insertions, 8 deletions
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 | ||
582 | Accessing Source Repositories | 582 | Accessing Source Repositories |
@@ -722,7 +722,7 @@ files is referred to as the :term:`Source Directory` | |||
722 | in the Yocto Project documentation. | 722 | in the Yocto Project documentation. |
723 | 723 | ||
724 | The preferred method of creating your Source Directory is by using | 724 | The 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 |
727 | repository allows you to contribute back into the Yocto Project or to | 727 | repository allows you to contribute back into the Yocto Project or to |
728 | simply work with the latest software on a development branch. Because | 728 | simply work with the latest software on a development branch. Because |