diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-10-13 08:42:10 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-12-01 19:20:29 +0000 |
commit | 55621c31f1edbdb2f3d72e80916fed031e2ba298 (patch) | |
tree | 49499b82a28ed611fb478605e11fa173294f1e87 /documentation/dev-manual | |
parent | 7ecd9877e6a1b235070d6feba59a3840ebbc5255 (diff) | |
download | poky-55621c31f1edbdb2f3d72e80916fed031e2ba298.tar.gz |
manuals: add missing references to classes
Sometimes fixing line length in modified paragraphs too.
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 885b60f5540849bf19240a01a77efce1d1b5d9f0)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r-- | documentation/dev-manual/common-tasks.rst | 30 |
1 files changed, 16 insertions, 14 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index b9c467526a..96a6a76180 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
@@ -1855,9 +1855,10 @@ Here are some common issues that cause failures. | |||
1855 | ":ref:`dev-manual/common-tasks:debugging parallel make races`" section. | 1855 | ":ref:`dev-manual/common-tasks:debugging parallel make races`" section. |
1856 | 1856 | ||
1857 | - *Improper host path usage:* This failure applies to recipes building | 1857 | - *Improper host path usage:* This failure applies to recipes building |
1858 | for the target or ``nativesdk`` only. The failure occurs when the | 1858 | for the target or ":ref:`nativesdk <ref-classes-nativesdk>`" only. The |
1859 | compilation process uses improper headers, libraries, or other files | 1859 | failure occurs when the compilation process uses improper headers, |
1860 | from the host system when cross-compiling for the target. | 1860 | libraries, or other files from the host system when cross-compiling for |
1861 | the target. | ||
1861 | 1862 | ||
1862 | To fix the problem, examine the ``log.do_compile`` file to identify | 1863 | To fix the problem, examine the ``log.do_compile`` file to identify |
1863 | the host paths being used (e.g. ``/usr/include``, ``/usr/lib``, and | 1864 | the host paths being used (e.g. ``/usr/include``, ``/usr/lib``, and |
@@ -3404,7 +3405,7 @@ form of a patch all using Quilt. | |||
3404 | .. note:: | 3405 | .. note:: |
3405 | 3406 | ||
3406 | With regard to preserving changes to source files, if you clean a | 3407 | With regard to preserving changes to source files, if you clean a |
3407 | recipe or have ``rm_work`` enabled, the | 3408 | recipe or have :ref:`rm_work <ref-classes-rm-work>` enabled, the |
3408 | :ref:`devtool workflow <sdk-manual/extensible:using \`\`devtool\`\` in your sdk workflow>` | 3409 | :ref:`devtool workflow <sdk-manual/extensible:using \`\`devtool\`\` in your sdk workflow>` |
3409 | as described in the Yocto Project Application Development and the | 3410 | as described in the Yocto Project Application Development and the |
3410 | Extensible Software Development Kit (eSDK) manual is a safer | 3411 | Extensible Software Development Kit (eSDK) manual is a safer |
@@ -3450,11 +3451,11 @@ Follow these general steps: | |||
3450 | .. note:: | 3451 | .. note:: |
3451 | 3452 | ||
3452 | All the modifications you make to the temporary source code disappear | 3453 | All the modifications you make to the temporary source code disappear |
3453 | once you run the :ref:`ref-tasks-clean` or :ref:`ref-tasks-cleanall` tasks using BitBake | 3454 | once you run the :ref:`ref-tasks-clean` or :ref:`ref-tasks-cleanall` |
3454 | (i.e. ``bitbake -c clean package`` and ``bitbake -c cleanall package``). | 3455 | tasks using BitBake (i.e. ``bitbake -c clean package`` and |
3455 | Modifications will also disappear if you use the ``rm_work`` feature as | 3456 | ``bitbake -c cleanall package``). Modifications will also disappear if |
3456 | described in the | 3457 | you use the :ref:`rm_work <ref-classes-rm-work>` feature as described in |
3457 | ":ref:`dev-manual/common-tasks:conserving disk space during builds`" | 3458 | the ":ref:`dev-manual/common-tasks:conserving disk space during builds`" |
3458 | section. | 3459 | section. |
3459 | 3460 | ||
3460 | 7. *Generate the Patch:* Once your changes work as expected, you need to | 3461 | 7. *Generate the Patch:* Once your changes work as expected, you need to |
@@ -7143,7 +7144,8 @@ Lighttpd, or Nginx), take the appropriate steps to do so. | |||
7143 | From within the :term:`Build Directory` where you have built an image based on | 7144 | From within the :term:`Build Directory` where you have built an image based on |
7144 | your packaging choice (i.e. the :term:`PACKAGE_CLASSES` setting), simply start | 7145 | your packaging choice (i.e. the :term:`PACKAGE_CLASSES` setting), simply start |
7145 | the server. The following example assumes a :term:`Build Directory` of ``poky/build`` | 7146 | the server. The following example assumes a :term:`Build Directory` of ``poky/build`` |
7146 | and a :term:`PACKAGE_CLASSES` setting of "package_rpm":: | 7147 | and a :term:`PACKAGE_CLASSES` setting of |
7148 | ":ref:`package_rpm <ref-classes-package_rpm>`":: | ||
7147 | 7149 | ||
7148 | $ cd poky/build/tmp/deploy/rpm | 7150 | $ cd poky/build/tmp/deploy/rpm |
7149 | $ python3 -m http.server | 7151 | $ python3 -m http.server |
@@ -7491,8 +7493,8 @@ test. Here is what you have to do for each recipe: | |||
7491 | special configurations prior to compiling the test code, you must | 7493 | special configurations prior to compiling the test code, you must |
7492 | insert a ``do_configure_ptest`` function into the recipe. | 7494 | insert a ``do_configure_ptest`` function into the recipe. |
7493 | 7495 | ||
7494 | - *Install the test suite:* The ``ptest`` class automatically copies | 7496 | - *Install the test suite:* The :ref:`ptest <ref-classes-ptest>` class |
7495 | the file ``run-ptest`` to the target and then runs make | 7497 | automatically copies the file ``run-ptest`` to the target and then runs make |
7496 | ``install-ptest`` to run the tests. If this is not enough, you need | 7498 | ``install-ptest`` to run the tests. If this is not enough, you need |
7497 | to create a ``do_install_ptest`` function and make sure it gets | 7499 | to create a ``do_install_ptest`` function and make sure it gets |
7498 | called after the "make install-ptest" completes. | 7500 | called after the "make install-ptest" completes. |
@@ -11237,7 +11239,7 @@ an :ref:`archiver <ref-classes-archiver>` class to | |||
11237 | help avoid some of these concerns. | 11239 | help avoid some of these concerns. |
11238 | 11240 | ||
11239 | Before you employ :term:`DL_DIR` or the :ref:`archiver <ref-classes-archiver>` class, you need to | 11241 | Before you employ :term:`DL_DIR` or the :ref:`archiver <ref-classes-archiver>` class, you need to |
11240 | decide how you choose to provide source. The source ``archiver`` class | 11242 | decide how you choose to provide source. The source :ref:`archiver <ref-classes-archiver>` class |
11241 | can generate tarballs and SRPMs and can create them with various levels | 11243 | can generate tarballs and SRPMs and can create them with various levels |
11242 | of compliance in mind. | 11244 | of compliance in mind. |
11243 | 11245 | ||
@@ -11325,7 +11327,7 @@ generation are included on your image. | |||
11325 | adds a separate package and an upgrade path for adding licenses to an | 11327 | adds a separate package and an upgrade path for adding licenses to an |
11326 | image. | 11328 | image. |
11327 | 11329 | ||
11328 | As the source ``archiver`` class has already archived the original | 11330 | As the source :ref:`archiver <ref-classes-archiver>` class has already archived the original |
11329 | unmodified source that contains the license files, you would have | 11331 | unmodified source that contains the license files, you would have |
11330 | already met the requirements for inclusion of the license information | 11332 | already met the requirements for inclusion of the license information |
11331 | with source as defined by the GPL and other open source licenses. | 11333 | with source as defined by the GPL and other open source licenses. |