summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-04-15 17:58:45 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-04-23 16:39:03 +0100
commit773536c333248214f8f41eff698d8bfd3c687249 (patch)
tree526a86685e2d035455505f8ba45450bc70060e4b /documentation/ref-manual
parent21b42cc54f37fcbfdfa3ea69694b4f2003433d02 (diff)
downloadpoky-773536c333248214f8f41eff698d8bfd3c687249.tar.gz
manuals: simplify code insertion
This replaces instances of ": ::" by "::", which generates identical HTML output (From yocto-docs rev: 1f410dfc7c16c09af612de659f8574ef6cff4636) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/faq.rst8
-rw-r--r--documentation/ref-manual/images.rst2
-rw-r--r--documentation/ref-manual/migration-1.3.rst4
-rw-r--r--documentation/ref-manual/migration-1.6.rst2
-rw-r--r--documentation/ref-manual/migration-1.8.rst6
-rw-r--r--documentation/ref-manual/migration-2.2.rst2
-rw-r--r--documentation/ref-manual/migration-2.5.rst2
-rw-r--r--documentation/ref-manual/migration-3.1.rst4
-rw-r--r--documentation/ref-manual/migration-3.2.rst6
-rw-r--r--documentation/ref-manual/qa-checks.rst10
-rw-r--r--documentation/ref-manual/variables.rst12
11 files changed, 29 insertions, 29 deletions
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index 64fdfdf756..a9103f83c6 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -125,7 +125,7 @@ file.
125 125
126Following is the applicable code for setting various proxy types in the 126Following is the applicable code for setting various proxy types in the
127``.wgetrc`` file. By default, these settings are disabled with comments. 127``.wgetrc`` file. By default, these settings are disabled with comments.
128To use them, remove the comments: :: 128To use them, remove the comments::
129 129
130 # You can set the default proxies for Wget to use for http, https, and ftp. 130 # You can set the default proxies for Wget to use for http, https, and ftp.
131 # They will override the value in the environment. 131 # They will override the value in the environment.
@@ -224,7 +224,7 @@ to add a BSP-specific netbase that includes an interfaces file. See the
224the Yocto Project Board Support Packages (BSP) Developer's Guide for 224the Yocto Project Board Support Packages (BSP) Developer's Guide for
225information on creating these types of miscellaneous recipe files. 225information on creating these types of miscellaneous recipe files.
226 226
227For example, add the following files to your layer: :: 227For example, add the following files to your layer::
228 228
229 meta-MACHINE/recipes-bsp/netbase/netbase/MACHINE/interfaces 229 meta-MACHINE/recipes-bsp/netbase/netbase/MACHINE/interfaces
230 meta-MACHINE/recipes-bsp/netbase/netbase_5.0.bbappend 230 meta-MACHINE/recipes-bsp/netbase/netbase_5.0.bbappend
@@ -300,7 +300,7 @@ fail.
300 300
301As an example, you could add a specific server for the build system to 301As an example, you could add a specific server for the build system to
302attempt before any others by adding something like the following to the 302attempt before any others by adding something like the following to the
303``local.conf`` configuration file: :: 303``local.conf`` configuration file::
304 304
305 PREMIRRORS_prepend = "\ 305 PREMIRRORS_prepend = "\
306 git://.*/.* http://www.yoctoproject.org/sources/ \n \ 306 git://.*/.* http://www.yoctoproject.org/sources/ \n \
@@ -343,7 +343,7 @@ however, the technique can simply waste time during the build.
343 343
344Finally, consider an example where you are behind an HTTP-only firewall. 344Finally, consider an example where you are behind an HTTP-only firewall.
345You could make the following changes to the ``local.conf`` configuration 345You could make the following changes to the ``local.conf`` configuration
346file as long as the ``PREMIRRORS`` server is current: :: 346file as long as the ``PREMIRRORS`` server is current::
347 347
348 PREMIRRORS_prepend = "\ 348 PREMIRRORS_prepend = "\
349 ftp://.*/.* http://www.yoctoproject.org/sources/ \n \ 349 ftp://.*/.* http://www.yoctoproject.org/sources/ \n \
diff --git a/documentation/ref-manual/images.rst b/documentation/ref-manual/images.rst
index cf5cc1109f..6b4e958a85 100644
--- a/documentation/ref-manual/images.rst
+++ b/documentation/ref-manual/images.rst
@@ -27,7 +27,7 @@ image you want.
27 27
28From within the ``poky`` Git repository, you can use the following 28From within the ``poky`` Git repository, you can use the following
29command to display the list of directories within the :term:`Source Directory` 29command to display the list of directories within the :term:`Source Directory`
30that contain image recipe files: :: 30that contain image recipe files::
31 31
32 $ ls meta*/recipes*/images/*.bb 32 $ ls meta*/recipes*/images/*.bb
33 33
diff --git a/documentation/ref-manual/migration-1.3.rst b/documentation/ref-manual/migration-1.3.rst
index 0929f490d7..7c522dc123 100644
--- a/documentation/ref-manual/migration-1.3.rst
+++ b/documentation/ref-manual/migration-1.3.rst
@@ -29,7 +29,7 @@ location (either local or remote) and then point to it in
29:term:`SSTATE_MIRRORS`, you need to append "PATH" 29:term:`SSTATE_MIRRORS`, you need to append "PATH"
30to the end of the mirror URL so that the path used by BitBake before the 30to the end of the mirror URL so that the path used by BitBake before the
31mirror substitution is appended to the path used to access the mirror. 31mirror substitution is appended to the path used to access the mirror.
32Here is an example: :: 32Here is an example::
33 33
34 SSTATE_MIRRORS = "file://.* http://someserver.tld/share/sstate/PATH" 34 SSTATE_MIRRORS = "file://.* http://someserver.tld/share/sstate/PATH"
35 35
@@ -188,7 +188,7 @@ include :term:`PE` as part of the filename:
188 188
189Because the ``PE`` variable is not set by default, these binary files 189Because the ``PE`` variable is not set by default, these binary files
190could result with names that include two dash characters. Here is an 190could result with names that include two dash characters. Here is an
191example: :: 191example::
192 192
193 bzImage--3.10.9+git0+cd502a8814_7144bcc4b8-r0-qemux86-64-20130830085431.bin 193 bzImage--3.10.9+git0+cd502a8814_7144bcc4b8-r0-qemux86-64-20130830085431.bin
194 194
diff --git a/documentation/ref-manual/migration-1.6.rst b/documentation/ref-manual/migration-1.6.rst
index 4c6afab1fb..fe3e04d685 100644
--- a/documentation/ref-manual/migration-1.6.rst
+++ b/documentation/ref-manual/migration-1.6.rst
@@ -207,7 +207,7 @@ functions to call and not arbitrary shell commands:
207 207
208For 208For
209migration purposes, you can simply wrap shell commands in a shell 209migration purposes, you can simply wrap shell commands in a shell
210function and then call the function. Here is an example: :: 210function and then call the function. Here is an example::
211 211
212 my_postprocess_function() { 212 my_postprocess_function() {
213 echo "hello" > ${IMAGE_ROOTFS}/hello.txt 213 echo "hello" > ${IMAGE_ROOTFS}/hello.txt
diff --git a/documentation/ref-manual/migration-1.8.rst b/documentation/ref-manual/migration-1.8.rst
index ec2b138796..68d5dcf859 100644
--- a/documentation/ref-manual/migration-1.8.rst
+++ b/documentation/ref-manual/migration-1.8.rst
@@ -56,7 +56,7 @@ you can now remove them.
56Additionally, a ``bluetooth`` class has been added to make selection of 56Additionally, a ``bluetooth`` class has been added to make selection of
57the appropriate bluetooth support within a recipe a little easier. If 57the appropriate bluetooth support within a recipe a little easier. If
58you wish to make use of this class in a recipe, add something such as 58you wish to make use of this class in a recipe, add something such as
59the following: :: 59the following::
60 60
61 inherit bluetooth 61 inherit bluetooth
62 PACKAGECONFIG ??= "${@bb.utils.contains('DISTRO_FEATURES', 'bluetooth', '${BLUEZ}', '', d)}" 62 PACKAGECONFIG ??= "${@bb.utils.contains('DISTRO_FEATURES', 'bluetooth', '${BLUEZ}', '', d)}"
@@ -84,7 +84,7 @@ where the ``linux.inc`` file in ``meta-oe`` was updated.
84 84
85Recipes that rely on the kernel source code and do not inherit the 85Recipes that rely on the kernel source code and do not inherit the
86module classes might need to add explicit dependencies on the 86module classes might need to add explicit dependencies on the
87``do_shared_workdir`` kernel task, for example: :: 87``do_shared_workdir`` kernel task, for example::
88 88
89 do_configure[depends] += "virtual/kernel:do_shared_workdir" 89 do_configure[depends] += "virtual/kernel:do_shared_workdir"
90 90
@@ -131,7 +131,7 @@ One of the improvements is to attempt to run "make clean" during the
131``do_configure`` task if a ``Makefile`` exists. Some software packages 131``do_configure`` task if a ``Makefile`` exists. Some software packages
132do not provide a working clean target within their make files. If you 132do not provide a working clean target within their make files. If you
133have such recipes, you need to set 133have such recipes, you need to set
134:term:`CLEANBROKEN` to "1" within the recipe, for example: :: 134:term:`CLEANBROKEN` to "1" within the recipe, for example::
135 135
136 CLEANBROKEN = "1" 136 CLEANBROKEN = "1"
137 137
diff --git a/documentation/ref-manual/migration-2.2.rst b/documentation/ref-manual/migration-2.2.rst
index 198181a469..d11735163e 100644
--- a/documentation/ref-manual/migration-2.2.rst
+++ b/documentation/ref-manual/migration-2.2.rst
@@ -179,7 +179,7 @@ Supported machines are as follows:
179 179
180Consider the 180Consider the
181following example, which uses the ``qemux86-64`` machine, provides a 181following example, which uses the ``qemux86-64`` machine, provides a
182root filesystem, provides an image, and uses the ``nographic`` option: :: 182root filesystem, provides an image, and uses the ``nographic`` option::
183 183
184 $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.ext4 tmp/deploy/images/qemux86-64/bzImage nographic 184 $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.ext4 tmp/deploy/images/qemux86-64/bzImage nographic
185 185
diff --git a/documentation/ref-manual/migration-2.5.rst b/documentation/ref-manual/migration-2.5.rst
index 9ef4b55399..fd5f2f88e0 100644
--- a/documentation/ref-manual/migration-2.5.rst
+++ b/documentation/ref-manual/migration-2.5.rst
@@ -169,7 +169,7 @@ one of the packages provided by the Python recipe. You can no longer run
169``bitbake python-foo`` or have a 169``bitbake python-foo`` or have a
170:term:`DEPENDS` on ``python-foo``, 170:term:`DEPENDS` on ``python-foo``,
171but doing either of the following causes the package to work as 171but doing either of the following causes the package to work as
172expected: :: 172expected::
173 173
174 IMAGE_INSTALL_append = " python-foo" 174 IMAGE_INSTALL_append = " python-foo"
175 175
diff --git a/documentation/ref-manual/migration-3.1.rst b/documentation/ref-manual/migration-3.1.rst
index 84d32502e5..c62aba7d48 100644
--- a/documentation/ref-manual/migration-3.1.rst
+++ b/documentation/ref-manual/migration-3.1.rst
@@ -179,12 +179,12 @@ parameter instead of the earlier ``name`` which overlapped with the
179generic ``name`` parameter. All recipes using the npm fetcher will need 179generic ``name`` parameter. All recipes using the npm fetcher will need
180to be changed as a result. 180to be changed as a result.
181 181
182An example of the new scheme: :: 182An example of the new scheme::
183 183
184 SRC_URI = "npm://registry.npmjs.org;package=array-flatten;version=1.1.1 \ 184 SRC_URI = "npm://registry.npmjs.org;package=array-flatten;version=1.1.1 \
185 npmsw://${THISDIR}/npm-shrinkwrap.json" 185 npmsw://${THISDIR}/npm-shrinkwrap.json"
186 186
187Another example where the sources are fetched from git rather than an npm repository: :: 187Another example where the sources are fetched from git rather than an npm repository::
188 188
189 SRC_URI = "git://github.com/foo/bar.git;protocol=https \ 189 SRC_URI = "git://github.com/foo/bar.git;protocol=https \
190 npmsw://${THISDIR}/npm-shrinkwrap.json" 190 npmsw://${THISDIR}/npm-shrinkwrap.json"
diff --git a/documentation/ref-manual/migration-3.2.rst b/documentation/ref-manual/migration-3.2.rst
index 39743af70d..956a56f626 100644
--- a/documentation/ref-manual/migration-3.2.rst
+++ b/documentation/ref-manual/migration-3.2.rst
@@ -90,12 +90,12 @@ If you have anonymous python or in-line python conditionally adding
90dependencies in your custom recipes, and you intend for those recipes to 90dependencies in your custom recipes, and you intend for those recipes to
91work with multilib, then you will need to ensure that ``${MLPREFIX}`` 91work with multilib, then you will need to ensure that ``${MLPREFIX}``
92is prefixed on the package names in the dependencies, for example 92is prefixed on the package names in the dependencies, for example
93(from the ``glibc`` recipe): :: 93(from the ``glibc`` recipe)::
94 94
95 RRECOMMENDS_${PN} = "${@bb.utils.contains('DISTRO_FEATURES', 'ldconfig', '${MLPREFIX}ldconfig', '', d)}" 95 RRECOMMENDS_${PN} = "${@bb.utils.contains('DISTRO_FEATURES', 'ldconfig', '${MLPREFIX}ldconfig', '', d)}"
96 96
97This also applies when conditionally adding packages to :term:`PACKAGES` where 97This also applies when conditionally adding packages to :term:`PACKAGES` where
98those packages have dependencies, for example (from the ``alsa-plugins`` recipe): :: 98those packages have dependencies, for example (from the ``alsa-plugins`` recipe)::
99 99
100 PACKAGES += "${@bb.utils.contains('PACKAGECONFIG', 'pulseaudio', 'alsa-plugins-pulseaudio-conf', '', d)}" 100 PACKAGES += "${@bb.utils.contains('PACKAGECONFIG', 'pulseaudio', 'alsa-plugins-pulseaudio-conf', '', d)}"
101 ... 101 ...
@@ -229,7 +229,7 @@ needs ``/etc/ld.so.conf`` to be present at image build time:
229 229
230When some recipe installs libraries to a non-standard location, and 230When some recipe installs libraries to a non-standard location, and
231therefore installs in a file in ``/etc/ld.so.conf.d/foo.conf``, we 231therefore installs in a file in ``/etc/ld.so.conf.d/foo.conf``, we
232need ``/etc/ld.so.conf`` containing: :: 232need ``/etc/ld.so.conf`` containing::
233 233
234 include /etc/ld.so.conf.d/*.conf 234 include /etc/ld.so.conf.d/*.conf
235 235
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst
index 6cb767d934..79d2d4266a 100644
--- a/documentation/ref-manual/qa-checks.rst
+++ b/documentation/ref-manual/qa-checks.rst
@@ -675,7 +675,7 @@ Errors and Warnings
675 task. Patch fuzz is a situation when the ``patch`` tool ignores some of the context 675 task. Patch fuzz is a situation when the ``patch`` tool ignores some of the context
676 lines in order to apply the patch. Consider this example: 676 lines in order to apply the patch. Consider this example:
677 677
678 Patch to be applied: :: 678 Patch to be applied::
679 679
680 --- filename 680 --- filename
681 +++ filename 681 +++ filename
@@ -687,7 +687,7 @@ Errors and Warnings
687 context line 5 687 context line 5
688 context line 6 688 context line 6
689 689
690 Original source code: :: 690 Original source code::
691 691
692 different context line 1 692 different context line 1
693 different context line 2 693 different context line 2
@@ -696,7 +696,7 @@ Errors and Warnings
696 different context line 5 696 different context line 5
697 different context line 6 697 different context line 6
698 698
699 Outcome (after applying patch with fuzz): :: 699 Outcome (after applying patch with fuzz)::
700 700
701 different context line 1 701 different context line 1
702 different context line 2 702 different context line 2
@@ -716,14 +716,14 @@ Errors and Warnings
716 *How to eliminate patch fuzz warnings* 716 *How to eliminate patch fuzz warnings*
717 717
718 Use the ``devtool`` command as explained by the warning. First, unpack the 718 Use the ``devtool`` command as explained by the warning. First, unpack the
719 source into devtool workspace: :: 719 source into devtool workspace::
720 720
721 devtool modify <recipe> 721 devtool modify <recipe>
722 722
723 This will apply all of the patches, and create new commits out of them in 723 This will apply all of the patches, and create new commits out of them in
724 the workspace - with the patch context updated. 724 the workspace - with the patch context updated.
725 725
726 Then, replace the patches in the recipe layer: :: 726 Then, replace the patches in the recipe layer::
727 727
728 devtool finish --force-patch-refresh <recipe> <layer_path> 728 devtool finish --force-patch-refresh <recipe> <layer_path>
729 729
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 74ac12bf98..9435aec458 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -728,7 +728,7 @@ system and gives an overview of their function and contents.
728 728
729 If you want to mask out multiple directories or recipes, you can 729 If you want to mask out multiple directories or recipes, you can
730 specify multiple regular expression fragments. This next example 730 specify multiple regular expression fragments. This next example
731 masks out multiple directories and individual recipes: :: 731 masks out multiple directories and individual recipes::
732 732
733 BBMASK += "/meta-ti/recipes-misc/ meta-ti/recipes-ti/packagegroup/" 733 BBMASK += "/meta-ti/recipes-misc/ meta-ti/recipes-ti/packagegroup/"
734 BBMASK += "/meta-oe/recipes-support/" 734 BBMASK += "/meta-oe/recipes-support/"
@@ -4890,13 +4890,13 @@ system and gives an overview of their function and contents.
4890 Prevents installation of all "recommended-only" packages. 4890 Prevents installation of all "recommended-only" packages.
4891 Recommended-only packages are packages installed only through the 4891 Recommended-only packages are packages installed only through the
4892 :term:`RRECOMMENDS` variable). Setting the 4892 :term:`RRECOMMENDS` variable). Setting the
4893 ``NO_RECOMMENDATIONS`` variable to "1" turns this feature on: :: 4893 ``NO_RECOMMENDATIONS`` variable to "1" turns this feature on::
4894 4894
4895 NO_RECOMMENDATIONS = "1" 4895 NO_RECOMMENDATIONS = "1"
4896 4896
4897 You can set this variable globally in your ``local.conf`` file or you 4897 You can set this variable globally in your ``local.conf`` file or you
4898 can attach it to a specific image recipe by using the recipe name 4898 can attach it to a specific image recipe by using the recipe name
4899 override: :: 4899 override::
4900 4900
4901 NO_RECOMMENDATIONS_pn-target_image = "1" 4901 NO_RECOMMENDATIONS_pn-target_image = "1"
4902 4902
@@ -6924,7 +6924,7 @@ system and gives an overview of their function and contents.
6924 ``/proc/console`` before enabling them using getty. This variable 6924 ``/proc/console`` before enabling them using getty. This variable
6925 allows aliasing in the format: <device>:<alias>. If a device was 6925 allows aliasing in the format: <device>:<alias>. If a device was
6926 listed as "sclp_line0" in ``/dev/`` and "ttyS0" was listed in 6926 listed as "sclp_line0" in ``/dev/`` and "ttyS0" was listed in
6927 ``/proc/console``, you would do the following: :: 6927 ``/proc/console``, you would do the following::
6928 6928
6929 SERIAL_CONSOLES_CHECK = "slcp_line0:ttyS0" 6929 SERIAL_CONSOLES_CHECK = "slcp_line0:ttyS0"
6930 6930
@@ -6934,7 +6934,7 @@ system and gives an overview of their function and contents.
6934 :term:`SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS` 6934 :term:`SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS`
6935 A list of recipe dependencies that should not be used to determine 6935 A list of recipe dependencies that should not be used to determine
6936 signatures of tasks from one recipe when they depend on tasks from 6936 signatures of tasks from one recipe when they depend on tasks from
6937 another recipe. For example: :: 6937 another recipe. For example::
6938 6938
6939 SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "intone->mplayer2" 6939 SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "intone->mplayer2"
6940 6940
@@ -6942,7 +6942,7 @@ system and gives an overview of their function and contents.
6942 6942
6943 You can use the special token ``"*"`` on the left-hand side of the 6943 You can use the special token ``"*"`` on the left-hand side of the
6944 dependency to match all recipes except the one on the right-hand 6944 dependency to match all recipes except the one on the right-hand
6945 side. Here is an example: :: 6945 side. Here is an example::
6946 6946
6947 SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "*->quilt-native" 6947 SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "*->quilt-native"
6948 6948