manuals: fix paths to default templates & clean up whitespaces

The templates have recently been moved by meta-yocto's commit [1].
Clean up some whitespace issues along the way.

[1] 29608bd03e1b ("meta-poky/conf: move default templates to conf/templates/default/")

(From yocto-docs rev: 661c554224dd79e79afd22b84608e248d3336aac)

Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Ulrich Ölmann
2022-09-02 13:29:30 +02:00
committed by Richard Purdie
parent f212ad190c
commit 05270ae200
4 changed files with 26 additions and 26 deletions

View File

@@ -11417,12 +11417,12 @@ example:
# clean up the .git repos
$ find . -name ".git" -type d -exec rm -rf {} \;
One
thing a development organization might want to consider for end-user
convenience is to modify ``meta-poky/conf/bblayers.conf.sample`` to
ensure that when the end user utilizes the released build system to
build an image, the development organization's layers are included in
the ``bblayers.conf`` file automatically::
One thing a development organization might want to consider for end-user
convenience is to modify
``meta-poky/conf/templates/default/bblayers.conf.sample`` to ensure that when
the end user utilizes the released build system to build an image, the
development organization's layers are included in the ``bblayers.conf`` file
automatically::
# POKY_BBLAYERS_CONF_VERSION is increased each time build/conf/bblayers.conf
# changes incompatibly
@@ -11451,9 +11451,9 @@ The spdx module has been integrated to a layer named meta-spdxscanner.
meta-spdxscanner provides several kinds of scanner. If you want to enable
this function, you have to follow the following steps:
1. Add meta-spdxscanner layer into ``bblayers.conf``.
1. Add meta-spdxscanner layer into ``bblayers.conf``.
2. Refer to the README in meta-spdxscanner to setup the environment (e.g,
2. Refer to the README in meta-spdxscanner to setup the environment (e.g,
setup a fossology server) needed for the scanner.
3. Meta-spdxscanner provides several methods within the bbclass to create spdx files.

View File

@@ -269,7 +269,7 @@ The ``local.conf`` file provides many basic variables that define a
build environment. Here is a list of a few. To see the default
configurations in a ``local.conf`` file created by the build environment
script, see the
:yocto_git:`local.conf.sample </poky/tree/meta-poky/conf/local.conf.sample>`
:yocto_git:`local.conf.sample </poky/tree/meta-poky/conf/templates/default/local.conf.sample>`
in the ``meta-poky`` layer:
- *Target Machine Selection:* Controlled by the
@@ -1006,7 +1006,7 @@ data files are deleted from the root filesystem. As part of the final
stage of package installation, post installation scripts that are part
of the packages are run. Any scripts that fail to run on the build host
are run on the target when the target system is first booted. If you are
using a
using a
:ref:`read-only root filesystem <dev-manual/common-tasks:creating a read-only root filesystem>`,
all the post installation scripts must succeed on the build host during
the package installation phase since the root filesystem on the target

View File

@@ -137,9 +137,10 @@ To use them, remove the comments::
#use_proxy = on
The Yocto Project also includes a
``meta-poky/conf/site.conf.sample`` file that shows how to configure CVS
and Git proxy servers if needed. For more information on setting up
various proxy types and configuring proxy servers, see the
``meta-poky/conf/templates/default/site.conf.sample`` file that shows
how to configure CVS and Git proxy servers if needed. For more
information on setting up various proxy types and configuring proxy
servers, see the
":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`"
Wiki page.

View File

@@ -135,7 +135,6 @@ system and gives an overview of their function and contents.
appear in :term:`DISTRO_FEATURES` within the current configuration, then
the recipe will be skipped, and if the build system attempts to build
the recipe then an error will be triggered.
:term:`APPEND`
An override list of append strings for each target specified with
@@ -2386,8 +2385,8 @@ system and gives an overview of their function and contents.
.. note::
From a security perspective, hardcoding a default password is not
generally a good idea or even legal in some jurisdictions. It is
recommended that you do not do this if you are building a production
generally a good idea or even legal in some jurisdictions. It is
recommended that you do not do this if you are building a production
image.
Additionally there is a special ``passwd-expire`` command that will
@@ -3690,10 +3689,10 @@ system and gives an overview of their function and contents.
to "core-image-minimal-initramfs".
You can also find more information by referencing the
``meta-poky/conf/local.conf.sample.extended`` configuration file in
the Source Directory, the :ref:`image <ref-classes-image>` class,
and the :ref:`kernel <ref-classes-kernel>` class to see how to use
the :term:`INITRAMFS_IMAGE` variable.
``meta-poky/conf/templates/default/local.conf.sample.extended``
configuration file in the Source Directory, the :ref:`image
<ref-classes-image>` class, and the :ref:`kernel <ref-classes-kernel>`
class to see how to use the :term:`INITRAMFS_IMAGE` variable.
If :term:`INITRAMFS_IMAGE` is empty, which is the default, then no
initramfs image is built.
@@ -3752,7 +3751,7 @@ system and gives an overview of their function and contents.
configuration file. You cannot set the variable in a recipe file.
See the
:yocto_git:`local.conf.sample.extended </poky/tree/meta-poky/conf/local.conf.sample.extended>`
:yocto_git:`local.conf.sample.extended </poky/tree/meta-poky/conf/templates/default/local.conf.sample.extended>`
file for additional information. Also, for information on creating an
initramfs, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section
in the Yocto Project Development Tasks Manual.
@@ -6075,9 +6074,9 @@ system and gives an overview of their function and contents.
:term:`PRSERV_HOST`
The network based :term:`PR` service host and port.
The ``conf/local.conf.sample.extended`` configuration file in the
:term:`Source Directory` shows how the
:term:`PRSERV_HOST` variable is set::
The ``conf/templates/default/local.conf.sample.extended`` configuration
file in the :term:`Source Directory` shows how the :term:`PRSERV_HOST`
variable is set::
PRSERV_HOST = "localhost:0"
@@ -8666,7 +8665,8 @@ system and gives an overview of their function and contents.
USER_CLASSES ?= "buildstats"
For more information, see
``meta-poky/conf/local.conf.sample`` in the :term:`Source Directory`.
``meta-poky/conf/templates/default/local.conf.sample`` in the
:term:`Source Directory`.
:term:`USERADD_ERROR_DYNAMIC`
If set to ``error``, forces the OpenEmbedded build system to produce
@@ -8924,4 +8924,3 @@ system and gives an overview of their function and contents.
On systems where many tasks run in parallel, setting a limit to this
can be helpful in controlling system resource usage.