diff options
Diffstat (limited to 'documentation/ref-manual')
| -rw-r--r-- | documentation/ref-manual/classes.rst | 8 | ||||
| -rw-r--r-- | documentation/ref-manual/devtool-reference.rst | 8 | ||||
| -rw-r--r-- | documentation/ref-manual/faq.rst | 4 | ||||
| -rw-r--r-- | documentation/ref-manual/features.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/images.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/release-process.rst | 6 | ||||
| -rw-r--r-- | documentation/ref-manual/structure.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/terms.rst | 6 | ||||
| -rw-r--r-- | documentation/ref-manual/variables.rst | 8 |
9 files changed, 22 insertions, 24 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 216b236e33..05473edcca 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
| @@ -616,7 +616,7 @@ information about using :ref:`ref-classes-devshell`. | |||
| 616 | The :ref:`ref-classes-devupstream` class uses | 616 | The :ref:`ref-classes-devupstream` class uses |
| 617 | :term:`BBCLASSEXTEND` to add a variant of the | 617 | :term:`BBCLASSEXTEND` to add a variant of the |
| 618 | recipe that fetches from an alternative URI (e.g. Git) instead of a | 618 | recipe that fetches from an alternative URI (e.g. Git) instead of a |
| 619 | tarball. Following is an example:: | 619 | tarball. Here is an example:: |
| 620 | 620 | ||
| 621 | BBCLASSEXTEND = "devupstream:target" | 621 | BBCLASSEXTEND = "devupstream:target" |
| 622 | SRC_URI:class-devupstream = "git://git.example.com/example;branch=main" | 622 | SRC_URI:class-devupstream = "git://git.example.com/example;branch=main" |
| @@ -1141,8 +1141,8 @@ Please keep in mind that the QA checks | |||
| 1141 | are meant to detect real or potential problems in the packaged | 1141 | are meant to detect real or potential problems in the packaged |
| 1142 | output. So exercise caution when disabling these checks. | 1142 | output. So exercise caution when disabling these checks. |
| 1143 | 1143 | ||
| 1144 | Here are the tests you can list with the :term:`WARN_QA` and | 1144 | The tests you can list with the :term:`WARN_QA` and |
| 1145 | :term:`ERROR_QA` variables: | 1145 | :term:`ERROR_QA` variables are: |
| 1146 | 1146 | ||
| 1147 | - ``already-stripped:`` Checks that produced binaries have not | 1147 | - ``already-stripped:`` Checks that produced binaries have not |
| 1148 | already been stripped prior to the build system extracting debug | 1148 | already been stripped prior to the build system extracting debug |
| @@ -3148,7 +3148,7 @@ information. | |||
| 3148 | The :ref:`ref-classes-uboot-sign` class provides support for U-Boot verified boot. | 3148 | The :ref:`ref-classes-uboot-sign` class provides support for U-Boot verified boot. |
| 3149 | It is intended to be inherited from U-Boot recipes. | 3149 | It is intended to be inherited from U-Boot recipes. |
| 3150 | 3150 | ||
| 3151 | Here are variables used by this class: | 3151 | The variables used by this class are: |
| 3152 | 3152 | ||
| 3153 | - :term:`SPL_MKIMAGE_DTCOPTS`: DTC options for U-Boot ``mkimage`` when | 3153 | - :term:`SPL_MKIMAGE_DTCOPTS`: DTC options for U-Boot ``mkimage`` when |
| 3154 | building the FIT image. | 3154 | building the FIT image. |
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst index ba0385c4c8..4144277e88 100644 --- a/documentation/ref-manual/devtool-reference.rst +++ b/documentation/ref-manual/devtool-reference.rst | |||
| @@ -379,16 +379,14 @@ command:: | |||
| 379 | Unless you provide a specific recipe name on the command line, the | 379 | Unless you provide a specific recipe name on the command line, the |
| 380 | command checks all recipes in all configured layers. | 380 | command checks all recipes in all configured layers. |
| 381 | 381 | ||
| 382 | Following is a partial example table that reports on all the recipes. | 382 | Here is a partial example table that reports on all the recipes. |
| 383 | Notice the reported reason for not upgrading the ``base-passwd`` recipe. | 383 | Notice the reported reason for not upgrading the ``base-passwd`` recipe. |
| 384 | In this example, while a new version is available upstream, you do not | 384 | In this example, while a new version is available upstream, you do not |
| 385 | want to use it because the dependency on ``cdebconf`` is not easily | 385 | want to use it because the dependency on ``cdebconf`` is not easily |
| 386 | satisfied. Maintainers can explicit the reason that is shown by adding | 386 | satisfied. Maintainers can explicit the reason that is shown by adding |
| 387 | the :term:`RECIPE_NO_UPDATE_REASON` variable to the corresponding recipe. | 387 | the :term:`RECIPE_NO_UPDATE_REASON` variable to the corresponding recipe. |
| 388 | See :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>` | 388 | See :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>` |
| 389 | for an example. | 389 | for an example:: |
| 390 | |||
| 391 | :: | ||
| 392 | 390 | ||
| 393 | $ devtool check-upgrade-status | 391 | $ devtool check-upgrade-status |
| 394 | ... | 392 | ... |
| @@ -599,7 +597,7 @@ The ``devtool status`` command has no command-line options:: | |||
| 599 | 597 | ||
| 600 | $ devtool status | 598 | $ devtool status |
| 601 | 599 | ||
| 602 | Following is sample output after using | 600 | Here is sample output after using |
| 603 | :ref:`devtool add <ref-manual/devtool-reference:adding a new recipe to the workspace layer>` | 601 | :ref:`devtool add <ref-manual/devtool-reference:adding a new recipe to the workspace layer>` |
| 604 | to create and add the ``mtr_0.86.bb`` recipe to the ``workspace`` directory:: | 602 | to create and add the ``mtr_0.86.bb`` recipe to the ``workspace`` directory:: |
| 605 | 603 | ||
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index b428dc2db6..9fb60899c9 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst | |||
| @@ -312,7 +312,7 @@ HTTPS requests and direct them to the ``http://`` sources mirror. You | |||
| 312 | can use ``file://`` URLs to point to local directories or network shares | 312 | can use ``file://`` URLs to point to local directories or network shares |
| 313 | as well. | 313 | as well. |
| 314 | 314 | ||
| 315 | Here are other options:: | 315 | Another option is to set:: |
| 316 | 316 | ||
| 317 | BB_NO_NETWORK = "1" | 317 | BB_NO_NETWORK = "1" |
| 318 | 318 | ||
| @@ -328,7 +328,7 @@ This statement | |||
| 328 | limits the build system to pulling source from the :term:`PREMIRRORS` only. | 328 | limits the build system to pulling source from the :term:`PREMIRRORS` only. |
| 329 | Again, this technique is useful for reproducing builds. | 329 | Again, this technique is useful for reproducing builds. |
| 330 | 330 | ||
| 331 | Here is another technique:: | 331 | Here is yet another technique:: |
| 332 | 332 | ||
| 333 | BB_GENERATE_MIRROR_TARBALLS = "1" | 333 | BB_GENERATE_MIRROR_TARBALLS = "1" |
| 334 | 334 | ||
diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst index a7078c7f3a..4f0366eeb6 100644 --- a/documentation/ref-manual/features.rst +++ b/documentation/ref-manual/features.rst | |||
| @@ -198,7 +198,7 @@ you can add several different predefined packages such as development | |||
| 198 | utilities or packages with debug information needed to investigate | 198 | utilities or packages with debug information needed to investigate |
| 199 | application problems or profile applications. | 199 | application problems or profile applications. |
| 200 | 200 | ||
| 201 | Here are the image features available for all images: | 201 | The image features available for all images are: |
| 202 | 202 | ||
| 203 | - *allow-empty-password:* Allows Dropbear and OpenSSH to accept root | 203 | - *allow-empty-password:* Allows Dropbear and OpenSSH to accept root |
| 204 | logins and logins from accounts having an empty password string. | 204 | logins and logins from accounts having an empty password string. |
diff --git a/documentation/ref-manual/images.rst b/documentation/ref-manual/images.rst index da27512855..f875633128 100644 --- a/documentation/ref-manual/images.rst +++ b/documentation/ref-manual/images.rst | |||
| @@ -32,7 +32,7 @@ that contain image recipe files:: | |||
| 32 | 32 | ||
| 33 | $ ls meta*/recipes*/images/*.bb | 33 | $ ls meta*/recipes*/images/*.bb |
| 34 | 34 | ||
| 35 | Following is a list of supported recipes: | 35 | Here is a list of supported recipes: |
| 36 | 36 | ||
| 37 | - ``build-appliance-image``: An example virtual machine that contains | 37 | - ``build-appliance-image``: An example virtual machine that contains |
| 38 | all the pieces required to run builds using the build system as well | 38 | all the pieces required to run builds using the build system as well |
diff --git a/documentation/ref-manual/release-process.rst b/documentation/ref-manual/release-process.rst index 2393ac8d81..2913a4d4eb 100644 --- a/documentation/ref-manual/release-process.rst +++ b/documentation/ref-manual/release-process.rst | |||
| @@ -14,7 +14,7 @@ Major and Minor Release Cadence | |||
| 14 | 14 | ||
| 15 | The Yocto Project delivers major releases (e.g. &DISTRO;) using a six | 15 | The Yocto Project delivers major releases (e.g. &DISTRO;) using a six |
| 16 | month cadence roughly timed each April and October of the year. | 16 | month cadence roughly timed each April and October of the year. |
| 17 | Following are examples of some major YP releases with their codenames | 17 | Here are examples of some major YP releases with their codenames |
| 18 | also shown. See the ":ref:`ref-manual/release-process:major release codenames`" | 18 | also shown. See the ":ref:`ref-manual/release-process:major release codenames`" |
| 19 | section for information on codenames used with major releases. | 19 | section for information on codenames used with major releases. |
| 20 | 20 | ||
| @@ -29,8 +29,8 @@ major holidays in various geographies. | |||
| 29 | 29 | ||
| 30 | The Yocto project delivers minor (point) releases on an unscheduled | 30 | The Yocto project delivers minor (point) releases on an unscheduled |
| 31 | basis and are usually driven by the accumulation of enough significant | 31 | basis and are usually driven by the accumulation of enough significant |
| 32 | fixes or enhancements to the associated major release. Following are | 32 | fixes or enhancements to the associated major release. |
| 33 | some example past point releases: | 33 | Some example past point releases are: |
| 34 | 34 | ||
| 35 | - 4.1.3 | 35 | - 4.1.3 |
| 36 | - 4.0.8 | 36 | - 4.0.8 |
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index d21134fd7f..021e49e9d7 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
| @@ -530,7 +530,7 @@ recipe-specific :term:`WORKDIR` directories. Thus, the | |||
| 530 | This directory holds information that BitBake uses for accounting | 530 | This directory holds information that BitBake uses for accounting |
| 531 | purposes to track what tasks have run and when they have run. The | 531 | purposes to track what tasks have run and when they have run. The |
| 532 | directory is sub-divided by architecture, package name, and version. | 532 | directory is sub-divided by architecture, package name, and version. |
| 533 | Following is an example:: | 533 | Here is an example:: |
| 534 | 534 | ||
| 535 | stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do | 535 | stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do |
| 536 | 536 | ||
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index 2a5baa4cbf..d602f7ea36 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst | |||
| @@ -4,7 +4,7 @@ | |||
| 4 | Yocto Project Terms | 4 | Yocto Project Terms |
| 5 | ******************* | 5 | ******************* |
| 6 | 6 | ||
| 7 | Following is a list of terms and definitions users new to the Yocto Project | 7 | Here is a list of terms and definitions users new to the Yocto Project |
| 8 | development environment might find helpful. While some of these terms are | 8 | development environment might find helpful. While some of these terms are |
| 9 | universal, the list includes them just in case: | 9 | universal, the list includes them just in case: |
| 10 | 10 | ||
| @@ -66,8 +66,8 @@ universal, the list includes them just in case: | |||
| 66 | (i.e. :ref:`ref-manual/structure:\`\`oe-init-build-env\`\``). The | 66 | (i.e. :ref:`ref-manual/structure:\`\`oe-init-build-env\`\``). The |
| 67 | :term:`TOPDIR` variable points to the Build Directory. | 67 | :term:`TOPDIR` variable points to the Build Directory. |
| 68 | 68 | ||
| 69 | You have a lot of flexibility when creating the Build Directory. | 69 | You have a lot of flexibility when creating the :term:`Build Directory`. |
| 70 | Following are some examples that show how to create the directory. The | 70 | Here are some examples that show how to create the directory. The |
| 71 | examples assume your :term:`Source Directory` is named ``poky``: | 71 | examples assume your :term:`Source Directory` is named ``poky``: |
| 72 | 72 | ||
| 73 | - Create the Build Directory inside your Source Directory and let | 73 | - Create the Build Directory inside your Source Directory and let |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index ae14c450dd..691a0cdc1a 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
| @@ -318,7 +318,7 @@ system and gives an overview of their function and contents. | |||
| 318 | 318 | ||
| 319 | :term:`BB_ALLOWED_NETWORKS` | 319 | :term:`BB_ALLOWED_NETWORKS` |
| 320 | Specifies a space-delimited list of hosts that the fetcher is allowed | 320 | Specifies a space-delimited list of hosts that the fetcher is allowed |
| 321 | to use to obtain the required source code. Following are | 321 | to use to obtain the required source code. Here are |
| 322 | considerations surrounding this variable: | 322 | considerations surrounding this variable: |
| 323 | 323 | ||
| 324 | - This host list is only used if :term:`BB_NO_NETWORK` is either not set | 324 | - This host list is only used if :term:`BB_NO_NETWORK` is either not set |
| @@ -6174,7 +6174,7 @@ system and gives an overview of their function and contents. | |||
| 6174 | The :term:`PREFERRED_PROVIDER` variable is set with the name (:term:`PN`) of | 6174 | The :term:`PREFERRED_PROVIDER` variable is set with the name (:term:`PN`) of |
| 6175 | the recipe you prefer to provide "virtual/kernel". | 6175 | the recipe you prefer to provide "virtual/kernel". |
| 6176 | 6176 | ||
| 6177 | Following are more examples:: | 6177 | Here are more examples:: |
| 6178 | 6178 | ||
| 6179 | PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86" | 6179 | PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86" |
| 6180 | PREFERRED_PROVIDER_virtual/libgl ?= "mesa" | 6180 | PREFERRED_PROVIDER_virtual/libgl ?= "mesa" |
| @@ -8940,7 +8940,7 @@ system and gives an overview of their function and contents. | |||
| 8940 | configuration can define the :term:`UBOOT_MACHINE` and optionally the | 8940 | configuration can define the :term:`UBOOT_MACHINE` and optionally the |
| 8941 | :term:`IMAGE_FSTYPES` and the :term:`UBOOT_BINARY`. | 8941 | :term:`IMAGE_FSTYPES` and the :term:`UBOOT_BINARY`. |
| 8942 | 8942 | ||
| 8943 | Following is an example from the ``meta-freescale`` layer. :: | 8943 | Here is an example from the ``meta-freescale`` layer. :: |
| 8944 | 8944 | ||
| 8945 | UBOOT_CONFIG ??= "sdcard-ifc-secure-boot sdcard-ifc sdcard-qspi lpuart qspi secure-boot nor" | 8945 | UBOOT_CONFIG ??= "sdcard-ifc-secure-boot sdcard-ifc sdcard-qspi lpuart qspi secure-boot nor" |
| 8946 | UBOOT_CONFIG[nor] = "ls1021atwr_nor_defconfig" | 8946 | UBOOT_CONFIG[nor] = "ls1021atwr_nor_defconfig" |
| @@ -9413,7 +9413,7 @@ system and gives an overview of their function and contents. | |||
| 9413 | With the :term:`WKS_FILE_DEPENDS` variable, you have the possibility to | 9413 | With the :term:`WKS_FILE_DEPENDS` variable, you have the possibility to |
| 9414 | specify a list of additional dependencies (e.g. native tools, | 9414 | specify a list of additional dependencies (e.g. native tools, |
| 9415 | bootloaders, and so forth), that are required to build Wic images. | 9415 | bootloaders, and so forth), that are required to build Wic images. |
| 9416 | Following is an example:: | 9416 | Here is an example:: |
| 9417 | 9417 | ||
| 9418 | WKS_FILE_DEPENDS = "some-native-tool" | 9418 | WKS_FILE_DEPENDS = "some-native-tool" |
| 9419 | 9419 | ||
