diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-05-04 14:57:51 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-05-10 12:52:34 +0100 |
commit | eae7c2a0c277c764a72073cdce1cdb2eb1fd1b9a (patch) | |
tree | fc3b2691dece36a13abc2892aea921d1dc601466 /documentation/dev-manual | |
parent | e3d64415eddb7c0a5c13a2a91611204c8abfbedb (diff) | |
download | poky-eae7c2a0c277c764a72073cdce1cdb2eb1fd1b9a.tar.gz |
manuals: fix name capitalization issues
- Using "BitBake" instead of "Bitbake" or "bitbake", aligning with the
title of the "BitBake User Manual".
- Using "OpenEmbedded" instead of "Openembedded"
- Using "Python" instead of "python"
(From yocto-docs rev: 0b893e2a15aefedd7100445fc9d7eeed07b6afc6)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r-- | documentation/dev-manual/common-tasks.rst | 14 | ||||
-rw-r--r-- | documentation/dev-manual/start.rst | 2 |
2 files changed, 8 insertions, 8 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 1da19b8d65..9b5a7536c1 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
@@ -5392,7 +5392,7 @@ create the properly partitioned image. | |||
5392 | 5392 | ||
5393 | The ``wic`` command generates partitioned images from existing | 5393 | The ``wic`` command generates partitioned images from existing |
5394 | OpenEmbedded build artifacts. Image generation is driven by partitioning | 5394 | OpenEmbedded build artifacts. Image generation is driven by partitioning |
5395 | commands contained in an Openembedded kickstart file (``.wks``) | 5395 | commands contained in an OpenEmbedded kickstart file (``.wks``) |
5396 | specified either directly on the command line or as one of a selection | 5396 | specified either directly on the command line or as one of a selection |
5397 | of canned kickstart files as shown with the ``wic list images`` command | 5397 | of canned kickstart files as shown with the ``wic list images`` command |
5398 | in the | 5398 | in the |
@@ -5464,7 +5464,7 @@ system needs to meet the following requirements: | |||
5464 | 5464 | ||
5465 | - You need to have the build artifacts already available, which | 5465 | - You need to have the build artifacts already available, which |
5466 | typically means that you must have already created an image using the | 5466 | typically means that you must have already created an image using the |
5467 | Openembedded build system (e.g. ``core-image-minimal``). While it | 5467 | OpenEmbedded build system (e.g. ``core-image-minimal``). While it |
5468 | might seem redundant to generate an image in order to create an image | 5468 | might seem redundant to generate an image in order to create an image |
5469 | using Wic, the current version of Wic requires the artifacts in the | 5469 | using Wic, the current version of Wic requires the artifacts in the |
5470 | form generated by the OpenEmbedded build system. | 5470 | form generated by the OpenEmbedded build system. |
@@ -5546,7 +5546,7 @@ Operational Modes | |||
5546 | ----------------- | 5546 | ----------------- |
5547 | 5547 | ||
5548 | You can use Wic in two different modes, depending on how much control | 5548 | You can use Wic in two different modes, depending on how much control |
5549 | you need for specifying the Openembedded build artifacts that are used | 5549 | you need for specifying the OpenEmbedded build artifacts that are used |
5550 | for creating the image: Raw and Cooked: | 5550 | for creating the image: Raw and Cooked: |
5551 | 5551 | ||
5552 | - *Raw Mode:* You explicitly specify build artifacts through Wic | 5552 | - *Raw Mode:* You explicitly specify build artifacts through Wic |
@@ -9214,7 +9214,7 @@ section: | |||
9214 | to run specific tasks in the build chain. It can be useful to run | 9214 | to run specific tasks in the build chain. It can be useful to run |
9215 | tasks "out-of-order" when trying isolate build issues. | 9215 | tasks "out-of-order" when trying isolate build issues. |
9216 | 9216 | ||
9217 | - ":ref:`dev-manual/common-tasks:general bitbake problems`" describes how | 9217 | - ":ref:`dev-manual/common-tasks:general BitBake problems`" describes how |
9218 | to use BitBake's ``-D`` debug output option to reveal more about what | 9218 | to use BitBake's ``-D`` debug output option to reveal more about what |
9219 | BitBake is doing during the build. | 9219 | BitBake is doing during the build. |
9220 | 9220 | ||
@@ -9409,7 +9409,7 @@ format and can be converted to images (e.g. using the ``dot`` tool from | |||
9409 | 9409 | ||
9410 | - DOT files use a plain text format. The graphs generated using the | 9410 | - DOT files use a plain text format. The graphs generated using the |
9411 | ``bitbake -g`` command are often so large as to be difficult to | 9411 | ``bitbake -g`` command are often so large as to be difficult to |
9412 | read without special pruning (e.g. with Bitbake's ``-I`` option) | 9412 | read without special pruning (e.g. with BitBake's ``-I`` option) |
9413 | and processing. Despite the form and size of the graphs, the | 9413 | and processing. Despite the form and size of the graphs, the |
9414 | corresponding ``.dot`` files can still be possible to read and | 9414 | corresponding ``.dot`` files can still be possible to read and |
9415 | provide useful information. | 9415 | provide useful information. |
@@ -10560,7 +10560,7 @@ used testing branches for OpenEmbedded-Core are as follows: | |||
10560 | 10560 | ||
10561 | - *poky "master-next" branch:* This branch is part of the | 10561 | - *poky "master-next" branch:* This branch is part of the |
10562 | :yocto_git:`poky </poky/>` repository and combines proposed | 10562 | :yocto_git:`poky </poky/>` repository and combines proposed |
10563 | changes to bitbake, the core metadata and the poky distro. | 10563 | changes to BitBake, the core metadata and the poky distro. |
10564 | 10564 | ||
10565 | Similarly, stable branches maintained by the project may have corresponding | 10565 | Similarly, stable branches maintained by the project may have corresponding |
10566 | ``-next`` branches which collect proposed changes. For example, | 10566 | ``-next`` branches which collect proposed changes. For example, |
@@ -11437,7 +11437,7 @@ this function, you have to follow the following steps: | |||
11437 | Please choose one that you want to use and enable the spdx task. You have to | 11437 | Please choose one that you want to use and enable the spdx task. You have to |
11438 | add some config options in ``local.conf`` file in your :term:`Build | 11438 | add some config options in ``local.conf`` file in your :term:`Build |
11439 | Directory`. Here is an example showing how to generate spdx files | 11439 | Directory`. Here is an example showing how to generate spdx files |
11440 | during bitbake using the fossology-python.bbclass:: | 11440 | during BitBake using the fossology-python.bbclass:: |
11441 | 11441 | ||
11442 | # Select fossology-python.bbclass. | 11442 | # Select fossology-python.bbclass. |
11443 | INHERIT += "fossology-python" | 11443 | INHERIT += "fossology-python" |
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 96fabac1aa..8cf3ebe316 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst | |||
@@ -496,7 +496,7 @@ your Yocto Project build host: | |||
496 | 496 | ||
497 | 6. *Optimize your WSLv2 storage often:* Due to the way storage is | 497 | 6. *Optimize your WSLv2 storage often:* Due to the way storage is |
498 | handled on WSLv2, the storage space used by the undelying Linux | 498 | handled on WSLv2, the storage space used by the undelying Linux |
499 | distribution is not reflected immedately, and since bitbake heavily | 499 | distribution is not reflected immedately, and since BitBake heavily |
500 | uses storage, after several builds, you may be unaware you are | 500 | uses storage, after several builds, you may be unaware you are |
501 | running out of space. WSLv2 uses a VHDX file for storage, this issue | 501 | running out of space. WSLv2 uses a VHDX file for storage, this issue |
502 | can be easily avoided by manually optimizing this file often, this | 502 | can be easily avoided by manually optimizing this file often, this |