diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-12-03 22:38:38 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-12-09 12:21:27 +0000 |
commit | af6f5d821d39b50c3c4b45a593324346fce0d723 (patch) | |
tree | 872369e16adfff81fc49b7e8f550cae8905916b7 /documentation/dev-manual | |
parent | c684a7a6d50754d577e0ff68a6fb6ed493b8f93e (diff) | |
download | poky-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/dev-manual')
-rw-r--r-- | documentation/dev-manual/common-tasks.rst (renamed from documentation/dev-manual/dev-manual-common-tasks.rst) | 54 | ||||
-rw-r--r-- | documentation/dev-manual/index.rst | 8 | ||||
-rw-r--r-- | documentation/dev-manual/intro.rst (renamed from documentation/dev-manual/dev-manual-intro.rst) | 0 | ||||
-rw-r--r-- | documentation/dev-manual/qemu.rst (renamed from documentation/dev-manual/dev-manual-qemu.rst) | 0 | ||||
-rw-r--r-- | documentation/dev-manual/start.rst (renamed from documentation/dev-manual/dev-manual-start.rst) | 20 |
5 files changed, 41 insertions, 41 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 0a2e6d9df3..c627491f39 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
@@ -31,7 +31,7 @@ layers so that you can better understand them. For information about the | |||
31 | layer-creation tools, see the | 31 | layer-creation tools, see the |
32 | ":ref:`bsp-guide/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" | 32 | ":ref:`bsp-guide/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" |
33 | section in the Yocto Project Board Support Package (BSP) Developer's | 33 | section in the Yocto Project Board Support Package (BSP) Developer's |
34 | Guide and the ":ref:`dev-manual/dev-manual-common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" | 34 | Guide and the ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" |
35 | section further down in this manual. | 35 | section further down in this manual. |
36 | 36 | ||
37 | Follow these general steps to create your layer without using tools: | 37 | Follow these general steps to create your layer without using tools: |
@@ -725,7 +725,7 @@ simplifies creating a new general layer. | |||
725 | 725 | ||
726 | - In order to use a layer with the OpenEmbedded build system, you | 726 | - In order to use a layer with the OpenEmbedded build system, you |
727 | need to add the layer to your ``bblayers.conf`` configuration | 727 | need to add the layer to your ``bblayers.conf`` configuration |
728 | file. See the ":ref:`dev-manual/dev-manual-common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`" | 728 | file. See the ":ref:`dev-manual/common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`" |
729 | section for more information. | 729 | section for more information. |
730 | 730 | ||
731 | The default mode of the script's operation with this subcommand is to | 731 | The default mode of the script's operation with this subcommand is to |
@@ -1106,7 +1106,7 @@ that can help you quickly get a start on a new recipe: | |||
1106 | .. note:: | 1106 | .. note:: |
1107 | 1107 | ||
1108 | For information on recipe syntax, see the | 1108 | For information on recipe syntax, see the |
1109 | ":ref:`dev-manual/dev-manual-common-tasks:recipe syntax`" section. | 1109 | ":ref:`dev-manual/common-tasks:recipe syntax`" section. |
1110 | 1110 | ||
1111 | Creating the Base Recipe Using ``devtool add`` | 1111 | Creating the Base Recipe Using ``devtool add`` |
1112 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 1112 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
@@ -1538,7 +1538,7 @@ variables: | |||
1538 | differences result in an error with the message containing the | 1538 | differences result in an error with the message containing the |
1539 | current checksum. For more explanation and examples of how to set the | 1539 | current checksum. For more explanation and examples of how to set the |
1540 | ``LIC_FILES_CHKSUM`` variable, see the | 1540 | ``LIC_FILES_CHKSUM`` variable, see the |
1541 | ":ref:`dev-manual/dev-manual-common-tasks:tracking license changes`" section. | 1541 | ":ref:`dev-manual/common-tasks:tracking license changes`" section. |
1542 | 1542 | ||
1543 | To determine the correct checksum string, you can list the | 1543 | To determine the correct checksum string, you can list the |
1544 | appropriate files in the ``LIC_FILES_CHKSUM`` variable with incorrect | 1544 | appropriate files in the ``LIC_FILES_CHKSUM`` variable with incorrect |
@@ -1771,7 +1771,7 @@ Here are some common issues that cause failures. | |||
1771 | For cases where improper paths are detected for configuration files | 1771 | For cases where improper paths are detected for configuration files |
1772 | or for when libraries/headers cannot be found, be sure you are using | 1772 | or for when libraries/headers cannot be found, be sure you are using |
1773 | the more robust ``pkg-config``. See the note in section | 1773 | the more robust ``pkg-config``. See the note in section |
1774 | ":ref:`dev-manual/dev-manual-common-tasks:Configuring the Recipe`" for additional information. | 1774 | ":ref:`dev-manual/common-tasks:Configuring the Recipe`" for additional information. |
1775 | 1775 | ||
1776 | - *Parallel build failures:* These failures manifest themselves as | 1776 | - *Parallel build failures:* These failures manifest themselves as |
1777 | intermittent errors, or errors reporting that a file or directory | 1777 | intermittent errors, or errors reporting that a file or directory |
@@ -2338,7 +2338,7 @@ Following is one example: (``hello_2.3.bb``) | |||
2338 | 2338 | ||
2339 | The variable ``LIC_FILES_CHKSUM`` is used to track source license | 2339 | The variable ``LIC_FILES_CHKSUM`` is used to track source license |
2340 | changes as described in the | 2340 | changes as described in the |
2341 | ":ref:`dev-manual/dev-manual-common-tasks:tracking license changes`" section in | 2341 | ":ref:`dev-manual/common-tasks:tracking license changes`" section in |
2342 | the Yocto Project Overview and Concepts Manual. You can quickly create | 2342 | the Yocto Project Overview and Concepts Manual. You can quickly create |
2343 | Autotool-based recipes in a manner similar to the previous example. | 2343 | Autotool-based recipes in a manner similar to the previous example. |
2344 | 2344 | ||
@@ -2963,7 +2963,7 @@ The following steps describe how to set up the AUH utility: | |||
2963 | 1. *Be Sure the Development Host is Set Up:* You need to be sure that | 2963 | 1. *Be Sure the Development Host is Set Up:* You need to be sure that |
2964 | your development host is set up to use the Yocto Project. For | 2964 | your development host is set up to use the Yocto Project. For |
2965 | information on how to set up your host, see the | 2965 | information on how to set up your host, see the |
2966 | ":ref:`dev-manual/dev-manual-start:Preparing the Build Host`" section. | 2966 | ":ref:`dev-manual/start:Preparing the Build Host`" section. |
2967 | 2967 | ||
2968 | 2. *Make Sure Git is Configured:* The AUH utility requires Git to be | 2968 | 2. *Make Sure Git is Configured:* The AUH utility requires Git to be |
2969 | configured because AUH uses Git to save upgrades. Thus, you must have | 2969 | configured because AUH uses Git to save upgrades. Thus, you must have |
@@ -3015,7 +3015,7 @@ The following steps describe how to set up the AUH utility: | |||
3015 | configurations: | 3015 | configurations: |
3016 | 3016 | ||
3017 | - If you want to enable :ref:`Build | 3017 | - If you want to enable :ref:`Build |
3018 | History <dev-manual/dev-manual-common-tasks:maintaining build output quality>`, | 3018 | History <dev-manual/common-tasks:maintaining build output quality>`, |
3019 | which is optional, you need the following lines in the | 3019 | which is optional, you need the following lines in the |
3020 | ``conf/local.conf`` file: | 3020 | ``conf/local.conf`` file: |
3021 | :: | 3021 | :: |
@@ -3267,8 +3267,8 @@ Manually Upgrading a Recipe | |||
3267 | --------------------------- | 3267 | --------------------------- |
3268 | 3268 | ||
3269 | If for some reason you choose not to upgrade recipes using | 3269 | If for some reason you choose not to upgrade recipes using |
3270 | :ref:`dev-manual/dev-manual-common-tasks:Using the Auto Upgrade Helper (AUH)` or | 3270 | :ref:`dev-manual/common-tasks:Using the Auto Upgrade Helper (AUH)` or |
3271 | by :ref:`dev-manual/dev-manual-common-tasks:Using \`\`devtool upgrade\`\``, | 3271 | by :ref:`dev-manual/common-tasks:Using \`\`devtool upgrade\`\``, |
3272 | you can manually edit the recipe files to upgrade the versions. | 3272 | you can manually edit the recipe files to upgrade the versions. |
3273 | 3273 | ||
3274 | .. note:: | 3274 | .. note:: |
@@ -3467,7 +3467,7 @@ Follow these general steps: | |||
3467 | (i.e. ``bitbake -c clean package`` and ``bitbake -c cleanall package``). | 3467 | (i.e. ``bitbake -c clean package`` and ``bitbake -c cleanall package``). |
3468 | Modifications will also disappear if you use the ``rm_work`` feature as | 3468 | Modifications will also disappear if you use the ``rm_work`` feature as |
3469 | described in the | 3469 | described in the |
3470 | ":ref:`dev-manual/dev-manual-common-tasks:conserving disk space during builds`" | 3470 | ":ref:`dev-manual/common-tasks:conserving disk space during builds`" |
3471 | section. | 3471 | section. |
3472 | 3472 | ||
3473 | 7. *Generate the Patch:* Once your changes work as expected, you need to | 3473 | 7. *Generate the Patch:* Once your changes work as expected, you need to |
@@ -3667,7 +3667,7 @@ The following figure and list overviews the build process: | |||
3667 | :align: center | 3667 | :align: center |
3668 | 3668 | ||
3669 | 1. *Set up Your Host Development System to Support Development Using the | 3669 | 1. *Set up Your Host Development System to Support Development Using the |
3670 | Yocto Project*: See the ":doc:`dev-manual-start`" section for options on how to get a | 3670 | Yocto Project*: See the ":doc:`start`" section for options on how to get a |
3671 | build host ready to use the Yocto Project. | 3671 | build host ready to use the Yocto Project. |
3672 | 3672 | ||
3673 | 2. *Initialize the Build Environment:* Initialize the build environment | 3673 | 2. *Initialize the Build Environment:* Initialize the build environment |
@@ -4046,7 +4046,7 @@ your own distribution that are likely modeled after ``poky-tiny``. | |||
4046 | 4046 | ||
4047 | To use ``poky-tiny`` in your build, set the ``DISTRO`` variable in your | 4047 | To use ``poky-tiny`` in your build, set the ``DISTRO`` variable in your |
4048 | ``local.conf`` file to "poky-tiny" as described in the | 4048 | ``local.conf`` file to "poky-tiny" as described in the |
4049 | ":ref:`dev-manual/dev-manual-common-tasks:creating your own distribution`" | 4049 | ":ref:`dev-manual/common-tasks:creating your own distribution`" |
4050 | section. | 4050 | section. |
4051 | 4051 | ||
4052 | Understanding some memory concepts will help you reduce the system size. | 4052 | Understanding some memory concepts will help you reduce the system size. |
@@ -5736,7 +5736,7 @@ or :: | |||
5736 | 5736 | ||
5737 | For more information on how to use the ``bmaptool`` | 5737 | For more information on how to use the ``bmaptool`` |
5738 | to flash a device with an image, see the | 5738 | to flash a device with an image, see the |
5739 | ":ref:`dev-manual/dev-manual-common-tasks:flashing images using \`\`bmaptool\`\``" | 5739 | ":ref:`dev-manual/common-tasks:flashing images using \`\`bmaptool\`\``" |
5740 | section. | 5740 | section. |
5741 | 5741 | ||
5742 | Using a Modified Kickstart File | 5742 | Using a Modified Kickstart File |
@@ -5956,7 +5956,7 @@ the existing kernel, and then inserts a new kernel: | |||
5956 | 5956 | ||
5957 | Once the new kernel is added back into the image, you can use the | 5957 | Once the new kernel is added back into the image, you can use the |
5958 | ``dd`` command or :ref:`bmaptool | 5958 | ``dd`` command or :ref:`bmaptool |
5959 | <dev-manual/dev-manual-common-tasks:flashing images using \`\`bmaptool\`\`>` | 5959 | <dev-manual/common-tasks:flashing images using \`\`bmaptool\`\`>` |
5960 | to flash your wic image onto an SD card or USB stick and test your | 5960 | to flash your wic image onto an SD card or USB stick and test your |
5961 | target. | 5961 | target. |
5962 | 5962 | ||
@@ -6202,7 +6202,7 @@ layer. The following steps provide some more detail: | |||
6202 | just placing configurations in a ``local.conf`` configuration file | 6202 | just placing configurations in a ``local.conf`` configuration file |
6203 | makes it easier to reproduce the same build configuration when using | 6203 | makes it easier to reproduce the same build configuration when using |
6204 | multiple build machines. See the | 6204 | multiple build machines. See the |
6205 | ":ref:`dev-manual/dev-manual-common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" | 6205 | ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" |
6206 | section for information on how to quickly set up a layer. | 6206 | section for information on how to quickly set up a layer. |
6207 | 6207 | ||
6208 | - *Create the distribution configuration file:* The distribution | 6208 | - *Create the distribution configuration file:* The distribution |
@@ -7979,7 +7979,7 @@ associated ``EXTRA_IMAGE_FEATURES`` variable, as in: | |||
7979 | EXTRA_IMAGE_FEATURES = "read-only-rootfs" | 7979 | EXTRA_IMAGE_FEATURES = "read-only-rootfs" |
7980 | 7980 | ||
7981 | For more information on how to use these variables, see the | 7981 | For more information on how to use these variables, see the |
7982 | ":ref:`dev-manual/dev-manual-common-tasks:Customizing Images Using Custom \`\`IMAGE_FEATURES\`\` and \`\`EXTRA_IMAGE_FEATURES\`\``" | 7982 | ":ref:`dev-manual/common-tasks:Customizing Images Using Custom \`\`IMAGE_FEATURES\`\` and \`\`EXTRA_IMAGE_FEATURES\`\``" |
7983 | section. For information on the variables, see | 7983 | section. For information on the variables, see |
7984 | :term:`IMAGE_FEATURES` and | 7984 | :term:`IMAGE_FEATURES` and |
7985 | :term:`EXTRA_IMAGE_FEATURES`. | 7985 | :term:`EXTRA_IMAGE_FEATURES`. |
@@ -8056,13 +8056,13 @@ the information. | |||
8056 | 8056 | ||
8057 | The remainder of this section describes the following: | 8057 | The remainder of this section describes the following: |
8058 | 8058 | ||
8059 | - :ref:`How you can enable and disable build history <dev-manual/dev-manual-common-tasks:enabling and disabling build history>` | 8059 | - :ref:`How you can enable and disable build history <dev-manual/common-tasks:enabling and disabling build history>` |
8060 | 8060 | ||
8061 | - :ref:`How to understand what the build history contains <dev-manual/dev-manual-common-tasks:understanding what the build history contains>` | 8061 | - :ref:`How to understand what the build history contains <dev-manual/common-tasks:understanding what the build history contains>` |
8062 | 8062 | ||
8063 | - :ref:`How to limit the information used for build history <dev-manual/dev-manual-common-tasks:using build history to gather image information only>` | 8063 | - :ref:`How to limit the information used for build history <dev-manual/common-tasks:using build history to gather image information only>` |
8064 | 8064 | ||
8065 | - :ref:`How to examine the build history from both a command-line and web interface <dev-manual/dev-manual-common-tasks:examining build history information>` | 8065 | - :ref:`How to examine the build history from both a command-line and web interface <dev-manual/common-tasks:examining build history information>` |
8066 | 8066 | ||
8067 | Enabling and Disabling Build History | 8067 | Enabling and Disabling Build History |
8068 | ------------------------------------ | 8068 | ------------------------------------ |
@@ -9084,7 +9084,7 @@ situations. | |||
9084 | completes to log error information into a common database, that can | 9084 | completes to log error information into a common database, that can |
9085 | help you figure out what might be going wrong. For information on how | 9085 | help you figure out what might be going wrong. For information on how |
9086 | to enable and use this feature, see the | 9086 | to enable and use this feature, see the |
9087 | ":ref:`dev-manual/dev-manual-common-tasks:using the error reporting tool`" | 9087 | ":ref:`dev-manual/common-tasks:using the error reporting tool`" |
9088 | section. | 9088 | section. |
9089 | 9089 | ||
9090 | The following list shows the debugging topics in the remainder of this | 9090 | The following list shows the debugging topics in the remainder of this |
@@ -9100,7 +9100,7 @@ section: | |||
9100 | use the BitBake ``-e`` option to examine variable values after a | 9100 | use the BitBake ``-e`` option to examine variable values after a |
9101 | recipe has been parsed. | 9101 | recipe has been parsed. |
9102 | 9102 | ||
9103 | - ":ref:`dev-manual/dev-manual-common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``" | 9103 | - ":ref:`dev-manual/common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``" |
9104 | describes how to use the ``oe-pkgdata-util`` utility to query | 9104 | describes how to use the ``oe-pkgdata-util`` utility to query |
9105 | :term:`PKGDATA_DIR` and | 9105 | :term:`PKGDATA_DIR` and |
9106 | display package-related information for built packages. | 9106 | display package-related information for built packages. |
@@ -10581,7 +10581,7 @@ Yocto Project Reference Manual. | |||
10581 | 10581 | ||
10582 | Here is the general procedure on how to submit a patch through email | 10582 | Here is the general procedure on how to submit a patch through email |
10583 | without using the scripts once the steps in | 10583 | without using the scripts once the steps in |
10584 | :ref:`dev-manual/dev-manual-common-tasks:preparing changes for submission` have been followed: | 10584 | :ref:`dev-manual/common-tasks:preparing changes for submission` have been followed: |
10585 | 10585 | ||
10586 | 1. *Format the Commit:* Format the commit into an email message. To | 10586 | 1. *Format the Commit:* Format the commit into an email message. To |
10587 | format commits, use the ``git format-patch`` command. When you | 10587 | format commits, use the ``git format-patch`` command. When you |
@@ -10670,7 +10670,7 @@ and ``send-pull-request`` scripts from openembedded-core to create and send a | |||
10670 | patch series with a link to the branch for review. | 10670 | patch series with a link to the branch for review. |
10671 | 10671 | ||
10672 | Follow this procedure to push a change to an upstream "contrib" Git | 10672 | Follow this procedure to push a change to an upstream "contrib" Git |
10673 | repository once the steps in :ref:`dev-manual/dev-manual-common-tasks:preparing changes for submission` have | 10673 | repository once the steps in :ref:`dev-manual/common-tasks:preparing changes for submission` have |
10674 | been followed: | 10674 | been followed: |
10675 | 10675 | ||
10676 | .. note:: | 10676 | .. note:: |
@@ -10845,8 +10845,8 @@ follows: | |||
10845 | a newer version of the software which includes an upstream fix for the | 10845 | a newer version of the software which includes an upstream fix for the |
10846 | issue or when the issue has been fixed on the master branch in a way | 10846 | issue or when the issue has been fixed on the master branch in a way |
10847 | that introduces backwards incompatible changes. In this case follow the | 10847 | that introduces backwards incompatible changes. In this case follow the |
10848 | steps in :ref:`dev-manual/dev-manual-common-tasks:preparing changes for submission` and | 10848 | steps in :ref:`dev-manual/common-tasks:preparing changes for submission` and |
10849 | :ref:`dev-manual/dev-manual-common-tasks:using email to submit a patch` but modify the subject header of your patch | 10849 | :ref:`dev-manual/common-tasks:using email to submit a patch` but modify the subject header of your patch |
10850 | email to include the name of the stable branch which you are | 10850 | email to include the name of the stable branch which you are |
10851 | targetting. This can be done using the ``--subject-prefix`` argument to | 10851 | targetting. This can be done using the ``--subject-prefix`` argument to |
10852 | ``git format-patch``, for example to submit a patch to the dunfell | 10852 | ``git format-patch``, for example to submit a patch to the dunfell |
diff --git a/documentation/dev-manual/index.rst b/documentation/dev-manual/index.rst index 8f09224fe8..941db2df8c 100644 --- a/documentation/dev-manual/index.rst +++ b/documentation/dev-manual/index.rst | |||
@@ -10,10 +10,10 @@ Yocto Project Development Tasks Manual | |||
10 | :caption: Table of Contents | 10 | :caption: Table of Contents |
11 | :numbered: | 11 | :numbered: |
12 | 12 | ||
13 | dev-manual-intro | 13 | intro |
14 | dev-manual-start | 14 | start |
15 | dev-manual-common-tasks | 15 | common-tasks |
16 | dev-manual-qemu | 16 | qemu |
17 | history | 17 | history |
18 | 18 | ||
19 | .. include:: /boilerplate.rst | 19 | .. include:: /boilerplate.rst |
diff --git a/documentation/dev-manual/dev-manual-intro.rst b/documentation/dev-manual/intro.rst index 23c848e870..23c848e870 100644 --- a/documentation/dev-manual/dev-manual-intro.rst +++ b/documentation/dev-manual/intro.rst | |||
diff --git a/documentation/dev-manual/dev-manual-qemu.rst b/documentation/dev-manual/qemu.rst index 4e58fc1b67..4e58fc1b67 100644 --- a/documentation/dev-manual/dev-manual-qemu.rst +++ b/documentation/dev-manual/qemu.rst | |||
diff --git a/documentation/dev-manual/dev-manual-start.rst b/documentation/dev-manual/start.rst index 75b5d7b5f0..85ec97b9e4 100644 --- a/documentation/dev-manual/dev-manual-start.rst +++ b/documentation/dev-manual/start.rst | |||
@@ -7,7 +7,7 @@ Setting Up to Use the Yocto Project | |||
7 | This chapter provides guidance on how to prepare to use the Yocto | 7 | This chapter provides guidance on how to prepare to use the Yocto |
8 | Project. You can learn about creating a team environment to develop | 8 | Project. You can learn about creating a team environment to develop |
9 | using the Yocto Project, how to set up a :ref:`build | 9 | using the Yocto Project, how to set up a :ref:`build |
10 | host <dev-manual/dev-manual-start:preparing the build host>`, how to locate | 10 | host <dev-manual/start:preparing the build host>`, how to locate |
11 | Yocto Project source repositories, and how to create local Git | 11 | Yocto Project source repositories, and how to create local Git |
12 | repositories. | 12 | repositories. |
13 | 13 | ||
@@ -224,7 +224,7 @@ particular working environment and set of practices. | |||
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/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/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 |
@@ -248,13 +248,13 @@ particular working environment and set of practices. | |||
248 | project to fix bugs or add features. If you do submit patches, | 248 | project to fix bugs or add features. If you do submit patches, |
249 | follow the project commit guidelines for writing good commit | 249 | follow the project commit guidelines for writing good commit |
250 | messages. See the | 250 | messages. See the |
251 | ":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" | 251 | ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" |
252 | section. | 252 | section. |
253 | 253 | ||
254 | - Send changes to the core sooner than later as others are likely | 254 | - Send changes to the core sooner than later as others are likely |
255 | to run into the same issues. For some guidance on mailing lists | 255 | to run into the same issues. For some guidance on mailing lists |
256 | to use, see the list in the | 256 | to use, see the list in the |
257 | ":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" | 257 | ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" |
258 | section. For a description | 258 | section. For a description |
259 | of the available mailing lists, see the ":ref:`resources-mailinglist`" section in | 259 | of the available mailing lists, see the ":ref:`resources-mailinglist`" section in |
260 | the Yocto Project Reference Manual. | 260 | the Yocto Project Reference Manual. |
@@ -340,7 +340,7 @@ Project Build Host: | |||
340 | Once you have completed the previous steps, you are ready to continue | 340 | Once you have completed the previous steps, you are ready to continue |
341 | using a given development path on your native Linux machine. If you are | 341 | using a given development path on your native Linux machine. If you are |
342 | going to use BitBake, see the | 342 | going to use BitBake, see the |
343 | ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" | 343 | ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`" |
344 | section. If you are going | 344 | section. If you are going |
345 | to use the Extensible SDK, see the ":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto | 345 | to use the Extensible SDK, see the ":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto |
346 | Project Application Development and the Extensible Software Development | 346 | Project Application Development and the Extensible Software Development |
@@ -440,7 +440,7 @@ as your Yocto Project build host: | |||
440 | Once you have a container set up, everything is in place to develop just | 440 | Once you have a container set up, everything is in place to develop just |
441 | as if you were running on a native Linux machine. If you are going to | 441 | as if you were running on a native Linux machine. If you are going to |
442 | use the Poky container, see the | 442 | use the Poky container, see the |
443 | ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" | 443 | ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`" |
444 | section. If you are going to use the Extensible SDK container, see the | 444 | section. If you are going to use the Extensible SDK container, see the |
445 | ":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto | 445 | ":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto |
446 | Project Application Development and the Extensible Software Development | 446 | Project Application Development and the Extensible Software Development |
@@ -582,7 +582,7 @@ files you'll need to work with the Yocto Project. | |||
582 | Accessing Source Repositories | 582 | Accessing Source Repositories |
583 | ----------------------------- | 583 | ----------------------------- |
584 | 584 | ||
585 | Working from a copy of the upstream :ref:`dev-manual/dev-manual-start:accessing source repositories` is the | 585 | Working from a copy of the upstream :ref:`dev-manual/start:accessing source repositories` is the |
586 | preferred method for obtaining and using a Yocto Project release. You | 586 | preferred method for obtaining and using a Yocto Project release. You |
587 | can view the Yocto Project Source Repositories at | 587 | can view the Yocto Project Source Repositories at |
588 | :yocto_git:`/`. In particular, you can find the ``poky`` | 588 | :yocto_git:`/`. In particular, you can find the ``poky`` |
@@ -605,7 +605,7 @@ Use the following procedure to locate the latest upstream copy of the | |||
605 | .. note:: | 605 | .. note:: |
606 | 606 | ||
607 | For information on cloning a repository, see the | 607 | For information on cloning a repository, see the |
608 | ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" section. | 608 | ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`" section. |
609 | 609 | ||
610 | Accessing Index of Releases | 610 | Accessing Index of Releases |
611 | --------------------------- | 611 | --------------------------- |
@@ -801,7 +801,7 @@ and then specifically check out that development branch. | |||
801 | 1. *Switch to the Poky Directory:* If you have a local poky Git | 801 | 1. *Switch to the Poky Directory:* If you have a local poky Git |
802 | repository, switch to that directory. If you do not have the local | 802 | repository, switch to that directory. If you do not have the local |
803 | copy of poky, see the | 803 | copy of poky, see the |
804 | ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" | 804 | ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`" |
805 | section. | 805 | section. |
806 | 806 | ||
807 | 2. *Determine Existing Branch Names:* | 807 | 2. *Determine Existing Branch Names:* |
@@ -864,7 +864,7 @@ similar to checking out by branch name except you use tag names. | |||
864 | 1. *Switch to the Poky Directory:* If you have a local poky Git | 864 | 1. *Switch to the Poky Directory:* If you have a local poky Git |
865 | repository, switch to that directory. If you do not have the local | 865 | repository, switch to that directory. If you do not have the local |
866 | copy of poky, see the | 866 | copy of poky, see the |
867 | ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" | 867 | ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`" |
868 | section. | 868 | section. |
869 | 869 | ||
870 | 2. *Fetch the Tag Names:* To checkout the branch based on a tag name, | 870 | 2. *Fetch the Tag Names:* To checkout the branch based on a tag name, |