diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-12-03 22:38:43 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-12-09 12:21:27 +0000 |
commit | b70318797c598db4cfda28226ac4c535235c9d1b (patch) | |
tree | 4f9c7f2cebb12356270779fbeb6b2f44f68622f0 /documentation/dev-manual | |
parent | 79fecb25e15178ad1a0f56233a2d514340c14ab5 (diff) | |
download | poky-b70318797c598db4cfda28226ac4c535235c9d1b.tar.gz |
ref-manual: remove 'ref' 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: bb7e4783f45a5f67e6e4b39968f3512f43738833)
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 | 24 | ||||
-rw-r--r-- | documentation/dev-manual/start.rst | 4 |
2 files changed, 14 insertions, 14 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 6c4220dd58..ada3bac7e1 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
@@ -935,7 +935,7 @@ configures the image you are working with to include | |||
935 | 935 | ||
936 | .. note:: | 936 | .. note:: |
937 | 937 | ||
938 | See the ":ref:`ref-manual/ref-features:image features`" section in the Yocto | 938 | See the ":ref:`ref-manual/features:image features`" section in the Yocto |
939 | Project Reference Manual for a complete list of image features that ship | 939 | Project Reference Manual for a complete list of image features that ship |
940 | with the Yocto Project. | 940 | with the Yocto Project. |
941 | 941 | ||
@@ -1076,7 +1076,7 @@ how to create, write, and test a new recipe. | |||
1076 | 1076 | ||
1077 | For information on variables that are useful for recipes and for | 1077 | For information on variables that are useful for recipes and for |
1078 | information about recipe naming issues, see the | 1078 | information about recipe naming issues, see the |
1079 | ":ref:`ref-manual/ref-varlocality:recipes`" section of the Yocto Project | 1079 | ":ref:`ref-manual/varlocality:recipes`" section of the Yocto Project |
1080 | Reference Manual. | 1080 | Reference Manual. |
1081 | 1081 | ||
1082 | Overview | 1082 | Overview |
@@ -1978,7 +1978,7 @@ take. The following list describes the process: | |||
1978 | of common problems that show up during runtime. For information on | 1978 | of common problems that show up during runtime. For information on |
1979 | these checks, see the | 1979 | these checks, see the |
1980 | :ref:`insane <ref-classes-insane>` class and | 1980 | :ref:`insane <ref-classes-insane>` class and |
1981 | the ":ref:`ref-manual/ref-qa-checks:qa error and warning messages`" | 1981 | the ":ref:`ref-manual/qa-checks:qa error and warning messages`" |
1982 | chapter in the Yocto Project Reference Manual. | 1982 | chapter in the Yocto Project Reference Manual. |
1983 | 1983 | ||
1984 | - *Hand-Checking Your Packages*: After you build your software, you | 1984 | - *Hand-Checking Your Packages*: After you build your software, you |
@@ -3127,7 +3127,7 @@ Using ``devtool upgrade`` | |||
3127 | 3127 | ||
3128 | As mentioned earlier, an alternative method for upgrading recipes to | 3128 | As mentioned earlier, an alternative method for upgrading recipes to |
3129 | newer versions is to use | 3129 | newer versions is to use |
3130 | :doc:`devtool upgrade </ref-manual/ref-devtool-reference>`. | 3130 | :doc:`devtool upgrade </ref-manual/devtool-reference>`. |
3131 | You can read about ``devtool upgrade`` in general in the | 3131 | You can read about ``devtool upgrade`` in general in the |
3132 | ":ref:`sdk-manual/extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" | 3132 | ":ref:`sdk-manual/extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" |
3133 | section in the Yocto Project Application Development and the Extensible | 3133 | section in the Yocto Project Application Development and the Extensible |
@@ -3714,7 +3714,7 @@ The following figure and list overviews the build process: | |||
3714 | can be the name of a recipe for a specific piece of software such as | 3714 | can be the name of a recipe for a specific piece of software such as |
3715 | BusyBox. For more details about the images the OpenEmbedded build | 3715 | BusyBox. For more details about the images the OpenEmbedded build |
3716 | system supports, see the | 3716 | system supports, see the |
3717 | ":ref:`ref-manual/ref-images:Images`" chapter in the Yocto | 3717 | ":ref:`ref-manual/images:Images`" chapter in the Yocto |
3718 | Project Reference Manual. | 3718 | Project Reference Manual. |
3719 | 3719 | ||
3720 | As an example, the following command builds the | 3720 | As an example, the following command builds the |
@@ -5234,7 +5234,7 @@ particular system. | |||
5234 | .. note:: | 5234 | .. note:: |
5235 | 5235 | ||
5236 | For a kickstart file reference, see the | 5236 | For a kickstart file reference, see the |
5237 | ":ref:`ref-manual/ref-kickstart:openembedded kickstart (\`\`.wks\`\`) reference`" | 5237 | ":ref:`ref-manual/kickstart:openembedded kickstart (\`\`.wks\`\`) reference`" |
5238 | Chapter in the Yocto Project Reference Manual. | 5238 | Chapter in the Yocto Project Reference Manual. |
5239 | 5239 | ||
5240 | The ``wic`` command and the infrastructure it is based on is by | 5240 | The ``wic`` command and the infrastructure it is based on is by |
@@ -7418,7 +7418,7 @@ Creating Node Package Manager (NPM) Packages | |||
7418 | manager for the JavaScript programming language. The Yocto Project | 7418 | manager for the JavaScript programming language. The Yocto Project |
7419 | supports the NPM :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`. You can | 7419 | supports the NPM :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`. You can |
7420 | use this fetcher in combination with | 7420 | use this fetcher in combination with |
7421 | :doc:`devtool </ref-manual/ref-devtool-reference>` to create | 7421 | :doc:`devtool </ref-manual/devtool-reference>` to create |
7422 | recipes that produce NPM packages. | 7422 | recipes that produce NPM packages. |
7423 | 7423 | ||
7424 | Two workflows exist that allow you to create NPM packages using | 7424 | Two workflows exist that allow you to create NPM packages using |
@@ -7446,7 +7446,7 @@ NPM packages: | |||
7446 | is NPM's public registry. | 7446 | is NPM's public registry. |
7447 | 7447 | ||
7448 | - Be familiar with | 7448 | - Be familiar with |
7449 | :doc:`devtool </ref-manual/ref-devtool-reference>`. | 7449 | :doc:`devtool </ref-manual/devtool-reference>`. |
7450 | 7450 | ||
7451 | - The NPM host tools need the native ``nodejs-npm`` package, which is | 7451 | - The NPM host tools need the native ``nodejs-npm`` package, which is |
7452 | part of the OpenEmbedded environment. You need to get the package by | 7452 | part of the OpenEmbedded environment. You need to get the package by |
@@ -8452,7 +8452,7 @@ you set up the environment to use these tests, run available tests, and | |||
8452 | write and add your own tests. | 8452 | write and add your own tests. |
8453 | 8453 | ||
8454 | For information on the test and QA infrastructure available within the | 8454 | For information on the test and QA infrastructure available within the |
8455 | Yocto Project, see the ":ref:`ref-manual/ref-release-process:testing and quality assurance`" | 8455 | Yocto Project, see the ":ref:`ref-manual/release-process:testing and quality assurance`" |
8456 | section in the Yocto Project Reference Manual. | 8456 | section in the Yocto Project Reference Manual. |
8457 | 8457 | ||
8458 | Enabling Tests | 8458 | Enabling Tests |
@@ -9224,7 +9224,7 @@ In addition to variable values, the output of the ``bitbake -e`` and | |||
9224 | - The output starts with a tree listing all configuration files and | 9224 | - The output starts with a tree listing all configuration files and |
9225 | classes included globally, recursively listing the files they include | 9225 | classes included globally, recursively listing the files they include |
9226 | or inherit in turn. Much of the behavior of the OpenEmbedded build | 9226 | or inherit in turn. Much of the behavior of the OpenEmbedded build |
9227 | system (including the behavior of the :ref:`ref-manual/ref-tasks:normal recipe build tasks`) is | 9227 | system (including the behavior of the :ref:`ref-manual/tasks:normal recipe build tasks`) is |
9228 | implemented in the | 9228 | implemented in the |
9229 | :ref:`base <ref-classes-base>` class and the | 9229 | :ref:`base <ref-classes-base>` class and the |
9230 | classes it inherits, rather than being built into BitBake itself. | 9230 | classes it inherits, rather than being built into BitBake itself. |
@@ -9564,7 +9564,7 @@ compile. BitBake recognizes that the ``do_compile`` task was rerun and | |||
9564 | therefore understands that the other tasks also need to be run again. | 9564 | therefore understands that the other tasks also need to be run again. |
9565 | 9565 | ||
9566 | Another, shorter way to rerun a task and all | 9566 | Another, shorter way to rerun a task and all |
9567 | :ref:`ref-manual/ref-tasks:normal recipe build tasks` | 9567 | :ref:`ref-manual/tasks:normal recipe build tasks` |
9568 | that depend on it is to use the ``-C`` option. | 9568 | that depend on it is to use the ``-C`` option. |
9569 | 9569 | ||
9570 | .. note:: | 9570 | .. note:: |
@@ -9998,7 +9998,7 @@ GDB allows you to examine running programs, which in turn helps you to | |||
9998 | understand and fix problems. It also allows you to perform post-mortem | 9998 | understand and fix problems. It also allows you to perform post-mortem |
9999 | style analysis of program crashes. GDB is available as a package within | 9999 | style analysis of program crashes. GDB is available as a package within |
10000 | the Yocto Project and is installed in SDK images by default. See the | 10000 | the Yocto Project and is installed in SDK images by default. See the |
10001 | ":ref:`ref-manual/ref-images:Images`" chapter in the Yocto | 10001 | ":ref:`ref-manual/images:Images`" chapter in the Yocto |
10002 | Project Reference Manual for a description of these images. You can find | 10002 | Project Reference Manual for a description of these images. You can find |
10003 | information on GDB at https://sourceware.org/gdb/. | 10003 | information on GDB at https://sourceware.org/gdb/. |
10004 | 10004 | ||
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 6fad4c9b4c..03061a79f3 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst | |||
@@ -325,7 +325,7 @@ Project Build Host: | |||
325 | If your build host does not meet any of these three listed version | 325 | If your build host does not meet any of these three listed version |
326 | requirements, you can take steps to prepare the system so that you | 326 | requirements, you can take steps to prepare the system so that you |
327 | can still use the Yocto Project. See the | 327 | can still use the Yocto Project. See the |
328 | ":ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions`" | 328 | ":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`" |
329 | section in the Yocto Project Reference Manual for information. | 329 | section in the Yocto Project Reference Manual for information. |
330 | 330 | ||
331 | 4. *Install Development Host Packages:* Required development host | 331 | 4. *Install Development Host Packages:* Required development host |
@@ -334,7 +334,7 @@ Project Build Host: | |||
334 | is large if you want to be able to cover all cases. | 334 | is large if you want to be able to cover all cases. |
335 | 335 | ||
336 | For lists of required packages for all scenarios, see the | 336 | For lists of required packages for all scenarios, see the |
337 | ":ref:`ref-manual/ref-system-requirements:required packages for the build host`" | 337 | ":ref:`ref-manual/system-requirements:required packages for the build host`" |
338 | section in the Yocto Project Reference Manual. | 338 | section in the Yocto Project Reference Manual. |
339 | 339 | ||
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 |