mirror of
https://git.yoctoproject.org/poky
synced 2026-05-31 12:49:46 +00:00
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>
This commit is contained in:
committed by
Richard Purdie
parent
79fecb25e1
commit
b70318797c
@@ -1033,7 +1033,7 @@ You can configure the sanity checks so that specific test failures
|
||||
either raise a warning or an error message. Typically, failures for new
|
||||
tests generate a warning. Subsequent failures for the same test would
|
||||
then generate an error message once the metadata is in a known and good
|
||||
condition. See the ":doc:`ref-qa-checks`" Chapter for a list of all the warning
|
||||
condition. See the ":doc:`/ref-manual/qa-checks`" Chapter for a list of all the warning
|
||||
and error messages you might encounter using a default configuration.
|
||||
|
||||
Use the :term:`WARN_QA` and
|
||||
@@ -1276,7 +1276,7 @@ The following list shows the tests you can list with the ``WARN_QA`` and
|
||||
- ``textrel:`` Checks for ELF binaries that contain relocations in
|
||||
their ``.text`` sections, which can result in a performance impact at
|
||||
runtime. See the explanation for the ``ELF binary`` message in
|
||||
":doc:`ref-qa-checks`" for more information regarding runtime performance
|
||||
":doc:`/ref-manual/qa-checks`" for more information regarding runtime performance
|
||||
issues.
|
||||
|
||||
- ``unlisted-pkg-lics:`` Checks that all declared licenses applying
|
||||
+3
-3
@@ -193,7 +193,7 @@ external source tree.
|
||||
run your application. If dependent packages (e.g. libraries) do not
|
||||
exist on the target, your application, when run, will fail to find
|
||||
those functions. For more information, see the
|
||||
":ref:`ref-manual/ref-devtool-reference:deploying your software on the target machine`"
|
||||
":ref:`ref-manual/devtool-reference:deploying your software on the target machine`"
|
||||
section.
|
||||
|
||||
By default, ``devtool add`` uses the latest revision (i.e. master) when
|
||||
@@ -561,7 +561,7 @@ Removing Your Software from the Target Machine
|
||||
Use the ``devtool undeploy-target`` command to remove deployed build
|
||||
output from the target machine. For the ``devtool undeploy-target``
|
||||
command to work, you must have previously used the
|
||||
":ref:`devtool deploy-target <ref-manual/ref-devtool-reference:deploying your software on the target machine>`"
|
||||
":ref:`devtool deploy-target <ref-manual/devtool-reference:deploying your software on the target machine>`"
|
||||
command.
|
||||
::
|
||||
|
||||
@@ -609,7 +609,7 @@ The ``devtool status`` command has no command-line options:
|
||||
$ devtool status
|
||||
|
||||
Following is sample output after using
|
||||
:ref:`devtool add <ref-manual/ref-devtool-reference:adding a new recipe to the workspace layer>`
|
||||
:ref:`devtool add <ref-manual/devtool-reference:adding a new recipe to the workspace layer>`
|
||||
to create and add the ``mtr_0.86.bb`` recipe to the ``workspace`` directory:
|
||||
::
|
||||
|
||||
@@ -22,7 +22,7 @@ Can I still use the Yocto Project?
|
||||
**A:** You can get the required tools on your host development system a
|
||||
couple different ways (i.e. building a tarball or downloading a
|
||||
tarball). See the
|
||||
":ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions`"
|
||||
":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`"
|
||||
section for steps on how to update your build tools.
|
||||
|
||||
**Q:** How can you claim Poky / OpenEmbedded-Core is stable?
|
||||
|
||||
@@ -10,20 +10,20 @@ Yocto Project Reference Manual
|
||||
:caption: Table of Contents
|
||||
:numbered:
|
||||
|
||||
ref-system-requirements
|
||||
ref-terms
|
||||
ref-release-process
|
||||
system-requirements
|
||||
terms
|
||||
release-process
|
||||
migration
|
||||
ref-structure
|
||||
ref-classes
|
||||
ref-tasks
|
||||
ref-devtool-reference
|
||||
ref-kickstart
|
||||
ref-qa-checks
|
||||
ref-images
|
||||
ref-features
|
||||
ref-variables
|
||||
ref-varlocality
|
||||
structure
|
||||
classes
|
||||
tasks
|
||||
devtool-reference
|
||||
kickstart
|
||||
qa-checks
|
||||
images
|
||||
features
|
||||
variables
|
||||
varlocality
|
||||
faq
|
||||
resources
|
||||
history
|
||||
|
||||
@@ -26,7 +26,7 @@ provide packages for these, you can install and use the Buildtools
|
||||
tarball, which provides an SDK-like environment containing them.
|
||||
|
||||
For more information on this requirement, see the
|
||||
":ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions`"
|
||||
":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`"
|
||||
section.
|
||||
|
||||
.. _migration-1.5-atom-pc-bsp:
|
||||
|
||||
@@ -126,7 +126,7 @@ Changes to Variables
|
||||
--------------------
|
||||
|
||||
The following variables have changed. For information on the
|
||||
OpenEmbedded build system variables, see the ":doc:`ref-variables`" Chapter.
|
||||
OpenEmbedded build system variables, see the ":doc:`/ref-manual/variables`" Chapter.
|
||||
|
||||
.. _migration-1.6-variable-changes-TMPDIR:
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ build host is now 1.7.8 because the ``--list`` option is now required by
|
||||
BitBake's Git fetcher. As always, if your host distribution does not
|
||||
provide a version of Git that meets this requirement, you can use the
|
||||
``buildtools-tarball`` that does. See the
|
||||
":ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions`"
|
||||
":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`"
|
||||
section for more information.
|
||||
|
||||
.. _migration-1.7-autotools-class-changes:
|
||||
@@ -157,7 +157,7 @@ The following changes have occurred to the QA check process:
|
||||
added in order to verify that file dependencies are satisfied (e.g.
|
||||
package contains a script requiring ``/bin/bash``) and build-time
|
||||
dependencies are declared, respectively. For more information, please
|
||||
see the ":doc:`ref-qa-checks`" chapter.
|
||||
see the ":doc:`/ref-manual/qa-checks`" chapter.
|
||||
|
||||
- Package QA checks are now performed during a new
|
||||
:ref:`ref-tasks-package_qa` task rather than being
|
||||
|
||||
@@ -360,7 +360,7 @@ These additional changes exist:
|
||||
- The minimum Git version has been increased to 1.8.3.1. If your host
|
||||
distribution does not provide a sufficiently recent version, you can
|
||||
install the buildtools, which will provide it. See the
|
||||
:ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions`
|
||||
:ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`
|
||||
section for more information on the buildtools tarball.
|
||||
|
||||
- The buggy and incomplete support for the RPM version 4 package
|
||||
|
||||
@@ -404,7 +404,7 @@ The following QA checks have changed:
|
||||
|
||||
For additional information, see the
|
||||
:ref:`insane <ref-classes-insane>` class and the
|
||||
":ref:`ref-manual/ref-qa-checks:errors and warnings`" section.
|
||||
":ref:`ref-manual/qa-checks:errors and warnings`" section.
|
||||
|
||||
.. _migration-2.3-miscellaneous-changes:
|
||||
|
||||
|
||||
+1
-1
@@ -146,7 +146,7 @@ consists of the following pieces:
|
||||
.. note::
|
||||
|
||||
Running ``oe-selftest`` requires host packages beyond the "Essential"
|
||||
grouping. See the :ref:`ref-manual/ref-system-requirements:required packages for the build host`
|
||||
grouping. See the :ref:`ref-manual/system-requirements:required packages for the build host`
|
||||
section for more information.
|
||||
|
||||
Originally, much of this testing was done manually. However, significant
|
||||
@@ -682,7 +682,7 @@ generation or packaging also have their specific class files such as
|
||||
``image.bbclass``, ``rootfs_*.bbclass`` and ``package*.bbclass``.
|
||||
|
||||
For reference information on classes, see the
|
||||
":ref:`ref-manual/ref-classes:Classes`" chapter.
|
||||
":ref:`ref-manual/classes:Classes`" chapter.
|
||||
|
||||
.. _structure-meta-conf:
|
||||
|
||||
@@ -461,7 +461,7 @@ devtool commands:
|
||||
$ devtool latest-version
|
||||
$ devtool check-upgrade-status
|
||||
|
||||
See the ":ref:`ref-manual/ref-devtool-reference:\`\`devtool\`\` quick reference`"
|
||||
See the ":ref:`ref-manual/devtool-reference:\`\`devtool\`\` quick reference`"
|
||||
chapter for more information on
|
||||
``devtool``. See the ":ref:`devtool-checking-on-the-upgrade-status-of-a-recipe`"
|
||||
section for information on checking the upgrade status of a recipe.
|
||||
@@ -64,7 +64,7 @@ universal, the list includes them just in case:
|
||||
This term refers to the area used by the OpenEmbedded build system for
|
||||
builds. The area is created when you ``source`` the setup environment
|
||||
script that is found in the Source Directory
|
||||
(i.e. :ref:`ref-manual/ref-structure:\`\`oe-init-build-env\`\``). The
|
||||
(i.e. :ref:`ref-manual/structure:\`\`oe-init-build-env\`\``). The
|
||||
:term:`TOPDIR` variable points to the Build Directory.
|
||||
|
||||
You have a lot of flexibility when creating the Build Directory.
|
||||
@@ -117,7 +117,7 @@ universal, the list includes them just in case:
|
||||
Files that provide for logic encapsulation and inheritance so that
|
||||
commonly used patterns can be defined once and then easily used in
|
||||
multiple recipes. For reference information on the Yocto Project classes,
|
||||
see the ":ref:`ref-manual/ref-classes:Classes`" chapter. Class files end with the
|
||||
see the ":ref:`ref-manual/classes:Classes`" chapter. Class files end with the
|
||||
``.bbclass`` filename extension.
|
||||
|
||||
:term:`Configuration File`
|
||||
@@ -177,7 +177,7 @@ universal, the list includes them just in case:
|
||||
recipes and related Metadata. Images are the binary output that run on
|
||||
specific hardware or QEMU and are used for specific use-cases. For a list
|
||||
of the supported image types that the Yocto Project provides, see the
|
||||
":ref:`ref-manual/ref-images:Images`" chapter.
|
||||
":ref:`ref-manual/images:Images`" chapter.
|
||||
|
||||
:term:`Layer`
|
||||
A collection of related recipes. Layers allow you to consolidate related
|
||||
@@ -252,7 +252,7 @@ universal, the list includes them just in case:
|
||||
|
||||
It is worth noting that the term "package" can, in general, have
|
||||
subtle meanings. For example, the packages referred to in the
|
||||
":ref:`ref-manual/ref-system-requirements:required packages for the build host`"
|
||||
":ref:`ref-manual/system-requirements:required packages for the build host`"
|
||||
section are compiled binaries that, when installed, add functionality to
|
||||
your Linux distribution.
|
||||
|
||||
@@ -1670,7 +1670,7 @@ system and gives an overview of their function and contents.
|
||||
``${TMPDIR}/deploy``.
|
||||
|
||||
For more information on the structure of the Build Directory, see
|
||||
":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section.
|
||||
":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section.
|
||||
For more detail on the contents of the ``deploy`` directory, see the
|
||||
":ref:`overview-manual/concepts:images`",
|
||||
":ref:`overview-manual/concepts:package feeds`", and
|
||||
@@ -1708,7 +1708,7 @@ system and gives an overview of their function and contents.
|
||||
``${DEPLOY_DIR}/images/${MACHINE}/``.
|
||||
|
||||
For more information on the structure of the Build Directory, see
|
||||
":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section.
|
||||
":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section.
|
||||
For more detail on the contents of the ``deploy`` directory, see the
|
||||
":ref:`overview-manual/concepts:images`" and
|
||||
":ref:`overview-manual/concepts:application development sdk`" sections both in
|
||||
@@ -2907,7 +2907,7 @@ system and gives an overview of their function and contents.
|
||||
":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.
|
||||
":doc:`/ref-manual/kickstart`" chapter.
|
||||
|
||||
:term:`IMAGE_BOOT_FILES`
|
||||
A space-separated list of files installed into the boot partition
|
||||
@@ -2943,7 +2943,7 @@ system and gives an overview of their function and contents.
|
||||
":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.
|
||||
":doc:`/ref-manual/kickstart`" chapter.
|
||||
|
||||
:term:`IMAGE_CLASSES`
|
||||
A list of classes that all images should inherit. You typically use
|
||||
@@ -3051,7 +3051,7 @@ system and gives an overview of their function and contents.
|
||||
.. note::
|
||||
|
||||
- When working with a
|
||||
:ref:`core-image-minimal-initramfs <ref-manual/ref-images:images>`
|
||||
:ref:`core-image-minimal-initramfs <ref-manual/images:images>`
|
||||
image, do not use the ``IMAGE_INSTALL`` variable to specify
|
||||
packages for installation. Instead, use the
|
||||
:term:`PACKAGE_INSTALL` variable, which
|
||||
@@ -5240,7 +5240,7 @@ system and gives an overview of their function and contents.
|
||||
general, you should use the
|
||||
:term:`IMAGE_INSTALL` variable to specify
|
||||
packages for installation. The exception to this is when working with
|
||||
the :ref:`core-image-minimal-initramfs <ref-manual/ref-images:images>`
|
||||
the :ref:`core-image-minimal-initramfs <ref-manual/images:images>`
|
||||
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/common-tasks:building an initial ram filesystem (initramfs) image`" section
|
||||
@@ -8737,7 +8737,7 @@ system and gives an overview of their function and contents.
|
||||
image, see the
|
||||
":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.
|
||||
the kickstart file format, see the ":doc:`/ref-manual/kickstart`" Chapter.
|
||||
|
||||
:term:`WKS_FILE_DEPENDS`
|
||||
When placed in the recipe that builds your image, this variable lists
|
||||
Reference in New Issue
Block a user