summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorUlrich Ölmann <u.oelmann@pengutronix.de>2022-09-02 13:29:30 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-09-12 08:35:17 +0100
commit05270ae200779f6595d5f4b08c6a0bbef2063430 (patch)
treec5ca2b2747e8415f17a8dc7366234a8ccf05000e
parentf212ad190c065509bb9d65ae3f4a619469a90a85 (diff)
downloadpoky-05270ae200779f6595d5f4b08c6a0bbef2063430.tar.gz
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>
-rw-r--r--documentation/dev-manual/common-tasks.rst16
-rw-r--r--documentation/overview-manual/concepts.rst4
-rw-r--r--documentation/ref-manual/faq.rst7
-rw-r--r--documentation/ref-manual/variables.rst25
4 files changed, 26 insertions, 26 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index b08a55331d..bdc528b723 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -11417,12 +11417,12 @@ example:
11417 # clean up the .git repos 11417 # clean up the .git repos
11418 $ find . -name ".git" -type d -exec rm -rf {} \; 11418 $ find . -name ".git" -type d -exec rm -rf {} \;
11419 11419
11420One 11420One thing a development organization might want to consider for end-user
11421thing a development organization might want to consider for end-user 11421convenience is to modify
11422convenience is to modify ``meta-poky/conf/bblayers.conf.sample`` to 11422``meta-poky/conf/templates/default/bblayers.conf.sample`` to ensure that when
11423ensure that when the end user utilizes the released build system to 11423the end user utilizes the released build system to build an image, the
11424build an image, the development organization's layers are included in 11424development organization's layers are included in the ``bblayers.conf`` file
11425the ``bblayers.conf`` file automatically:: 11425automatically::
11426 11426
11427 # POKY_BBLAYERS_CONF_VERSION is increased each time build/conf/bblayers.conf 11427 # POKY_BBLAYERS_CONF_VERSION is increased each time build/conf/bblayers.conf
11428 # changes incompatibly 11428 # changes incompatibly
@@ -11451,9 +11451,9 @@ The spdx module has been integrated to a layer named meta-spdxscanner.
11451meta-spdxscanner provides several kinds of scanner. If you want to enable 11451meta-spdxscanner provides several kinds of scanner. If you want to enable
11452this function, you have to follow the following steps: 11452this function, you have to follow the following steps:
11453 11453
114541. Add meta-spdxscanner layer into ``bblayers.conf``. 114541. Add meta-spdxscanner layer into ``bblayers.conf``.
11455 11455
114562. Refer to the README in meta-spdxscanner to setup the environment (e.g, 114562. Refer to the README in meta-spdxscanner to setup the environment (e.g,
11457 setup a fossology server) needed for the scanner. 11457 setup a fossology server) needed for the scanner.
11458 11458
114593. Meta-spdxscanner provides several methods within the bbclass to create spdx files. 114593. Meta-spdxscanner provides several methods within the bbclass to create spdx files.
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index 83339da98f..8e0303f0e0 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -269,7 +269,7 @@ The ``local.conf`` file provides many basic variables that define a
269build environment. Here is a list of a few. To see the default 269build environment. Here is a list of a few. To see the default
270configurations in a ``local.conf`` file created by the build environment 270configurations in a ``local.conf`` file created by the build environment
271script, see the 271script, see the
272:yocto_git:`local.conf.sample </poky/tree/meta-poky/conf/local.conf.sample>` 272:yocto_git:`local.conf.sample </poky/tree/meta-poky/conf/templates/default/local.conf.sample>`
273in the ``meta-poky`` layer: 273in the ``meta-poky`` layer:
274 274
275- *Target Machine Selection:* Controlled by the 275- *Target Machine Selection:* Controlled by the
@@ -1006,7 +1006,7 @@ data files are deleted from the root filesystem. As part of the final
1006stage of package installation, post installation scripts that are part 1006stage of package installation, post installation scripts that are part
1007of the packages are run. Any scripts that fail to run on the build host 1007of the packages are run. Any scripts that fail to run on the build host
1008are run on the target when the target system is first booted. If you are 1008are run on the target when the target system is first booted. If you are
1009using a 1009using a
1010:ref:`read-only root filesystem <dev-manual/common-tasks:creating a read-only root filesystem>`, 1010:ref:`read-only root filesystem <dev-manual/common-tasks:creating a read-only root filesystem>`,
1011all the post installation scripts must succeed on the build host during 1011all the post installation scripts must succeed on the build host during
1012the package installation phase since the root filesystem on the target 1012the package installation phase since the root filesystem on the target
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index 2fcbf7da96..61049523a0 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -137,9 +137,10 @@ To use them, remove the comments::
137 #use_proxy = on 137 #use_proxy = on
138 138
139The Yocto Project also includes a 139The Yocto Project also includes a
140``meta-poky/conf/site.conf.sample`` file that shows how to configure CVS 140``meta-poky/conf/templates/default/site.conf.sample`` file that shows
141and Git proxy servers if needed. For more information on setting up 141how to configure CVS and Git proxy servers if needed. For more
142various proxy types and configuring proxy servers, see the 142information on setting up various proxy types and configuring proxy
143servers, see the
143":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" 144":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`"
144Wiki page. 145Wiki page.
145 146
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index cf817e9540..df7d4bfbae 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -135,7 +135,6 @@ system and gives an overview of their function and contents.
135 appear in :term:`DISTRO_FEATURES` within the current configuration, then 135 appear in :term:`DISTRO_FEATURES` within the current configuration, then
136 the recipe will be skipped, and if the build system attempts to build 136 the recipe will be skipped, and if the build system attempts to build
137 the recipe then an error will be triggered. 137 the recipe then an error will be triggered.
138
139 138
140 :term:`APPEND` 139 :term:`APPEND`
141 An override list of append strings for each target specified with 140 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.
2386 .. note:: 2385 .. note::
2387 2386
2388 From a security perspective, hardcoding a default password is not 2387 From a security perspective, hardcoding a default password is not
2389 generally a good idea or even legal in some jurisdictions. It is 2388 generally a good idea or even legal in some jurisdictions. It is
2390 recommended that you do not do this if you are building a production 2389 recommended that you do not do this if you are building a production
2391 image. 2390 image.
2392 2391
2393 Additionally there is a special ``passwd-expire`` command that will 2392 Additionally there is a special ``passwd-expire`` command that will
@@ -3690,10 +3689,10 @@ system and gives an overview of their function and contents.
3690 to "core-image-minimal-initramfs". 3689 to "core-image-minimal-initramfs".
3691 3690
3692 You can also find more information by referencing the 3691 You can also find more information by referencing the
3693 ``meta-poky/conf/local.conf.sample.extended`` configuration file in 3692 ``meta-poky/conf/templates/default/local.conf.sample.extended``
3694 the Source Directory, the :ref:`image <ref-classes-image>` class, 3693 configuration file in the Source Directory, the :ref:`image
3695 and the :ref:`kernel <ref-classes-kernel>` class to see how to use 3694 <ref-classes-image>` class, and the :ref:`kernel <ref-classes-kernel>`
3696 the :term:`INITRAMFS_IMAGE` variable. 3695 class to see how to use the :term:`INITRAMFS_IMAGE` variable.
3697 3696
3698 If :term:`INITRAMFS_IMAGE` is empty, which is the default, then no 3697 If :term:`INITRAMFS_IMAGE` is empty, which is the default, then no
3699 initramfs image is built. 3698 initramfs image is built.
@@ -3752,7 +3751,7 @@ system and gives an overview of their function and contents.
3752 configuration file. You cannot set the variable in a recipe file. 3751 configuration file. You cannot set the variable in a recipe file.
3753 3752
3754 See the 3753 See the
3755 :yocto_git:`local.conf.sample.extended </poky/tree/meta-poky/conf/local.conf.sample.extended>` 3754 :yocto_git:`local.conf.sample.extended </poky/tree/meta-poky/conf/templates/default/local.conf.sample.extended>`
3756 file for additional information. Also, for information on creating an 3755 file for additional information. Also, for information on creating an
3757 initramfs, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section 3756 initramfs, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section
3758 in the Yocto Project Development Tasks Manual. 3757 in the Yocto Project Development Tasks Manual.
@@ -6075,9 +6074,9 @@ system and gives an overview of their function and contents.
6075 :term:`PRSERV_HOST` 6074 :term:`PRSERV_HOST`
6076 The network based :term:`PR` service host and port. 6075 The network based :term:`PR` service host and port.
6077 6076
6078 The ``conf/local.conf.sample.extended`` configuration file in the 6077 The ``conf/templates/default/local.conf.sample.extended`` configuration
6079 :term:`Source Directory` shows how the 6078 file in the :term:`Source Directory` shows how the :term:`PRSERV_HOST`
6080 :term:`PRSERV_HOST` variable is set:: 6079 variable is set::
6081 6080
6082 PRSERV_HOST = "localhost:0" 6081 PRSERV_HOST = "localhost:0"
6083 6082
@@ -8666,7 +8665,8 @@ system and gives an overview of their function and contents.
8666 USER_CLASSES ?= "buildstats" 8665 USER_CLASSES ?= "buildstats"
8667 8666
8668 For more information, see 8667 For more information, see
8669 ``meta-poky/conf/local.conf.sample`` in the :term:`Source Directory`. 8668 ``meta-poky/conf/templates/default/local.conf.sample`` in the
8669 :term:`Source Directory`.
8670 8670
8671 :term:`USERADD_ERROR_DYNAMIC` 8671 :term:`USERADD_ERROR_DYNAMIC`
8672 If set to ``error``, forces the OpenEmbedded build system to produce 8672 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.
8924 8924
8925 On systems where many tasks run in parallel, setting a limit to this 8925 On systems where many tasks run in parallel, setting a limit to this
8926 can be helpful in controlling system resource usage. 8926 can be helpful in controlling system resource usage.
8927