From af6f5d821d39b50c3c4b45a593324346fce0d723 Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Thu, 3 Dec 2020 22:38:38 +0100 Subject: 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 Signed-off-by: Richard Purdie --- documentation/ref-manual/faq.rst | 6 +- documentation/ref-manual/migration-1.4.rst | 2 +- documentation/ref-manual/migration-1.5.rst | 4 +- documentation/ref-manual/migration-1.6.rst | 6 +- documentation/ref-manual/migration-1.7.rst | 2 +- documentation/ref-manual/migration-2.1.rst | 2 +- documentation/ref-manual/migration-2.3.rst | 2 +- documentation/ref-manual/migration-2.5.rst | 2 +- documentation/ref-manual/migration-2.6.rst | 2 +- documentation/ref-manual/ref-classes.rst | 34 +++---- documentation/ref-manual/ref-devtool-reference.rst | 4 +- documentation/ref-manual/ref-features.rst | 6 +- documentation/ref-manual/ref-images.rst | 4 +- documentation/ref-manual/ref-kickstart.rst | 2 +- documentation/ref-manual/ref-release-process.rst | 6 +- documentation/ref-manual/ref-structure.rst | 14 +-- .../ref-manual/ref-system-requirements.rst | 2 +- documentation/ref-manual/ref-tasks.rst | 10 +- documentation/ref-manual/ref-terms.rst | 4 +- documentation/ref-manual/ref-variables.rst | 104 ++++++++++----------- documentation/ref-manual/resources.rst | 4 +- 21 files changed, 111 insertions(+), 111 deletions(-) (limited to 'documentation/ref-manual') diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index 819b6857d9..5b9fcc1912 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst @@ -45,7 +45,7 @@ section for steps on how to update your build tools. **A:** Support for an additional board is added by creating a Board Support Package (BSP) layer for it. For more information on how to create a BSP layer, see the -":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" +":ref:`dev-manual/common-tasks:understanding and creating layers`" section in the Yocto Project Development Tasks Manual and the :doc:`/bsp-guide/index`. @@ -73,7 +73,7 @@ device. **A:** To add a package, you need to create a BitBake recipe. For information on how to create a BitBake recipe, see the -":ref:`dev-manual/dev-manual-common-tasks:writing a new recipe`" +":ref:`dev-manual/common-tasks:writing a new recipe`" section in the Yocto Project Development Tasks Manual. **Q:** Do I have to reflash my entire board with a new Yocto Project @@ -201,7 +201,7 @@ You can find more information on licensing in the ":ref:`overview-manual/overview-manual-development-environment:licensing`" section in the Yocto Project Overview and Concepts Manual and also in the -":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`" +":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" section in the Yocto Project Development Tasks Manual. **Q:** How do I disable the cursor on my touchscreen device? diff --git a/documentation/ref-manual/migration-1.4.rst b/documentation/ref-manual/migration-1.4.rst index daaea0ffa2..0b7e861176 100644 --- a/documentation/ref-manual/migration-1.4.rst +++ b/documentation/ref-manual/migration-1.4.rst @@ -84,7 +84,7 @@ create an append file for the ``init-ifupdown`` recipe instead, which you can find in the :term:`Source Directory` at ``meta/recipes-core/init-ifupdown``. For information on how to use append files, see the -":ref:`dev-manual/dev-manual-common-tasks:using .bbappend files in your layer`" +":ref:`dev-manual/common-tasks:using .bbappend files in your layer`" section in the Yocto Project Development Tasks Manual. .. _migration-1.4-remote-debugging: diff --git a/documentation/ref-manual/migration-1.5.rst b/documentation/ref-manual/migration-1.5.rst index 5e1e23f216..b5e4bb1fd1 100644 --- a/documentation/ref-manual/migration-1.5.rst +++ b/documentation/ref-manual/migration-1.5.rst @@ -246,7 +246,7 @@ A new automated image testing framework has been added through the framework replaces the older ``imagetest-qemu`` framework. You can learn more about performing automated image tests in the -":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" +":ref:`dev-manual/common-tasks:performing automated runtime testing`" section in the Yocto Project Development Tasks Manual. .. _migration-1.5-build-history: @@ -269,7 +269,7 @@ Following are changes to Build History: option for each utility for more information on the new syntax. For more information on Build History, see the -":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`" +":ref:`dev-manual/common-tasks:maintaining build output quality`" section in the Yocto Project Development Tasks Manual. .. _migration-1.5-udev: diff --git a/documentation/ref-manual/migration-1.6.rst b/documentation/ref-manual/migration-1.6.rst index 822d5cfa03..f95f45ec9f 100644 --- a/documentation/ref-manual/migration-1.6.rst +++ b/documentation/ref-manual/migration-1.6.rst @@ -12,7 +12,7 @@ Project 1.6 Release from the prior release. The :ref:`archiver ` class has been rewritten and its configuration has been simplified. For more details on the source archiver, see the -":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`" +":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" section in the Yocto Project Development Tasks Manual. .. _migration-1.6-packaging-changes: @@ -148,7 +148,7 @@ NFS mount, an error occurs. The ``PRINC`` variable has been deprecated and triggers a warning if detected during a build. For :term:`PR` increments on changes, use the PR service instead. You can find out more about this service in -the ":ref:`dev-manual/dev-manual-common-tasks:working with a pr service`" +the ":ref:`dev-manual/common-tasks:working with a pr service`" section in the Yocto Project Development Tasks Manual. .. _migration-1.6-variable-changes-IMAGE_TYPES: @@ -221,7 +221,7 @@ Package Test (ptest) Package Tests (ptest) are built but not installed by default. For information on using Package Tests, see the -":ref:`dev-manual/dev-manual-common-tasks:testing packages with ptest`" +":ref:`dev-manual/common-tasks:testing packages with ptest`" section in the Yocto Project Development Tasks Manual. For information on the ``ptest`` class, see the ":ref:`ptest.bbclass `" section. diff --git a/documentation/ref-manual/migration-1.7.rst b/documentation/ref-manual/migration-1.7.rst index c3f9469da1..85894d9df7 100644 --- a/documentation/ref-manual/migration-1.7.rst +++ b/documentation/ref-manual/migration-1.7.rst @@ -217,7 +217,7 @@ The following miscellaneous change occurred: should manually remove old "build-id" files from your existing build history repositories to avoid confusion. For information on the build history feature, see the - ":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`" + ":ref:`dev-manual/common-tasks:maintaining build output quality`" section in the Yocto Project Development Tasks Manual. diff --git a/documentation/ref-manual/migration-2.1.rst b/documentation/ref-manual/migration-2.1.rst index ada9d2986c..678a767e15 100644 --- a/documentation/ref-manual/migration-2.1.rst +++ b/documentation/ref-manual/migration-2.1.rst @@ -346,7 +346,7 @@ This release supports generation of GLib Introspective Repository (GIR) files through GObject introspection, which is the standard mechanism for accessing GObject-based software from runtime environments. You can enable, disable, and test the generation of this data. See the -":ref:`dev-manual/dev-manual-common-tasks:enabling gobject introspection support`" +":ref:`dev-manual/common-tasks:enabling gobject introspection support`" section in the Yocto Project Development Tasks Manual for more information. diff --git a/documentation/ref-manual/migration-2.3.rst b/documentation/ref-manual/migration-2.3.rst index c0a8f04195..9e95f45e1f 100644 --- a/documentation/ref-manual/migration-2.3.rst +++ b/documentation/ref-manual/migration-2.3.rst @@ -366,7 +366,7 @@ The following changes have been made to Wic: .. note:: For more information on Wic, see the - ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" + ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" section in the Yocto Project Development Tasks Manual. - *Default Output Directory Changed:* Wic's default output directory is diff --git a/documentation/ref-manual/migration-2.5.rst b/documentation/ref-manual/migration-2.5.rst index 7f1b80938f..9f45ffce76 100644 --- a/documentation/ref-manual/migration-2.5.rst +++ b/documentation/ref-manual/migration-2.5.rst @@ -266,7 +266,7 @@ The following are additional changes: will trigger a warning during ``do_rootfs``. For more information, see the - ":ref:`dev-manual/dev-manual-common-tasks:post-installation scripts`" + ":ref:`dev-manual/common-tasks:post-installation scripts`" section in the Yocto Project Development Tasks Manual. - The ``elf`` image type has been removed. This image type was removed diff --git a/documentation/ref-manual/migration-2.6.rst b/documentation/ref-manual/migration-2.6.rst index cc7c24c5b1..5d524f3817 100644 --- a/documentation/ref-manual/migration-2.6.rst +++ b/documentation/ref-manual/migration-2.6.rst @@ -372,7 +372,7 @@ Any failure of a ``pkg_postinst()`` script (including exit 1) triggers an error during the :ref:`ref-tasks-rootfs` task. For more information on post-installation behavior, see the -":ref:`dev-manual/dev-manual-common-tasks:post-installation scripts`" +":ref:`dev-manual/common-tasks:post-installation scripts`" section in the Yocto Project Development Tasks Manual. .. _migration-2.6-python-3-profile-guided-optimizations: diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst index e0cdbe87fa..4147044ea3 100644 --- a/documentation/ref-manual/ref-classes.rst +++ b/documentation/ref-manual/ref-classes.rst @@ -68,7 +68,7 @@ The ``archiver`` class supports releasing source code and other materials with the binaries. For more details on the source archiver, see the -":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`" +":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" section in the Yocto Project Development Tasks Manual. You can also see the :term:`ARCHIVER_MODE` variable for information about the variable flags (varflags) that help control archive creation. @@ -86,7 +86,7 @@ standardization. This class defines a set of tasks (e.g. ``configure``, should usually be enough to define a few standard variables and then simply ``inherit autotools``. These classes can also work with software that emulates Autotools. For more information, see the -":ref:`dev-manual/dev-manual-common-tasks:autotooled package`" section +":ref:`dev-manual/common-tasks:autotooled package`" section in the Yocto Project Development Tasks Manual. By default, the ``autotools*`` classes use out-of-tree builds (i.e. @@ -236,7 +236,7 @@ The ``buildhistory`` class records a history of build output metadata, which can be used to detect possible regressions as well as used for analysis of the build output. For more information on using Build History, see the -":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`" +":ref:`dev-manual/common-tasks:maintaining build output quality`" section in the Yocto Project Development Tasks Manual. .. _ref-classes-buildstats: @@ -458,7 +458,7 @@ staging the files from ``DEPLOYDIR`` to ``DEPLOY_DIR_IMAGE``. ==================== The ``devshell`` class adds the ``do_devshell`` task. Distribution -policy dictates whether to include this class. See the ":ref:`dev-manual/dev-manual-common-tasks:using a development shell`" +policy dictates whether to include this class. See the ":ref:`dev-manual/common-tasks:using a development shell`" section in the Yocto Project Development Tasks Manual for more information about using ``devshell``. @@ -586,7 +586,7 @@ For more information on the ``externalsrc`` class, see the comments in ``meta/classes/externalsrc.bbclass`` in the :term:`Source Directory`. For information on how to use the ``externalsrc`` class, see the -":ref:`dev-manual/dev-manual-common-tasks:building software from an external source`" +":ref:`dev-manual/common-tasks:building software from an external source`" section in the Yocto Project Development Tasks Manual. .. _ref-classes-extrausers: @@ -927,7 +927,7 @@ then one or more image files are created. install into the image. For information on customizing images, see the -":ref:`dev-manual/dev-manual-common-tasks:customizing images`" section +":ref:`dev-manual/common-tasks:customizing images`" section in the Yocto Project Development Tasks Manual. For information on how images are created, see the ":ref:`overview-manual/overview-manual-concepts:images`" section in the @@ -1344,7 +1344,7 @@ packages such as ``kernel-vmlinux``. The ``kernel`` class contains logic that allows you to embed an initial RAM filesystem (initramfs) image when you build the kernel image. For information on how to build an initramfs, see the -":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section in +":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section in the Yocto Project Development Tasks Manual. Various other classes are used by the ``kernel`` and ``module`` classes @@ -1620,7 +1620,7 @@ different target optimizations or target architectures and installing them side-by-side in the same image. For more information on using the Multilib feature, see the -":ref:`dev-manual/dev-manual-common-tasks:combining multiple versions of library files into one image`" +":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`" section in the Yocto Project Development Tasks Manual. .. _ref-classes-native: @@ -1732,7 +1732,7 @@ package manager (NPM) `__. fetcher to have dependencies fetched and packaged automatically. For information on how to create NPM packages, see the -":ref:`dev-manual/dev-manual-common-tasks:creating node package manager (npm) packages`" +":ref:`dev-manual/common-tasks:creating node package manager (npm) packages`" section in the Yocto Project Development Tasks Manual. .. _ref-classes-oelint: @@ -1802,7 +1802,7 @@ If you take the optional step to set up a repository (package feed) on the development host that can be used by DNF, you can install packages from the feed while you are running the image on the target (i.e. runtime installation of packages). For more information, see the -":ref:`dev-manual/dev-manual-common-tasks:using runtime package management`" +":ref:`dev-manual/common-tasks:using runtime package management`" section in the Yocto Project Development Tasks Manual. The package-specific class you choose can affect build-time performance @@ -1921,7 +1921,7 @@ so forth). It is highly recommended that all package group recipes inherit this class. For information on how to use this class, see the -":ref:`dev-manual/dev-manual-common-tasks:customizing images using custom package groups`" +":ref:`dev-manual/common-tasks:customizing images using custom package groups`" section in the Yocto Project Development Tasks Manual. Previously, this class was called the ``task`` class. @@ -2080,7 +2080,7 @@ The ``primport`` class provides functionality for importing ================== The ``prserv`` class provides functionality for using a :ref:`PR -service ` in order to +service ` in order to automatically manage the incrementing of the :term:`PR` variable for each recipe. @@ -2100,7 +2100,7 @@ runtime tests for recipes that build software that provides these tests. This class is intended to be inherited by individual recipes. However, the class' functionality is largely disabled unless "ptest" appears in :term:`DISTRO_FEATURES`. See the -":ref:`dev-manual/dev-manual-common-tasks:testing packages with ptest`" +":ref:`dev-manual/common-tasks:testing packages with ptest`" section in the Yocto Project Development Tasks Manual for more information on ptest. @@ -2113,7 +2113,7 @@ Enables package tests (ptests) specifically for GNOME packages, which have tests intended to be executed with ``gnome-desktop-testing``. For information on setting up and running ptests, see the -":ref:`dev-manual/dev-manual-common-tasks:testing packages with ptest`" +":ref:`dev-manual/common-tasks:testing packages with ptest`" section in the Yocto Project Development Tasks Manual. .. _ref-classes-python-dir: @@ -2199,7 +2199,7 @@ override the removal by setting ``REMOVE_LIBTOOL_LA`` to "0" as follows: ======================== The ``report-error`` class supports enabling the :ref:`error reporting -tool `", +tool `", which allows you to submit build error information to a central database. The class collects debug information for recipe, recipe version, task, @@ -2554,7 +2554,7 @@ unless you have set :term:`SYSTEMD_AUTO_ENABLE` to "disable". For more information on ``systemd``, see the -":ref:`dev-manual/dev-manual-common-tasks:selecting an initialization manager`" +":ref:`dev-manual/common-tasks:selecting an initialization manager`" section in the Yocto Project Development Tasks Manual. .. _ref-classes-systemd-boot: @@ -2631,7 +2631,7 @@ runs tests on an image after the image is constructed (i.e. :term:`TESTIMAGE_AUTO` must be set to "1"). For information on how to enable, run, and create new tests, see the -":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" +":ref:`dev-manual/common-tasks:performing automated runtime testing`" section in the Yocto Project Development Tasks Manual. .. _ref-classes-testsdk: diff --git a/documentation/ref-manual/ref-devtool-reference.rst b/documentation/ref-manual/ref-devtool-reference.rst index 83861d271c..11b4cb5d5b 100644 --- a/documentation/ref-manual/ref-devtool-reference.rst +++ b/documentation/ref-manual/ref-devtool-reference.rst @@ -413,7 +413,7 @@ Upgrading a Recipe As software matures, upstream recipes are upgraded to newer versions. As a developer, you need to keep your local recipes up-to-date with the upstream version releases. Several methods exist by which you can -upgrade recipes. You can read about them in the ":ref:`dev-manual/dev-manual-common-tasks:upgrading recipes`" +upgrade recipes. You can read about them in the ":ref:`dev-manual/common-tasks:upgrading recipes`" section of the Yocto Project Development Tasks Manual. This section overviews the ``devtool upgrade`` command. @@ -441,7 +441,7 @@ You can read more on the ``devtool upgrade`` workflow in the ":ref:`sdk-manual/sdk-extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" section in the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) manual. You can also see an example of -how to use ``devtool upgrade`` in the ":ref:`dev-manual/dev-manual-common-tasks:using \`\`devtool upgrade\`\``" +how to use ``devtool upgrade`` in the ":ref:`dev-manual/common-tasks:using \`\`devtool upgrade\`\``" section in the Yocto Project Development Tasks Manual. .. _devtool-resetting-a-recipe: diff --git a/documentation/ref-manual/ref-features.rst b/documentation/ref-manual/ref-features.rst index 6c85c24181..cb4b57436d 100644 --- a/documentation/ref-manual/ref-features.rst +++ b/documentation/ref-manual/ref-features.rst @@ -156,7 +156,7 @@ metadata: - *ptest:* Enables building the package tests where supported by individual recipes. For more information on package tests, see the - ":ref:`dev-manual/dev-manual-common-tasks:testing packages with ptest`" section + ":ref:`dev-manual/common-tasks:testing packages with ptest`" section in the Yocto Project Development Tasks Manual. - *smbfs:* Include SMB networks client support (for mounting @@ -236,7 +236,7 @@ The following image features are available for all images: - *read-only-rootfs:* Creates an image whose root filesystem is read-only. See the - ":ref:`dev-manual/dev-manual-common-tasks:creating a read-only root filesystem`" + ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`" section in the Yocto Project Development Tasks Manual for more information. @@ -273,7 +273,7 @@ these valid features is as follows: - *tools-debug:* Installs debugging tools such as ``strace`` and ``gdb``. For information on GDB, see the - ":ref:`dev-manual/dev-manual-common-tasks:debugging with the gnu project debugger (gdb) remotely`" section + ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section in the Yocto Project Development Tasks Manual. For information on tracing and profiling, see the :doc:`/profile-manual/index`. diff --git a/documentation/ref-manual/ref-images.rst b/documentation/ref-manual/ref-images.rst index 56ec8562f8..5e9374eae7 100644 --- a/documentation/ref-manual/ref-images.rst +++ b/documentation/ref-manual/ref-images.rst @@ -122,7 +122,7 @@ Following is a list of supported recipes: deployed to a separate partition so that you can boot into it and use it to deploy a second image to be tested. You can find more information about runtime testing in the - ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" + ":ref:`dev-manual/common-tasks:performing automated runtime testing`" section in the Yocto Project Development Tasks Manual. - ``core-image-testmaster-initramfs``: A RAM-based Initial Root @@ -132,7 +132,7 @@ Following is a list of supported recipes: - ``core-image-weston``: A very basic Wayland image with a terminal. This image provides the Wayland protocol libraries and the reference Weston compositor. For more information, see the - ":ref:`dev-manual/dev-manual-common-tasks:using wayland and weston`" + ":ref:`dev-manual/common-tasks:using wayland and weston`" section in the Yocto Project Development Tasks Manual. - ``core-image-x11``: A very basic X11 image with a terminal. diff --git a/documentation/ref-manual/ref-kickstart.rst b/documentation/ref-manual/ref-kickstart.rst index 7f6d4ebe1c..bb9c0460f3 100644 --- a/documentation/ref-manual/ref-kickstart.rst +++ b/documentation/ref-manual/ref-kickstart.rst @@ -79,7 +79,7 @@ the ``part`` and ``partition`` commands: source of the data that populates the partition. The most common value for this option is "rootfs", but you can use any value that maps to a valid source plugin. For information on the source plugins, - see the ":ref:`dev-manual/dev-manual-common-tasks:using the wic plugin interface`" + see the ":ref:`dev-manual/common-tasks:using the wic plugin interface`" section in the Yocto Project Development Tasks Manual. If you use ``--source rootfs``, Wic creates a partition as large as diff --git a/documentation/ref-manual/ref-release-process.rst b/documentation/ref-manual/ref-release-process.rst index ec6d233877..54cd9510f6 100644 --- a/documentation/ref-manual/ref-release-process.rst +++ b/documentation/ref-manual/ref-release-process.rst @@ -106,7 +106,7 @@ Additionally, because the test strategies are visible to you as a developer, you can validate your projects. This section overviews the available test infrastructure used in the Yocto Project. For information on how to run available tests on your projects, see the -":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" +":ref:`dev-manual/common-tasks:performing automated runtime testing`" section in the Yocto Project Development Tasks Manual. The QA/testing infrastructure is woven into the project to the point @@ -128,12 +128,12 @@ consists of the following pieces: - :ref:`testimage.bbclass `: This class performs runtime testing of images after they are built. The tests - are usually used with :doc:`QEMU ` + are usually used with :doc:`QEMU ` to boot the images and check the combined runtime result boot operation and functions. However, the test can also use the IP address of a machine to test. -- :ref:`ptest `: +- :ref:`ptest `: Runs tests against packages produced during the build for a given piece of software. The test allows the packages to be be run within a target image. diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst index d3a231554f..b681e8233f 100644 --- a/documentation/ref-manual/ref-structure.rst +++ b/documentation/ref-manual/ref-structure.rst @@ -12,7 +12,7 @@ and directories. For information on how to establish a local Source Directory on your development system, see the -":ref:`dev-manual/dev-manual-start:locating yocto project source files`" +":ref:`dev-manual/start:locating yocto project source files`" section in the Yocto Project Development Tasks Manual. .. note:: @@ -176,7 +176,7 @@ within the :term:`Source Directory`. If you design a custom distribution, you can include your own version of this configuration file to mention the targets defined by your distribution. See the -":ref:`dev-manual/dev-manual-common-tasks:creating a custom template configuration directory`" +":ref:`dev-manual/common-tasks:creating a custom template configuration directory`" section in the Yocto Project Development Tasks Manual for more information. @@ -193,7 +193,7 @@ Directory named ``mybuilds/`` that is outside of the :term:`Source Directory`: The OpenEmbedded build system uses the template configuration files, which are found by default in the ``meta-poky/conf/`` directory in the Source Directory. See the -":ref:`dev-manual/dev-manual-common-tasks:creating a custom template configuration directory`" +":ref:`dev-manual/common-tasks:creating a custom template configuration directory`" section in the Yocto Project Development Tasks Manual for more information. @@ -236,7 +236,7 @@ The OpenEmbedded build system creates this directory when you enable build history via the ``buildhistory`` class file. The directory organizes build information into image, packages, and SDK subdirectories. For information on the build history feature, see the -":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`" +":ref:`dev-manual/common-tasks:maintaining build output quality`" section in the Yocto Project Development Tasks Manual. .. _structure-build-conf-local.conf: @@ -292,7 +292,7 @@ file, it uses ``sed`` to substitute final ---------------------------- This configuration file defines -:ref:`layers `, +:ref:`layers `, which are directory trees, traversed (or walked) by BitBake. The ``bblayers.conf`` file uses the :term:`BBLAYERS` variable to list the layers BitBake tries to find. @@ -438,7 +438,7 @@ directory contains sub-directories for ``bash``, ``busybox``, and ``glibc`` (among others) that in turn contain appropriate ``COPYING`` license files with other licensing information. For information on licensing, see the -":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`" +":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" section in the Yocto Project Development Tasks Manual. .. _structure-build-tmp-deploy-images: @@ -577,7 +577,7 @@ built within the Yocto Project. For this package, a work directory of ``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred to as the ``WORKDIR``, is created. Within this directory, the source is unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt. -(See the ":ref:`dev-manual/dev-manual-common-tasks:using quilt in your workflow`" section in +(See the ":ref:`dev-manual/common-tasks:using quilt in your workflow`" section in the Yocto Project Development Tasks Manual for more information.) Within the ``linux-qemux86-standard-build`` directory, standard Quilt directories ``linux-3.0/patches`` and ``linux-3.0/.pc`` are created, and diff --git a/documentation/ref-manual/ref-system-requirements.rst b/documentation/ref-manual/ref-system-requirements.rst index 2c7c1e0754..d162c9bad2 100644 --- a/documentation/ref-manual/ref-system-requirements.rst +++ b/documentation/ref-manual/ref-system-requirements.rst @@ -94,7 +94,7 @@ distributions: interested in hearing about your experience. For information on how to submit a bug, see the Yocto Project :yocto_wiki:`Bugzilla wiki page ` - and the ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" + and the ":ref:`dev-manual/common-tasks:submitting a defect against the yocto project`" section in the Yocto Project Development Tasks Manual. diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst index 9fde9a8378..89731d459c 100644 --- a/documentation/ref-manual/ref-tasks.rst +++ b/documentation/ref-manual/ref-tasks.rst @@ -351,7 +351,7 @@ applied as a patch by default except for the ``patch_file5`` patch. You can find out more about the patching process in the ":ref:`overview-manual/overview-manual-concepts:patching`" section in the Yocto Project Overview and Concepts Manual and the -":ref:`dev-manual/dev-manual-common-tasks:patching code`" section in the +":ref:`dev-manual/common-tasks:patching code`" section in the Yocto Project Development Tasks Manual. .. _ref-tasks-populate_lic: @@ -567,7 +567,7 @@ scratch is guaranteed. Starts a shell in which an interactive Python interpreter allows you to interact with the BitBake build environment. From within this shell, you can directly examine and set bits from the data store and execute -functions as if within the BitBake environment. See the ":ref:`dev-manual/dev-manual-common-tasks:using a development python shell`" section in +functions as if within the BitBake environment. See the ":ref:`dev-manual/common-tasks:using a development python shell`" section in the Yocto Project Development Tasks Manual for more information about using ``devpyshell``. @@ -577,7 +577,7 @@ using ``devpyshell``. --------------- Starts a shell whose environment is set up for development, debugging, -or both. See the ":ref:`dev-manual/dev-manual-common-tasks:using a development shell`" section in the +or both. See the ":ref:`dev-manual/common-tasks:using a development shell`" section in the Yocto Project Development Tasks Manual for more information about using ``devshell``. @@ -642,7 +642,7 @@ information on how the root filesystem is created. Boots an image and performs runtime tests within the image. For information on automatically testing images, see the -":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" +":ref:`dev-manual/common-tasks:performing automated runtime testing`" section in the Yocto Project Development Tasks Manual. .. _ref-tasks-testimage_auto: @@ -655,7 +655,7 @@ after it has been built. This task is enabled when you set :term:`TESTIMAGE_AUTO` equal to "1". For information on automatically testing images, see the -":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" +":ref:`dev-manual/common-tasks:performing automated runtime testing`" section in the Yocto Project Development Tasks Manual. Kernel-Related Tasks diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst index 6f0facf728..ba1930ebda 100644 --- a/documentation/ref-manual/ref-terms.rst +++ b/documentation/ref-manual/ref-terms.rst @@ -21,7 +21,7 @@ universal, the list includes them just in case: Information in append files extends or overrides the information in the similarly-named recipe file. For an example of an append file in use, see - the ":ref:`dev-manual/dev-manual-common-tasks:Using .bbappend Files in + the ":ref:`dev-manual/common-tasks:Using .bbappend Files in Your Layer`" section in the Yocto Project Development Tasks Manual. When you name an append file, you can use the "``%``" wildcard character @@ -192,7 +192,7 @@ universal, the list includes them just in case: ":ref:`overview-manual/overview-manual-yp-intro:The Yocto Project Layer Model`" section in the Yocto Project Overview and Concepts Manual. For more detailed information on layers, see the - ":ref:`dev-manual/dev-manual-common-tasks:Understanding and Creating + ":ref:`dev-manual/common-tasks:Understanding and Creating Layers`" section in the Yocto Project Development Tasks Manual. For a discussion specifically on BSP Layers, see the ":ref:`bsp-guide/bsp:BSP Layers`" section in the Yocto Project Board Support Packages (BSP) diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst index 8411989b69..65f64b91a5 100644 --- a/documentation/ref-manual/ref-variables.rst +++ b/documentation/ref-manual/ref-variables.rst @@ -239,7 +239,7 @@ system and gives an overview of their function and contents. so that it does contain ``${SRCPV}``. For more information see the - ":ref:`dev-manual/dev-manual-common-tasks:automatically incrementing a package version number`" + ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" section in the Yocto Project Development Tasks Manual. :term:`AVAILABLE_LICENSES` @@ -261,7 +261,7 @@ system and gives an overview of their function and contents. The list simply presents the tunes that are available. Not all tunes may be compatible with a particular machine configuration, or with each other in a - :ref:`Multilib ` + :ref:`Multilib ` configuration. To add a tune to the list, be sure to append it with spaces using the @@ -317,7 +317,7 @@ system and gives an overview of their function and contents. :term:`BASE_LIB` The library directory name for the CPU or Application Binary Interface (ABI) tune. The ``BASE_LIB`` applies only in the Multilib - context. See the ":ref:`dev-manual/dev-manual-common-tasks:combining multiple versions of library files into one image`" + context. See the ":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`" section in the Yocto Project Development Tasks Manual for information on Multilib. @@ -545,7 +545,7 @@ system and gives an overview of their function and contents. is not set higher than "20". For more information on speeding up builds, see the - ":ref:`dev-manual/dev-manual-common-tasks:speeding up a build`" + ":ref:`dev-manual/common-tasks:speeding up a build`" section in the Yocto Project Development Tasks Manual. :term:`BB_SERVER_TIMEOUT` @@ -746,7 +746,7 @@ system and gives an overview of their function and contents. For information on how to use ``BBMULTICONFIG`` in an environment that supports building targets with multiple configurations, see the - ":ref:`dev-manual/dev-manual-common-tasks:building images for multiple targets using multiple configurations`" + ":ref:`dev-manual/common-tasks:building images for multiple targets using multiple configurations`" section in the Yocto Project Development Tasks Manual. :term:`BBPATH` @@ -1002,7 +1002,7 @@ system and gives an overview of their function and contents. When inheriting the :ref:`buildhistory ` class, this variable specifies the build history features to be enabled. For more information on how build history works, see the - ":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`" + ":ref:`dev-manual/common-tasks:maintaining build output quality`" section in the Yocto Project Development Tasks Manual. You can specify these features in the form of a space-separated list: @@ -1299,7 +1299,7 @@ system and gives an overview of their function and contents. will be the aggregate of all of them. For information on creating an initramfs, see the - ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section + ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section in the Yocto Project Development Tasks Manual. :term:`CONFIG_SITE` @@ -1402,7 +1402,7 @@ system and gives an overview of their function and contents. newly installed packages to an image, which might be most suitable for read-only filesystems that cannot be upgraded. See the :term:`LICENSE_CREATE_PACKAGE` variable for additional information. - You can also reference the ":ref:`dev-manual/dev-manual-common-tasks:providing license text`" + You can also reference the ":ref:`dev-manual/common-tasks:providing license text`" section in the Yocto Project Development Tasks Manual for information on providing license text. @@ -1418,7 +1418,7 @@ system and gives an overview of their function and contents. newly installed packages to an image, which might be most suitable for read-only filesystems that cannot be upgraded. See the :term:`LICENSE_CREATE_PACKAGE` variable for additional information. - You can also reference the ":ref:`dev-manual/dev-manual-common-tasks:providing license text`" + You can also reference the ":ref:`dev-manual/common-tasks:providing license text`" section in the Yocto Project Development Tasks Manual for information on providing license text. @@ -2029,7 +2029,7 @@ system and gives an overview of their function and contents. When used with the :ref:`report-error ` class, specifies the path used for storing the debug files created by the :ref:`error reporting - tool `, which + tool `, which allows you to submit build errors you encounter to a central database. By default, the value of this variable is ``${``\ :term:`LOG_DIR`\ ``}/error-report``. @@ -2129,7 +2129,7 @@ system and gives an overview of their function and contents. For more information on ``externalsrc.bbclass``, see the ":ref:`externalsrc.bbclass `" section. You can also find information on how to use this variable in the - ":ref:`dev-manual/dev-manual-common-tasks:building software from an external source`" + ":ref:`dev-manual/common-tasks:building software from an external source`" section in the Yocto Project Development Tasks Manual. :term:`EXTERNALSRC_BUILD` @@ -2143,7 +2143,7 @@ system and gives an overview of their function and contents. For more information on ``externalsrc.bbclass``, see the ":ref:`externalsrc.bbclass `" section. You can also find information on how to use this variable in the - ":ref:`dev-manual/dev-manual-common-tasks:building software from an external source`" + ":ref:`dev-manual/common-tasks:building software from an external source`" section in the Yocto Project Development Tasks Manual. :term:`EXTRA_AUTORECONF` @@ -2181,7 +2181,7 @@ system and gives an overview of their function and contents. useful if you want to develop against the libraries in the image. - "read-only-rootfs" - Creates an image whose root filesystem is read-only. See the - ":ref:`dev-manual/dev-manual-common-tasks:creating a read-only root filesystem`" + ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`" section in the Yocto Project Development Tasks Manual for more information - "tools-debug" - Adds debugging tools such as gdb and strace. @@ -2194,7 +2194,7 @@ system and gives an overview of their function and contents. Project, see the ":ref:`ref-features-image`" section. For an example that shows how to customize your image by using this - variable, see the ":ref:`dev-manual/dev-manual-common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" + variable, see the ":ref:`dev-manual/common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" section in the Yocto Project Development Tasks Manual. :term:`EXTRA_IMAGECMD` @@ -2511,7 +2511,7 @@ system and gives an overview of their function and contents. You can find out more about the patching process in the ":ref:`overview-manual/overview-manual-concepts:patching`" section in the Yocto Project Overview and Concepts Manual and the - ":ref:`dev-manual/dev-manual-common-tasks:patching code`" section in + ":ref:`dev-manual/common-tasks:patching code`" section in the Yocto Project Development Tasks Manual. See the :ref:`ref-tasks-patch` task as well. @@ -2904,7 +2904,7 @@ system and gives an overview of their function and contents. the same files into a ``boot`` directory within the target partition. You can find information on how to use the Wic tool in the - ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" + ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" section of the Yocto Project Development Tasks Manual. Reference material for Wic is located in the ":doc:`/ref-manual/ref-kickstart`" chapter. @@ -2940,7 +2940,7 @@ system and gives an overview of their function and contents. the same files into a ``boot`` directory within the target partition. You can find information on how to use the Wic tool in the - ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" + ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" section of the Yocto Project Development Tasks Manual. Reference material for Wic is located in the ":doc:`/ref-manual/ref-kickstart`" chapter. @@ -3000,7 +3000,7 @@ system and gives an overview of their function and contents. the ":ref:`ref-features-image`" section. For an example that shows how to customize your image by using this - variable, see the ":ref:`dev-manual/dev-manual-common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" + variable, see the ":ref:`dev-manual/common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" section in the Yocto Project Development Tasks Manual. :term:`IMAGE_FSTYPES` @@ -3058,7 +3058,7 @@ system and gives an overview of their function and contents. allows the initial RAM filesystem (initramfs) recipe to use a fixed set of packages and not be affected by ``IMAGE_INSTALL``. For information on creating an initramfs, see the - ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" + ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section in the Yocto Project Development Tasks Manual. - Using ``IMAGE_INSTALL`` with the @@ -3554,7 +3554,7 @@ system and gives an overview of their function and contents. :term:`INITRAMFS_IMAGE_BUNDLE` variable, which allows the generated image to be bundled inside the kernel image. Additionally, for information on creating an initramfs - image, see the ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section + image, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section in the Yocto Project Development Tasks Manual. :term:`INITRAMFS_IMAGE_BUNDLE` @@ -3602,7 +3602,7 @@ system and gives an overview of their function and contents. See the :yocto_git:`local.conf.sample.extended ` file for additional information. Also, for information on creating an - initramfs, see the ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section + initramfs, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section in the Yocto Project Development Tasks Manual. :term:`INITRAMFS_LINK_NAME` @@ -4191,7 +4191,7 @@ system and gives an overview of their function and contents. The OpenEmbedded build system produces a warning if the variable is not set for any given layer. - See the ":ref:`dev-manual/dev-manual-common-tasks:creating your own layer`" + See the ":ref:`dev-manual/common-tasks:creating your own layer`" section in the Yocto Project Development Tasks Manual. :term:`LAYERVERSION` @@ -4240,7 +4240,7 @@ system and gives an overview of their function and contents. This variable must be defined for all recipes (unless :term:`LICENSE` is set to "CLOSED"). - For more information, see the ":ref:`dev-manual/dev-manual-common-tasks:tracking license changes`" + For more information, see the ":ref:`dev-manual/common-tasks:tracking license changes`" section in the Yocto Project Development Tasks Manual. :term:`LICENSE` @@ -4306,7 +4306,7 @@ system and gives an overview of their function and contents. For related information on providing license text, see the :term:`COPY_LIC_DIRS` variable, the :term:`COPY_LIC_MANIFEST` variable, and the - ":ref:`dev-manual/dev-manual-common-tasks:providing license text`" + ":ref:`dev-manual/common-tasks:providing license text`" section in the Yocto Project Development Tasks Manual. :term:`LICENSE_FLAGS` @@ -4319,7 +4319,7 @@ system and gives an overview of their function and contents. typically used to mark recipes that might require additional licenses in order to be used in a commercial product. For more information, see the - ":ref:`dev-manual/dev-manual-common-tasks:enabling commercially licensed recipes`" + ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" section in the Yocto Project Development Tasks Manual. :term:`LICENSE_FLAGS_WHITELIST` @@ -4327,7 +4327,7 @@ system and gives an overview of their function and contents. :term:`LICENSE_FLAGS` within a recipe should not prevent that recipe from being built. This practice is otherwise known as "whitelisting" license flags. For more information, see the - ":ref:`dev-manual/dev-manual-common-tasks:enabling commercially licensed recipes`" + ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" section in the Yocto Project Development Tasks Manual. :term:`LICENSE_PATH` @@ -4890,7 +4890,7 @@ system and gives an overview of their function and contents. Controls how the OpenEmbedded build system spawns interactive terminals on the host development system (e.g. using the BitBake command with the ``-c devshell`` command-line option). For more - information, see the ":ref:`dev-manual/dev-manual-common-tasks:using a development shell`" section in + information, see the ":ref:`dev-manual/common-tasks:using a development shell`" section in the Yocto Project Development Tasks Manual. You can use the following values for the ``OE_TERMINAL`` variable: @@ -4959,7 +4959,7 @@ system and gives an overview of their function and contents. An easy way to see what overrides apply is to search for ``OVERRIDES`` in the output of the ``bitbake -e`` command. See the - ":ref:`dev-manual/dev-manual-common-tasks:viewing variable values`" section in the Yocto + ":ref:`dev-manual/common-tasks:viewing variable values`" section in the Yocto Project Development Tasks Manual for more information. :term:`P` @@ -4981,7 +4981,7 @@ system and gives an overview of their function and contents. specific by using the package name as a suffix. You can find out more about applying this variable in the - ":ref:`dev-manual/dev-manual-common-tasks:adding custom metadata to packages`" + ":ref:`dev-manual/common-tasks:adding custom metadata to packages`" section in the Yocto Project Development Tasks Manual. :term:`PACKAGE_ARCH` @@ -5079,7 +5079,7 @@ system and gives an overview of their function and contents. separate ``*-src`` pkg. This is the default behavior. You can find out more about debugging using GDB by reading the - ":ref:`dev-manual/dev-manual-common-tasks:debugging with the gnu project debugger (gdb) remotely`" section + ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section in the Yocto Project Development Tasks Manual. :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` @@ -5243,7 +5243,7 @@ system and gives an overview of their function and contents. the :ref:`core-image-minimal-initramfs ` image. When working with an initial RAM filesystem (initramfs) image, use the ``PACKAGE_INSTALL`` variable. For information on creating an - initramfs, see the ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section + initramfs, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section in the Yocto Project Development Tasks Manual. :term:`PACKAGE_INSTALL_ATTEMPTONLY` @@ -5266,7 +5266,7 @@ system and gives an overview of their function and contents. ``PACKAGE_WRITE_DEPS``. For information on running post-installation scripts, see the - ":ref:`dev-manual/dev-manual-common-tasks:post-installation scripts`" + ":ref:`dev-manual/common-tasks:post-installation scripts`" section in the Yocto Project Development Tasks Manual. :term:`PACKAGECONFIG` @@ -5423,7 +5423,7 @@ system and gives an overview of their function and contents. For an example of how to use the ``PACKAGES_DYNAMIC`` variable when you are splitting packages, see the - ":ref:`dev-manual/dev-manual-common-tasks:handling optional module packaging`" + ":ref:`dev-manual/common-tasks:handling optional module packaging`" section in the Yocto Project Development Tasks Manual. :term:`PACKAGESPLITFUNCS` @@ -5458,7 +5458,7 @@ system and gives an overview of their function and contents. the ``do_compile`` task that result in race conditions, you can clear the ``PARALLEL_MAKE`` variable within the recipe as a workaround. For information on addressing race conditions, see the - ":ref:`dev-manual/dev-manual-common-tasks:debugging parallel make races`" + ":ref:`dev-manual/common-tasks:debugging parallel make races`" section in the Yocto Project Development Tasks Manual. For single socket systems (i.e. one CPU), you should not have to @@ -5468,7 +5468,7 @@ system and gives an overview of their function and contents. not set higher than "-j 20". For more information on speeding up builds, see the - ":ref:`dev-manual/dev-manual-common-tasks:speeding up a build`" + ":ref:`dev-manual/common-tasks:speeding up a build`" section in the Yocto Project Development Tasks Manual. :term:`PARALLEL_MAKEINST` @@ -5488,7 +5488,7 @@ system and gives an overview of their function and contents. the ``do_install`` task that result in race conditions, you can clear the ``PARALLEL_MAKEINST`` variable within the recipe as a workaround. For information on addressing race conditions, see the - ":ref:`dev-manual/dev-manual-common-tasks:debugging parallel make races`" + ":ref:`dev-manual/common-tasks:debugging parallel make races`" section in the Yocto Project Development Tasks Manual. :term:`PATCHRESOLVE` @@ -5580,7 +5580,7 @@ system and gives an overview of their function and contents. For examples of how this data is used, see the ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" section in the Yocto Project Overview and Concepts Manual and the - ":ref:`dev-manual/dev-manual-common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``" + ":ref:`dev-manual/common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``" section in the Yocto Project Development Tasks Manual. For more information on the shared, global-state directory, see :term:`STAGING_DIR_HOST`. @@ -5713,7 +5713,7 @@ system and gives an overview of their function and contents. Because manually managing ``PR`` can be cumbersome and error-prone, an automated solution exists. See the - ":ref:`dev-manual/dev-manual-common-tasks:working with a pr service`" section + ":ref:`dev-manual/common-tasks:working with a pr service`" section in the Yocto Project Development Tasks Manual for more information. :term:`PREFERRED_PROVIDER` @@ -5738,7 +5738,7 @@ system and gives an overview of their function and contents. PREFERRED_PROVIDER_virtual/libgl ?= "mesa" For more - information, see the ":ref:`dev-manual/dev-manual-common-tasks:using virtual providers`" + information, see the ":ref:`dev-manual/common-tasks:using virtual providers`" section in the Yocto Project Development Tasks Manual. .. note:: @@ -5951,7 +5951,7 @@ system and gives an overview of their function and contents. You must set the variable if you want to automatically start a local :ref:`PR - service `. You can + service `. You can set ``PRSERV_HOST`` to other values to use a remote PR service. @@ -5965,7 +5965,7 @@ system and gives an overview of their function and contents. :term:`PTEST_ENABLED` Specifies whether or not :ref:`Package - Test ` (ptest) + Test ` (ptest) functionality is enabled when building a recipe. You should not set this variable directly. Enabling and disabling building Package Tests at build time should be done by adding "ptest" to (or removing it @@ -7000,7 +7000,7 @@ system and gives an overview of their function and contents. various ``SPL_*`` variables used by the OpenEmbedded build system. See the BeagleBone machine configuration example in the - ":ref:`dev-manual/dev-manual-common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`" + ":ref:`dev-manual/common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`" section in the Yocto Project Board Support Package Developer's Guide for additional information. @@ -7200,7 +7200,7 @@ system and gives an overview of their function and contents. For information on limitations when inheriting the latest revision of software using ``SRCREV``, see the :term:`AUTOREV` variable description and the - ":ref:`dev-manual/dev-manual-common-tasks:automatically incrementing a package version number`" + ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" section, which is in the Yocto Project Development Tasks Manual. :term:`SSTATE_DIR` @@ -7660,7 +7660,7 @@ system and gives an overview of their function and contents. :term:`SYSVINIT_ENABLED_GETTYS` When using - :ref:`SysVinit `, + :ref:`SysVinit `, specifies a space-separated list of the virtual terminals that should run a `getty `__ (allowing login), assuming :term:`USE_VT` is not set to @@ -7946,7 +7946,7 @@ system and gives an overview of their function and contents. file. For more information on testing images, see the - ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" + ":ref:`dev-manual/common-tasks:performing automated runtime testing`" section in the Yocto Project Development Tasks Manual. :term:`TEST_SERIALCONTROL_CMD` @@ -8022,7 +8022,7 @@ system and gives an overview of their function and contents. TEST_SUITES = "test_A test_B" For more information on testing images, see the - ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" + ":ref:`dev-manual/common-tasks:performing automated runtime testing`" section in the Yocto Project Development Tasks Manual. :term:`TEST_TARGET` @@ -8042,7 +8042,7 @@ system and gives an overview of their function and contents. You can provide the following arguments with ``TEST_TARGET``: - *"qemu":* Boots a QEMU image and runs the tests. See the - ":ref:`dev-manual/dev-manual-common-tasks:enabling runtime tests on qemu`" section + ":ref:`dev-manual/common-tasks:enabling runtime tests on qemu`" section in the Yocto Project Development Tasks Manual for more information. @@ -8058,7 +8058,7 @@ system and gives an overview of their function and contents. ``meta/lib/oeqa/controllers/simpleremote.py``. For information on running tests on hardware, see the - ":ref:`dev-manual/dev-manual-common-tasks:enabling runtime tests on hardware`" + ":ref:`dev-manual/common-tasks:enabling runtime tests on hardware`" section in the Yocto Project Development Tasks Manual. :term:`TEST_TARGET_IP` @@ -8096,7 +8096,7 @@ system and gives an overview of their function and contents. For more information on enabling, running, and writing these tests, see the - ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" + ":ref:`dev-manual/common-tasks:performing automated runtime testing`" section in the Yocto Project Development Tasks Manual and the ":ref:`testimage*.bbclass `" section. @@ -8554,13 +8554,13 @@ system and gives an overview of their function and contents. specifically set. Typically, you would set ``USE_DEVFS`` to "0" for a statically populated ``/dev`` directory. - See the ":ref:`dev-manual/dev-manual-common-tasks:selecting a device manager`" section in + See the ":ref:`dev-manual/common-tasks:selecting a device manager`" section in the Yocto Project Development Tasks Manual for information on how to use this variable. :term:`USE_VT` When using - :ref:`SysVinit `, + :ref:`SysVinit `, determines whether or not to run a `getty `__ on any virtual terminals in order to enable logging in through those @@ -8735,7 +8735,7 @@ system and gives an overview of their function and contents. OpenEmbedded build system to create a partitioned image (image\ ``.wic``). For information on how to create a partitioned image, see the - ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" + ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" section in the Yocto Project Development Tasks Manual. For details on the kickstart file format, see the ":doc:`/ref-manual/ref-kickstart`" Chapter. diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index fd04593d43..77c3678095 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst @@ -23,7 +23,7 @@ The Yocto Project gladly accepts contributions. You can submit changes to the project either by creating and sending pull requests, or by submitting patches through email. For information on how to do both as well as information on how to identify the maintainer for each area of -code, see the ":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" section in the +code, see the ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" section in the Yocto Project Development Tasks Manual. .. _resources-bugtracker: @@ -47,7 +47,7 @@ A general procedure and guidelines exist for when you use Bugzilla to submit a bug. For information on how to use Bugzilla to submit a bug against the Yocto Project, see the following: -- The ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" +- The ":ref:`dev-manual/common-tasks:submitting a defect against the yocto project`" section in the Yocto Project Development Tasks Manual. - The Yocto Project :yocto_wiki:`Bugzilla wiki page ` -- cgit v1.2.3-54-g00ecf