summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/classes.rst6
-rw-r--r--documentation/ref-manual/devtool-reference.rst2
-rw-r--r--documentation/ref-manual/faq.rst4
-rw-r--r--documentation/ref-manual/qa-checks.rst4
-rw-r--r--documentation/ref-manual/resources.rst12
-rw-r--r--documentation/ref-manual/structure.rst10
-rw-r--r--documentation/ref-manual/terms.rst4
-rw-r--r--documentation/ref-manual/variables.rst48
-rw-r--r--documentation/ref-manual/varlocality.rst2
9 files changed, 46 insertions, 46 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 729aa259e0..d0ed539229 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -108,18 +108,18 @@ support is either not present or is broken.
108It's useful to have some idea of how the tasks defined by the 108It's useful to have some idea of how the tasks defined by the
109``autotools*`` classes work and what they do behind the scenes. 109``autotools*`` classes work and what they do behind the scenes.
110 110
111- :ref:`ref-tasks-configure` - Regenerates the 111- :ref:`ref-tasks-configure` --- regenerates the
112 configure script (using ``autoreconf``) and then launches it with a 112 configure script (using ``autoreconf``) and then launches it with a
113 standard set of arguments used during cross-compilation. You can pass 113 standard set of arguments used during cross-compilation. You can pass
114 additional parameters to ``configure`` through the :term:`EXTRA_OECONF` 114 additional parameters to ``configure`` through the :term:`EXTRA_OECONF`
115 or :term:`PACKAGECONFIG_CONFARGS` 115 or :term:`PACKAGECONFIG_CONFARGS`
116 variables. 116 variables.
117 117
118- :ref:`ref-tasks-compile` - Runs ``make`` with 118- :ref:`ref-tasks-compile` --- runs ``make`` with
119 arguments that specify the compiler and linker. You can pass 119 arguments that specify the compiler and linker. You can pass
120 additional arguments through the :term:`EXTRA_OEMAKE` variable. 120 additional arguments through the :term:`EXTRA_OEMAKE` variable.
121 121
122- :ref:`ref-tasks-install` - Runs ``make install`` and 122- :ref:`ref-tasks-install` --- runs ``make install`` and
123 passes in ``${``\ :term:`D`\ ``}`` as ``DESTDIR``. 123 passes in ``${``\ :term:`D`\ ``}`` as ``DESTDIR``.
124 124
125.. _ref-classes-base: 125.. _ref-classes-base:
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst
index 10ca70a2b3..997ec0351c 100644
--- a/documentation/ref-manual/devtool-reference.rst
+++ b/documentation/ref-manual/devtool-reference.rst
@@ -164,7 +164,7 @@ Adding a New Recipe to the Workspace Layer
164========================================== 164==========================================
165 165
166Use the ``devtool add`` command to add a new recipe to the workspace 166Use the ``devtool add`` command to add a new recipe to the workspace
167layer. The recipe you add should not exist - ``devtool`` creates it for 167layer. The recipe you add should not exist --- ``devtool`` creates it for
168you. The source files the recipe uses should exist in an external area. 168you. The source files the recipe uses should exist in an external area.
169 169
170The following example creates and adds a new recipe named ``jackson`` to 170The following example creates and adds a new recipe named ``jackson`` to
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index 3eee9e1be5..2fcbf7da96 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -364,7 +364,7 @@ redirect requests through proxy servers.
364 364
365**Q:** Can I get rid of build output so I can start over? 365**Q:** Can I get rid of build output so I can start over?
366 366
367**A:** Yes - you can easily do this. When you use BitBake to build an 367**A:** Yes --- you can easily do this. When you use BitBake to build an
368image, all the build output goes into the directory created when you run 368image, all the build output goes into the directory created when you run
369the build environment setup script (i.e. 369the build environment setup script (i.e.
370:ref:`structure-core-script`). By default, this :term:`Build Directory` 370:ref:`structure-core-script`). By default, this :term:`Build Directory`
@@ -428,7 +428,7 @@ relatively normal and the second is not:
428 build/tmp/sysroots/x86_64-linux/usr/bin 428 build/tmp/sysroots/x86_64-linux/usr/bin
429 429
430Even if the paths look unusual, 430Even if the paths look unusual,
431they both are correct - the first for a target and the second for a 431they both are correct --- the first for a target and the second for a
432native recipe. These paths are a consequence of the ``DESTDIR`` 432native recipe. These paths are a consequence of the ``DESTDIR``
433mechanism and while they appear strange, they are correct and in 433mechanism and while they appear strange, they are correct and in
434practice very effective. 434practice very effective.
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst
index 8c475d0f72..fbab1dc92e 100644
--- a/documentation/ref-manual/qa-checks.rst
+++ b/documentation/ref-manual/qa-checks.rst
@@ -613,7 +613,7 @@ Errors and Warnings
613 so using ${:term:`BPN`} rather than ${:term:`PN`} as the latter will change 613 so using ${:term:`BPN`} rather than ${:term:`PN`} as the latter will change
614 for different variants of the same recipe e.g. when :term:`BBCLASSEXTEND` 614 for different variants of the same recipe e.g. when :term:`BBCLASSEXTEND`
615 or multilib are being used. This check will fail if a reference to ``${PN}`` 615 or multilib are being used. This check will fail if a reference to ``${PN}``
616 is found within the :term:`SRC_URI` value - change it to ``${BPN}`` instead. 616 is found within the :term:`SRC_URI` value --- change it to ``${BPN}`` instead.
617 617
618 618
619.. _qa-check-unhandled-features-check: 619.. _qa-check-unhandled-features-check:
@@ -727,7 +727,7 @@ Errors and Warnings
727 devtool modify <recipe> 727 devtool modify <recipe>
728 728
729 This will apply all of the patches, and create new commits out of them in 729 This will apply all of the patches, and create new commits out of them in
730 the workspace - with the patch context updated. 730 the workspace --- with the patch context updated.
731 731
732 Then, replace the patches in the recipe layer:: 732 Then, replace the patches in the recipe layer::
733 733
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
index c942384662..292a9d6f61 100644
--- a/documentation/ref-manual/resources.rst
+++ b/documentation/ref-manual/resources.rst
@@ -64,22 +64,22 @@ and announcements. To subscribe to one of the following mailing lists,
64click on the appropriate URL in the following list and follow the 64click on the appropriate URL in the following list and follow the
65instructions: 65instructions:
66 66
67- :yocto_lists:`/g/yocto` - General Yocto Project 67- :yocto_lists:`/g/yocto` --- general Yocto Project
68 discussion mailing list. 68 discussion mailing list.
69 69
70- :oe_lists:`/g/openembedded-core` - Discussion mailing 70- :oe_lists:`/g/openembedded-core` --- discussion mailing
71 list about OpenEmbedded-Core (the core metadata). 71 list about OpenEmbedded-Core (the core metadata).
72 72
73- :oe_lists:`/g/openembedded-devel` - Discussion 73- :oe_lists:`/g/openembedded-devel` --- discussion
74 mailing list about OpenEmbedded. 74 mailing list about OpenEmbedded.
75 75
76- :oe_lists:`/g/bitbake-devel` - Discussion mailing 76- :oe_lists:`/g/bitbake-devel` --- discussion mailing
77 list about the :term:`BitBake` build tool. 77 list about the :term:`BitBake` build tool.
78 78
79- :yocto_lists:`/g/poky` - Discussion mailing list 79- :yocto_lists:`/g/poky` --- discussion mailing list
80 about :term:`Poky`. 80 about :term:`Poky`.
81 81
82- :yocto_lists:`/g/yocto-announce` - Mailing list to 82- :yocto_lists:`/g/yocto-announce` --- mailing list to
83 receive official Yocto Project release and milestone announcements. 83 receive official Yocto Project release and milestone announcements.
84 84
85For more Yocto Project-related mailing lists, see the 85For more Yocto Project-related mailing lists, see the
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst
index 12a085552f..bdcffc1947 100644
--- a/documentation/ref-manual/structure.rst
+++ b/documentation/ref-manual/structure.rst
@@ -213,8 +213,8 @@ These files are standard top-level files.
213 213
214.. _structure-build: 214.. _structure-build:
215 215
216The Build Directory - ``build/`` 216The Build Directory --- ``build/``
217================================ 217==================================
218 218
219The OpenEmbedded build system creates the :term:`Build Directory` 219The OpenEmbedded build system creates the :term:`Build Directory`
220when you run the build environment setup 220when you run the build environment setup
@@ -589,7 +589,7 @@ install" places its output that is then split into sub-packages within
589``build/tmp/work/tunearch/recipename/version/`` 589``build/tmp/work/tunearch/recipename/version/``
590----------------------------------------------- 590-----------------------------------------------
591 591
592The recipe work directory - ``${WORKDIR}``. 592The recipe work directory --- ``${WORKDIR}``.
593 593
594As described earlier in the 594As described earlier in the
595":ref:`structure-build-tmp-sysroots`" section, 595":ref:`structure-build-tmp-sysroots`" section,
@@ -654,8 +654,8 @@ recipes. In practice, this is only used for ``gcc`` and its variants
654 654
655.. _structure-meta: 655.. _structure-meta:
656 656
657The Metadata - ``meta/`` 657The Metadata --- ``meta/``
658======================== 658==========================
659 659
660As mentioned previously, :term:`Metadata` is the core of the 660As mentioned previously, :term:`Metadata` is the core of the
661Yocto Project. Metadata has several important subdivisions: 661Yocto Project. Metadata has several important subdivisions:
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index 512032a67e..1e3f718a8f 100644
--- a/documentation/ref-manual/terms.rst
+++ b/documentation/ref-manual/terms.rst
@@ -270,7 +270,7 @@ universal, the list includes them just in case:
270 your Linux distribution. 270 your Linux distribution.
271 271
272 Another point worth noting is that historically within the Yocto 272 Another point worth noting is that historically within the Yocto
273 Project, recipes were referred to as packages - thus, the existence 273 Project, recipes were referred to as packages --- thus, the existence
274 of several BitBake variables that are seemingly mis-named, (e.g. 274 of several BitBake variables that are seemingly mis-named, (e.g.
275 :term:`PR`, :term:`PV`, and 275 :term:`PR`, :term:`PV`, and
276 :term:`PE`). 276 :term:`PE`).
@@ -369,7 +369,7 @@ universal, the list includes them just in case:
369 Directory created by unpacking a released tarball as compared to 369 Directory created by unpacking a released tarball as compared to
370 cloning ``git://git.yoctoproject.org/poky``. When you unpack a 370 cloning ``git://git.yoctoproject.org/poky``. When you unpack a
371 tarball, you have an exact copy of the files based on the time of 371 tarball, you have an exact copy of the files based on the time of
372 release - a fixed release point. Any changes you make to your local 372 release --- a fixed release point. Any changes you make to your local
373 files in the Source Directory are on top of the release and will 373 files in the Source Directory are on top of the release and will
374 remain local only. On the other hand, when you clone the ``poky`` Git 374 remain local only. On the other hand, when you clone the ``poky`` Git
375 repository, you have an active development repository with access to 375 repository, you have an active development repository with access to
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index f723e38d1a..b42854caaa 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -591,7 +591,7 @@ system and gives an overview of their function and contents.
591 This variable is useful in situations where the same recipe appears 591 This variable is useful in situations where the same recipe appears
592 in more than one layer. Setting this variable allows you to 592 in more than one layer. Setting this variable allows you to
593 prioritize a layer against other layers that contain the same recipe 593 prioritize a layer against other layers that contain the same recipe
594 - effectively letting you control the precedence for the multiple 594 --- effectively letting you control the precedence for the multiple
595 layers. The precedence established through this variable stands 595 layers. The precedence established through this variable stands
596 regardless of a recipe's version (:term:`PV` variable). For 596 regardless of a recipe's version (:term:`PV` variable). For
597 example, a layer that has a recipe with a higher :term:`PV` value but for 597 example, a layer that has a recipe with a higher :term:`PV` value but for
@@ -889,7 +889,7 @@ system and gives an overview of their function and contents.
889 :term:`BUILD_OS` 889 :term:`BUILD_OS`
890 Specifies the operating system in use on the build host (e.g. 890 Specifies the operating system in use on the build host (e.g.
891 "linux"). The OpenEmbedded build system sets the value of 891 "linux"). The OpenEmbedded build system sets the value of
892 :term:`BUILD_OS` from the OS reported by the ``uname`` command - the 892 :term:`BUILD_OS` from the OS reported by the ``uname`` command --- the
893 first word, converted to lower-case characters. 893 first word, converted to lower-case characters.
894 894
895 :term:`BUILD_PREFIX` 895 :term:`BUILD_PREFIX`
@@ -1689,7 +1689,7 @@ system and gives an overview of their function and contents.
1689 ``${TMPDIR}/deploy``. 1689 ``${TMPDIR}/deploy``.
1690 1690
1691 For more information on the structure of the Build Directory, see 1691 For more information on the structure of the Build Directory, see
1692 ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section. 1692 ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section.
1693 For more detail on the contents of the ``deploy`` directory, see the 1693 For more detail on the contents of the ``deploy`` directory, see the
1694 ":ref:`overview-manual/concepts:images`", 1694 ":ref:`overview-manual/concepts:images`",
1695 ":ref:`overview-manual/concepts:package feeds`", and 1695 ":ref:`overview-manual/concepts:package feeds`", and
@@ -1733,7 +1733,7 @@ system and gives an overview of their function and contents.
1733 <ref-classes-image>` class. 1733 <ref-classes-image>` class.
1734 1734
1735 For more information on the structure of the Build Directory, see 1735 For more information on the structure of the Build Directory, see
1736 ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section. 1736 ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section.
1737 For more detail on the contents of the ``deploy`` directory, see the 1737 For more detail on the contents of the ``deploy`` directory, see the
1738 ":ref:`overview-manual/concepts:images`" and 1738 ":ref:`overview-manual/concepts:images`" and
1739 ":ref:`overview-manual/concepts:application development sdk`" sections both in 1739 ":ref:`overview-manual/concepts:application development sdk`" sections both in
@@ -2248,24 +2248,24 @@ system and gives an overview of their function and contents.
2248 2248
2249 Here are some examples of features you can add: 2249 Here are some examples of features you can add:
2250 2250
2251 - "dbg-pkgs" - Adds -dbg packages for all installed packages including 2251 - "dbg-pkgs" --- adds -dbg packages for all installed packages including
2252 symbol information for debugging and profiling. 2252 symbol information for debugging and profiling.
2253 2253
2254 - "debug-tweaks" - Makes an image suitable for debugging. For example, allows root logins without passwords and 2254 - "debug-tweaks" --- makes an image suitable for debugging. For example, allows root logins without passwords and
2255 enables post-installation logging. See the 'allow-empty-password' and 2255 enables post-installation logging. See the 'allow-empty-password' and
2256 'post-install-logging' features in the ":ref:`ref-features-image`" 2256 'post-install-logging' features in the ":ref:`ref-features-image`"
2257 section for more information. 2257 section for more information.
2258 - "dev-pkgs" - Adds -dev packages for all installed packages. This is 2258 - "dev-pkgs" --- adds -dev packages for all installed packages. This is
2259 useful if you want to develop against the libraries in the image. 2259 useful if you want to develop against the libraries in the image.
2260 - "read-only-rootfs" - Creates an image whose root filesystem is 2260 - "read-only-rootfs" --- creates an image whose root filesystem is
2261 read-only. See the 2261 read-only. See the
2262 ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`" 2262 ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`"
2263 section in the Yocto Project Development Tasks Manual for more 2263 section in the Yocto Project Development Tasks Manual for more
2264 information 2264 information
2265 - "tools-debug" - Adds debugging tools such as gdb and strace. 2265 - "tools-debug" --- adds debugging tools such as gdb and strace.
2266 - "tools-sdk" - Adds development tools such as gcc, make, 2266 - "tools-sdk" --- adds development tools such as gcc, make,
2267 pkgconfig and so forth. 2267 pkgconfig and so forth.
2268 - "tools-testapps" - Adds useful testing tools 2268 - "tools-testapps" --- adds useful testing tools
2269 such as ts_print, aplay, arecord and so forth. 2269 such as ts_print, aplay, arecord and so forth.
2270 2270
2271 For a complete list of image features that ships with the Yocto 2271 For a complete list of image features that ships with the Yocto
@@ -3259,7 +3259,7 @@ system and gives an overview of their function and contents.
3259 IMAGE_NAME ?= "${IMAGE_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}" 3259 IMAGE_NAME ?= "${IMAGE_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
3260 3260
3261 :term:`IMAGE_NAME_SUFFIX` 3261 :term:`IMAGE_NAME_SUFFIX`
3262 Suffix used for the image output filename - defaults to ``".rootfs"`` 3262 Suffix used for the image output filename --- defaults to ``".rootfs"``
3263 to distinguish the image file from other files created during image 3263 to distinguish the image file from other files created during image
3264 building; however if this suffix is redundant or not desired you can 3264 building; however if this suffix is redundant or not desired you can
3265 clear the value of this variable (set the value to ""). For example, 3265 clear the value of this variable (set the value to ""). For example,
@@ -6217,7 +6217,7 @@ system and gives an overview of their function and contents.
6217 ``baz``. 6217 ``baz``.
6218 6218
6219 The names of the packages you list within :term:`RDEPENDS` must be the 6219 The names of the packages you list within :term:`RDEPENDS` must be the
6220 names of other packages - they cannot be recipe names. Although 6220 names of other packages --- they cannot be recipe names. Although
6221 package names and recipe names usually match, the important point 6221 package names and recipe names usually match, the important point
6222 here is that you are providing package names within the :term:`RDEPENDS` 6222 here is that you are providing package names within the :term:`RDEPENDS`
6223 variable. For an example of the default list of packages created from 6223 variable. For an example of the default list of packages created from
@@ -7120,35 +7120,35 @@ system and gives an overview of their function and contents.
7120 7120
7121 There are standard and recipe-specific options. Here are standard ones: 7121 There are standard and recipe-specific options. Here are standard ones:
7122 7122
7123 - ``apply`` - Whether to apply the patch or not. The default 7123 - ``apply`` --- whether to apply the patch or not. The default
7124 action is to apply the patch. 7124 action is to apply the patch.
7125 7125
7126 - ``striplevel`` - Which striplevel to use when applying the 7126 - ``striplevel`` --- which striplevel to use when applying the
7127 patch. The default level is 1. 7127 patch. The default level is 1.
7128 7128
7129 - ``patchdir`` - Specifies the directory in which the patch should 7129 - ``patchdir`` --- specifies the directory in which the patch should
7130 be applied. The default is ``${``\ :term:`S`\ ``}``. 7130 be applied. The default is ``${``\ :term:`S`\ ``}``.
7131 7131
7132 Here are options specific to recipes building code from a revision 7132 Here are options specific to recipes building code from a revision
7133 control system: 7133 control system:
7134 7134
7135 - ``mindate`` - Apply the patch only if 7135 - ``mindate`` --- apply the patch only if
7136 :term:`SRCDATE` is equal to or greater than 7136 :term:`SRCDATE` is equal to or greater than
7137 ``mindate``. 7137 ``mindate``.
7138 7138
7139 - ``maxdate`` - Apply the patch only if :term:`SRCDATE` is not later 7139 - ``maxdate`` --- apply the patch only if :term:`SRCDATE` is not later
7140 than ``maxdate``. 7140 than ``maxdate``.
7141 7141
7142 - ``minrev`` - Apply the patch only if :term:`SRCREV` is equal to or 7142 - ``minrev`` --- apply the patch only if :term:`SRCREV` is equal to or
7143 greater than ``minrev``. 7143 greater than ``minrev``.
7144 7144
7145 - ``maxrev`` - Apply the patch only if :term:`SRCREV` is not later 7145 - ``maxrev`` --- apply the patch only if :term:`SRCREV` is not later
7146 than ``maxrev``. 7146 than ``maxrev``.
7147 7147
7148 - ``rev`` - Apply the patch only if :term:`SRCREV` is equal to 7148 - ``rev`` --- apply the patch only if :term:`SRCREV` is equal to
7149 ``rev``. 7149 ``rev``.
7150 7150
7151 - ``notrev`` - Apply the patch only if :term:`SRCREV` is not equal to 7151 - ``notrev`` --- apply the patch only if :term:`SRCREV` is not equal to
7152 ``rev``. 7152 ``rev``.
7153 7153
7154 .. note:: 7154 .. note::
@@ -8857,8 +8857,8 @@ system and gives an overview of their function and contents.
8857 - :term:`TMPDIR`: The top-level build output directory 8857 - :term:`TMPDIR`: The top-level build output directory
8858 - :term:`MULTIMACH_TARGET_SYS`: The target system identifier 8858 - :term:`MULTIMACH_TARGET_SYS`: The target system identifier
8859 - :term:`PN`: The recipe name 8859 - :term:`PN`: The recipe name
8860 - :term:`EXTENDPE`: The epoch - (if :term:`PE` is not specified, which 8860 - :term:`EXTENDPE`: The epoch --- if :term:`PE` is not specified, which
8861 is usually the case for most recipes, then `EXTENDPE` is blank) 8861 is usually the case for most recipes, then `EXTENDPE` is blank.
8862 - :term:`PV`: The recipe version 8862 - :term:`PV`: The recipe version
8863 - :term:`PR`: The recipe revision 8863 - :term:`PR`: The recipe revision
8864 8864
diff --git a/documentation/ref-manual/varlocality.rst b/documentation/ref-manual/varlocality.rst
index 5f7dba8775..e2c086ffa0 100644
--- a/documentation/ref-manual/varlocality.rst
+++ b/documentation/ref-manual/varlocality.rst
@@ -113,7 +113,7 @@ This section lists variables that are required for recipes.
113 113
114- :term:`LIC_FILES_CHKSUM` 114- :term:`LIC_FILES_CHKSUM`
115 115
116- :term:`SRC_URI` - used in recipes that fetch local or remote files. 116- :term:`SRC_URI` --- used in recipes that fetch local or remote files.
117 117
118.. _ref-varlocality-recipe-dependencies: 118.. _ref-varlocality-recipe-dependencies:
119 119