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 | |
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>
20 files changed, 36 insertions, 36 deletions
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index 12cab1db76..7179f25022 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst | |||
@@ -424,9 +424,9 @@ information including the website, wiki pages, and user manuals: | |||
424 | development documentation, and access to a rich Yocto Project | 424 | development documentation, and access to a rich Yocto Project |
425 | Development Community into which you can tap. | 425 | Development Community into which you can tap. |
426 | 426 | ||
427 | - **Video Seminar:** The `Introduction to the Yocto Project and Bitbake, Part 1 | 427 | - **Video Seminar:** The `Introduction to the Yocto Project and BitBake, Part 1 |
428 | <https://youtu.be/yuE7my3KOpo>`__ and | 428 | <https://youtu.be/yuE7my3KOpo>`__ and |
429 | `Introduction to the Yocto Project and Bitbake, Part 2 | 429 | `Introduction to the Yocto Project and BitBake, Part 2 |
430 | <https://youtu.be/iZ05TTyzGHk>`__ videos offer a video seminar | 430 | <https://youtu.be/iZ05TTyzGHk>`__ videos offer a video seminar |
431 | introducing you to the most important aspects of developing a | 431 | introducing you to the most important aspects of developing a |
432 | custom embedded Linux distribution with the Yocto Project. | 432 | custom embedded Linux distribution with the Yocto Project. |
diff --git a/documentation/conf.py b/documentation/conf.py index a7cdf415f8..baf550e3e3 100644 --- a/documentation/conf.py +++ b/documentation/conf.py | |||
@@ -19,7 +19,7 @@ try: | |||
19 | import yaml | 19 | import yaml |
20 | except ImportError: | 20 | except ImportError: |
21 | sys.stderr.write("The Yocto Project Sphinx documentation requires PyYAML.\ | 21 | sys.stderr.write("The Yocto Project Sphinx documentation requires PyYAML.\ |
22 | \nPlease make sure to install pyyaml python package.\n") | 22 | \nPlease make sure to install pyyaml Python package.\n") |
23 | sys.exit(1) | 23 | sys.exit(1) |
24 | 24 | ||
25 | # current_version = "dev" | 25 | # current_version = "dev" |
@@ -108,7 +108,7 @@ extlinks = { | |||
108 | 'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None), | 108 | 'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None), |
109 | } | 109 | } |
110 | 110 | ||
111 | # Intersphinx config to use cross reference with Bitbake user manual | 111 | # Intersphinx config to use cross reference with BitBake user manual |
112 | intersphinx_mapping = { | 112 | intersphinx_mapping = { |
113 | 'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None) | 113 | 'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None) |
114 | } | 114 | } |
@@ -129,7 +129,7 @@ try: | |||
129 | } | 129 | } |
130 | except ImportError: | 130 | except ImportError: |
131 | sys.stderr.write("The Sphinx sphinx_rtd_theme HTML theme was not found.\ | 131 | sys.stderr.write("The Sphinx sphinx_rtd_theme HTML theme was not found.\ |
132 | \nPlease make sure to install the sphinx_rtd_theme python package.\n") | 132 | \nPlease make sure to install the sphinx_rtd_theme Python package.\n") |
133 | sys.exit(1) | 133 | sys.exit(1) |
134 | 134 | ||
135 | html_logo = 'sphinx-static/YoctoProject_Logo_RGB.jpg' | 135 | html_logo = 'sphinx-static/YoctoProject_Logo_RGB.jpg' |
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 |
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst index a5dd02ccf2..547da8a178 100644 --- a/documentation/kernel-dev/common.rst +++ b/documentation/kernel-dev/common.rst | |||
@@ -1560,7 +1560,7 @@ source directory. Follow these steps to clean up the version string: | |||
1560 | on building the kernel image when using ``devtool``, see the | 1560 | on building the kernel image when using ``devtool``, see the |
1561 | ":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`" | 1561 | ":ref:`kernel-dev/common:using \`\`devtool\`\` to patch the kernel`" |
1562 | section. For | 1562 | section. For |
1563 | information on building the kernel image when using Bitbake, see the | 1563 | information on building the kernel image when using BitBake, see the |
1564 | ":ref:`kernel-dev/common:using traditional kernel development to patch the kernel`" | 1564 | ":ref:`kernel-dev/common:using traditional kernel development to patch the kernel`" |
1565 | section. | 1565 | section. |
1566 | 1566 | ||
diff --git a/documentation/kernel-dev/concepts-appx.rst b/documentation/kernel-dev/concepts-appx.rst index 910318e0f9..8ec3d6be45 100644 --- a/documentation/kernel-dev/concepts-appx.rst +++ b/documentation/kernel-dev/concepts-appx.rst | |||
@@ -318,7 +318,7 @@ tree specific to your kernel from which to generate the new kernel | |||
318 | image. | 318 | image. |
319 | 319 | ||
320 | The following figure shows the temporary file structure created on your | 320 | The following figure shows the temporary file structure created on your |
321 | host system when you build the kernel using Bitbake. This | 321 | host system when you build the kernel using BitBake. This |
322 | :term:`Build Directory` contains all the | 322 | :term:`Build Directory` contains all the |
323 | source files used during the build. | 323 | source files used during the build. |
324 | 324 | ||
diff --git a/documentation/migration-guides/migration-2.2.rst b/documentation/migration-guides/migration-2.2.rst index 10aa2d0684..fe7bc2cf55 100644 --- a/documentation/migration-guides/migration-2.2.rst +++ b/documentation/migration-guides/migration-2.2.rst | |||
@@ -70,7 +70,7 @@ Metadata Must Now Use Python 3 Syntax | |||
70 | 70 | ||
71 | The metadata is now required to use Python 3 syntax. For help preparing | 71 | The metadata is now required to use Python 3 syntax. For help preparing |
72 | metadata, see any of the many Python 3 porting guides available. | 72 | metadata, see any of the many Python 3 porting guides available. |
73 | Alternatively, you can reference the conversion commits for Bitbake and | 73 | Alternatively, you can reference the conversion commits for BitBake and |
74 | you can use :term:`OpenEmbedded-Core (OE-Core)` as a guide for changes. Following are | 74 | you can use :term:`OpenEmbedded-Core (OE-Core)` as a guide for changes. Following are |
75 | particular areas of interest: | 75 | particular areas of interest: |
76 | 76 | ||
diff --git a/documentation/migration-guides/migration-2.7.rst b/documentation/migration-guides/migration-2.7.rst index ae70353bf7..1b8f1ce1bb 100644 --- a/documentation/migration-guides/migration-2.7.rst +++ b/documentation/migration-guides/migration-2.7.rst | |||
@@ -15,7 +15,7 @@ The following changes have been made to BitBake: | |||
15 | functions (e.g. ``def funcname:``) in the metadata for tab | 15 | functions (e.g. ``def funcname:``) in the metadata for tab |
16 | indentation. If found, BitBake produces a warning. | 16 | indentation. If found, BitBake produces a warning. |
17 | 17 | ||
18 | - Bitbake now checks | 18 | - BitBake now checks |
19 | :term:`BBFILE_COLLECTIONS` for duplicate | 19 | :term:`BBFILE_COLLECTIONS` for duplicate |
20 | entries and triggers an error if any are found. | 20 | entries and triggers an error if any are found. |
21 | 21 | ||
diff --git a/documentation/migration-guides/migration-3.0.rst b/documentation/migration-guides/migration-3.0.rst index 50d6758e71..1219edf921 100644 --- a/documentation/migration-guides/migration-3.0.rst +++ b/documentation/migration-guides/migration-3.0.rst | |||
@@ -152,7 +152,7 @@ by ``CVE_CHECK_WHITELIST`` (replaced by :term:`CVE_CHECK_IGNORE` in version 3.5) | |||
152 | 152 | ||
153 | .. _migration-3.0-bitbake-changes: | 153 | .. _migration-3.0-bitbake-changes: |
154 | 154 | ||
155 | Bitbake Changes | 155 | BitBake Changes |
156 | --------------- | 156 | --------------- |
157 | 157 | ||
158 | The following BitBake changes have occurred. | 158 | The following BitBake changes have occurred. |
diff --git a/documentation/migration-guides/migration-3.2.rst b/documentation/migration-guides/migration-3.2.rst index d593effe97..470403a298 100644 --- a/documentation/migration-guides/migration-3.2.rst +++ b/documentation/migration-guides/migration-3.2.rst | |||
@@ -86,7 +86,7 @@ value to be explicitly prepended to package names being added as | |||
86 | dependencies (e.g. in :term:`RDEPENDS` and :term:`RRECOMMENDS` values) | 86 | dependencies (e.g. in :term:`RDEPENDS` and :term:`RRECOMMENDS` values) |
87 | where the dependency is conditionally added. | 87 | where the dependency is conditionally added. |
88 | 88 | ||
89 | If you have anonymous python or in-line python conditionally adding | 89 | If you have anonymous Python or in-line Python conditionally adding |
90 | dependencies in your custom recipes, and you intend for those recipes to | 90 | dependencies in your custom recipes, and you intend for those recipes to |
91 | work with multilib, then you will need to ensure that ``${MLPREFIX}`` | 91 | work with multilib, then you will need to ensure that ``${MLPREFIX}`` |
92 | is prefixed on the package names in the dependencies, for example | 92 | is prefixed on the package names in the dependencies, for example |
@@ -149,7 +149,7 @@ the upstream documentation for ``dhcpcd`` and ``kea`` for further details. | |||
149 | Packaging changes | 149 | Packaging changes |
150 | ----------------- | 150 | ----------------- |
151 | 151 | ||
152 | - ``python3``: the ``urllib`` python package has now moved into the core package, as it is used more commonly than just netclient (e.g. email, xml, mimetypes, pydoc). In addition, the ``pathlib`` module is now also part of the core package. | 152 | - ``python3``: the ``urllib`` Python package has now moved into the core package, as it is used more commonly than just netclient (e.g. email, xml, mimetypes, pydoc). In addition, the ``pathlib`` module is now also part of the core package. |
153 | 153 | ||
154 | - ``iptables``: ``iptables-apply`` and ``ip6tables-apply`` have been split out to their own package to avoid a bash dependency in the main ``iptables`` package | 154 | - ``iptables``: ``iptables-apply`` and ``ip6tables-apply`` have been split out to their own package to avoid a bash dependency in the main ``iptables`` package |
155 | 155 | ||
diff --git a/documentation/migration-guides/migration-3.3.rst b/documentation/migration-guides/migration-3.3.rst index 1eb494c286..22562dacd4 100644 --- a/documentation/migration-guides/migration-3.3.rst +++ b/documentation/migration-guides/migration-3.3.rst | |||
@@ -76,7 +76,7 @@ Some example recipes where this change has been made: ``gpgme``, ``libcap-ng``, | |||
76 | 76 | ||
77 | .. _migration-3.3-distutils-path: | 77 | .. _migration-3.3-distutils-path: |
78 | 78 | ||
79 | ``setup.py`` path for python modules | 79 | ``setup.py`` path for Python modules |
80 | ------------------------------------ | 80 | ------------------------------------ |
81 | 81 | ||
82 | In a Python module, sometimes ``setup.py`` can be buried deep in the | 82 | In a Python module, sometimes ``setup.py`` can be buried deep in the |
@@ -133,7 +133,7 @@ unless you want to take advantage of the improved granularity: | |||
133 | - ``procps``: split ``ps`` and ``sysctl`` into their own packages | 133 | - ``procps``: split ``ps`` and ``sysctl`` into their own packages |
134 | - ``rpm``: split build and extra functionality into separate packages | 134 | - ``rpm``: split build and extra functionality into separate packages |
135 | - ``sudo``: split ``sudo`` binary into ``sudo-sudo`` and libs into ``sudo-lib`` | 135 | - ``sudo``: split ``sudo`` binary into ``sudo-sudo`` and libs into ``sudo-lib`` |
136 | - ``systemtap``: examples, python scripts and runtime material split out | 136 | - ``systemtap``: examples, Python scripts and runtime material split out |
137 | - ``util-linux``: ``libuuid`` has been split out to its own | 137 | - ``util-linux``: ``libuuid`` has been split out to its own |
138 | ``util-linux-libuuid`` recipe (and corresponding packages) to avoid circular | 138 | ``util-linux-libuuid`` recipe (and corresponding packages) to avoid circular |
139 | dependencies if ``libgcrypt`` support is enabled in ``util-linux``. | 139 | dependencies if ``libgcrypt`` support is enabled in ``util-linux``. |
diff --git a/documentation/migration-guides/migration-3.4.rst b/documentation/migration-guides/migration-3.4.rst index d57c955eb4..8db43a1454 100644 --- a/documentation/migration-guides/migration-3.4.rst +++ b/documentation/migration-guides/migration-3.4.rst | |||
@@ -233,7 +233,7 @@ Image / SDK generation changes | |||
233 | Miscellaneous | 233 | Miscellaneous |
234 | ~~~~~~~~~~~~~ | 234 | ~~~~~~~~~~~~~ |
235 | 235 | ||
236 | - Certificates are now properly checked when bitbake fetches sources | 236 | - Certificates are now properly checked when BitBake fetches sources |
237 | over HTTPS. If you receive errors as a result for your custom recipes, | 237 | over HTTPS. If you receive errors as a result for your custom recipes, |
238 | you will need to use a mirror or address the issue with the operators | 238 | you will need to use a mirror or address the issue with the operators |
239 | of the server in question. | 239 | of the server in question. |
diff --git a/documentation/migration-guides/release-notes-3.4.1.rst b/documentation/migration-guides/release-notes-3.4.1.rst index b122887661..0503f29b2c 100644 --- a/documentation/migration-guides/release-notes-3.4.1.rst +++ b/documentation/migration-guides/release-notes-3.4.1.rst | |||
@@ -46,7 +46,7 @@ Fixes in 3.4.1 | |||
46 | - bitbake: tests/fetch: Update pcre.org address after github changes | 46 | - bitbake: tests/fetch: Update pcre.org address after github changes |
47 | - bitbake: tests/runqueue: Ensure hashserv exits before deleting files | 47 | - bitbake: tests/runqueue: Ensure hashserv exits before deleting files |
48 | - bitbake: utils: Handle lockfile filenames that are too long for filesystems | 48 | - bitbake: utils: Handle lockfile filenames that are too long for filesystems |
49 | - bootchart2: Don't compile python modules | 49 | - bootchart2: Don't compile Python modules |
50 | - build-appliance-image: Update to honister head revision | 50 | - build-appliance-image: Update to honister head revision |
51 | - buildhistory: Fix package output files for SDKs | 51 | - buildhistory: Fix package output files for SDKs |
52 | - busybox: 1.34.0 -> 1.34.1 | 52 | - busybox: 1.34.0 -> 1.34.1 |
diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst index fb1553d70d..0fd703d8a5 100644 --- a/documentation/profile-manual/usage.rst +++ b/documentation/profile-manual/usage.rst | |||
@@ -740,7 +740,7 @@ entry/exit events we recorded:: | |||
740 | root@crownbay:~# perf script -g python | 740 | root@crownbay:~# perf script -g python |
741 | generated Python script: perf-script.py | 741 | generated Python script: perf-script.py |
742 | 742 | ||
743 | The skeleton script simply creates a python function for each event type in the | 743 | The skeleton script simply creates a Python function for each event type in the |
744 | perf.data file. The body of each function simply prints the event name along | 744 | perf.data file. The body of each function simply prints the event name along |
745 | with its parameters. For example: | 745 | with its parameters. For example: |
746 | 746 | ||
@@ -859,7 +859,7 @@ goes a little way to support the idea mentioned previously that given | |||
859 | the right kind of trace data, higher-level profiling-type summaries can | 859 | the right kind of trace data, higher-level profiling-type summaries can |
860 | be derived from it. | 860 | be derived from it. |
861 | 861 | ||
862 | Documentation on using the `'perf script' python | 862 | Documentation on using the `'perf script' Python |
863 | binding <https://linux.die.net/man/1/perf-script-python>`__. | 863 | binding <https://linux.die.net/man/1/perf-script-python>`__. |
864 | 864 | ||
865 | System-Wide Tracing and Profiling | 865 | System-Wide Tracing and Profiling |
@@ -1149,7 +1149,7 @@ section can be found here: | |||
1149 | - The `'perf script' | 1149 | - The `'perf script' |
1150 | manpage <https://linux.die.net/man/1/perf-script>`__. | 1150 | manpage <https://linux.die.net/man/1/perf-script>`__. |
1151 | 1151 | ||
1152 | - Documentation on using the `'perf script' python | 1152 | - Documentation on using the `'perf script' Python |
1153 | binding <https://linux.die.net/man/1/perf-script-python>`__. | 1153 | binding <https://linux.die.net/man/1/perf-script-python>`__. |
1154 | 1154 | ||
1155 | - The top-level `perf(1) manpage <https://linux.die.net/man/1/perf>`__. | 1155 | - The top-level `perf(1) manpage <https://linux.die.net/man/1/perf>`__. |
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index a2b8763e7c..cb08a75c90 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst | |||
@@ -522,7 +522,7 @@ scratch is guaranteed. | |||
522 | Starts a shell in which an interactive Python interpreter allows you to | 522 | Starts a shell in which an interactive Python interpreter allows you to |
523 | interact with the BitBake build environment. From within this shell, you | 523 | interact with the BitBake build environment. From within this shell, you |
524 | can directly examine and set bits from the data store and execute | 524 | can directly examine and set bits from the data store and execute |
525 | functions as if within the BitBake environment. See the ":ref:`dev-manual/common-tasks:using a python development shell`" section in | 525 | functions as if within the BitBake environment. See the ":ref:`dev-manual/common-tasks:using a Python development shell`" section in |
526 | the Yocto Project Development Tasks Manual for more information about | 526 | the Yocto Project Development Tasks Manual for more information about |
527 | using ``pydevshell``. | 527 | using ``pydevshell``. |
528 | 528 | ||
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index f8808cc052..f164b7317a 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -3551,7 +3551,7 @@ system and gives an overview of their function and contents. | |||
3551 | 3551 | ||
3552 | For more information on :term:`INHERIT`, see the | 3552 | For more information on :term:`INHERIT`, see the |
3553 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`" | 3553 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`" |
3554 | section in the Bitbake User Manual. | 3554 | section in the BitBake User Manual. |
3555 | 3555 | ||
3556 | :term:`INHERIT_DISTRO` | 3556 | :term:`INHERIT_DISTRO` |
3557 | Lists classes that will be inherited at the distribution level. It is | 3557 | Lists classes that will be inherited at the distribution level. It is |
diff --git a/documentation/sphinx/yocto-vars.py b/documentation/sphinx/yocto-vars.py index 8795eee0a0..643c0df904 100644 --- a/documentation/sphinx/yocto-vars.py +++ b/documentation/sphinx/yocto-vars.py | |||
@@ -13,7 +13,7 @@ try: | |||
13 | import yaml | 13 | import yaml |
14 | except ImportError: | 14 | except ImportError: |
15 | sys.stderr.write("The Yocto Project Sphinx documentation requires PyYAML.\ | 15 | sys.stderr.write("The Yocto Project Sphinx documentation requires PyYAML.\ |
16 | \nPlease make sure to install pyyaml python package.\n") | 16 | \nPlease make sure to install pyyaml Python package.\n") |
17 | sys.exit(1) | 17 | sys.exit(1) |
18 | 18 | ||
19 | __version__ = '1.0' | 19 | __version__ = '1.0' |
diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst index 9c1a93cd40..17cde316b3 100644 --- a/documentation/test-manual/intro.rst +++ b/documentation/test-manual/intro.rst | |||
@@ -72,7 +72,7 @@ simple JSON files. | |||
72 | .. note:: | 72 | .. note:: |
73 | 73 | ||
74 | The project uses Buildbot for historical reasons but also because | 74 | The project uses Buildbot for historical reasons but also because |
75 | many of the project developers have knowledge of python. It is | 75 | many of the project developers have knowledge of Python. It is |
76 | possible to use the outer layers from another Continuous Integration | 76 | possible to use the outer layers from another Continuous Integration |
77 | (CI) system such as | 77 | (CI) system such as |
78 | `Jenkins <https://en.wikipedia.org/wiki/Jenkins_(software)>`__ | 78 | `Jenkins <https://en.wikipedia.org/wiki/Jenkins_(software)>`__ |
@@ -335,12 +335,12 @@ A simple test example from ``lib/bb/tests/data.py`` is:: | |||
335 | self.assertEqual(str(val), "value_of_foo") | 335 | self.assertEqual(str(val), "value_of_foo") |
336 | 336 | ||
337 | In this example, a ``DataExpansions`` class of tests is created, | 337 | In this example, a ``DataExpansions`` class of tests is created, |
338 | derived from standard python unittest. The class has a common ``setUp`` | 338 | derived from standard Python unittest. The class has a common ``setUp`` |
339 | function which is shared by all the tests in the class. A simple test is | 339 | function which is shared by all the tests in the class. A simple test is |
340 | then added to test that when a variable is expanded, the correct value | 340 | then added to test that when a variable is expanded, the correct value |
341 | is found. | 341 | is found. |
342 | 342 | ||
343 | Bitbake selftests are straightforward python unittest. Refer to the | 343 | BitBake selftests are straightforward Python unittest. Refer to the |
344 | Python unittest documentation for additional information on writing | 344 | Python unittest documentation for additional information on writing |
345 | these tests at: https://docs.python.org/3/library/unittest.html. | 345 | these tests at: https://docs.python.org/3/library/unittest.html. |
346 | 346 | ||
@@ -468,7 +468,7 @@ following:: | |||
468 | 468 | ||
469 | In this example, if nativesdk-python3-core has been installed into the SDK, the code runs | 469 | In this example, if nativesdk-python3-core has been installed into the SDK, the code runs |
470 | the python3 interpreter with a basic command to check it is working | 470 | the python3 interpreter with a basic command to check it is working |
471 | correctly. The test would only run if python3 is installed in the SDK. | 471 | correctly. The test would only run if Python3 is installed in the SDK. |
472 | 472 | ||
473 | ``oe-build-perf-test`` | 473 | ``oe-build-perf-test`` |
474 | ---------------------- | 474 | ---------------------- |
diff --git a/documentation/toaster-manual/start.rst b/documentation/toaster-manual/start.rst index cab5d1f673..2d6474852a 100644 --- a/documentation/toaster-manual/start.rst +++ b/documentation/toaster-manual/start.rst | |||
@@ -40,7 +40,7 @@ command:: | |||
40 | $ pip3 install --user -r bitbake/toaster-requirements.txt | 40 | $ pip3 install --user -r bitbake/toaster-requirements.txt |
41 | 41 | ||
42 | The previous command installs the necessary Toaster modules into a local | 42 | The previous command installs the necessary Toaster modules into a local |
43 | python 3 cache in your ``$HOME`` directory. The caches is actually | 43 | Python 3 cache in your ``$HOME`` directory. The caches is actually |
44 | located in ``$HOME/.local``. To see what packages have been installed | 44 | located in ``$HOME/.local``. To see what packages have been installed |
45 | into your ``$HOME`` directory, do the following:: | 45 | into your ``$HOME`` directory, do the following:: |
46 | 46 | ||
diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst index dec5617173..0b81fa8033 100644 --- a/documentation/what-i-wish-id-known.rst +++ b/documentation/what-i-wish-id-known.rst | |||
@@ -179,7 +179,7 @@ contact us with other suggestions. | |||
179 | * understand devtool and how it simplifies your workflow | 179 | * understand devtool and how it simplifies your workflow |
180 | * improve build speeds with shared downloads and shared state cache | 180 | * improve build speeds with shared downloads and shared state cache |
181 | * generate and understand a dependency graph | 181 | * generate and understand a dependency graph |
182 | * generate and understand bitbake environment | 182 | * generate and understand BitBake environment |
183 | * build an Extensible SDK for applications development | 183 | * build an Extensible SDK for applications development |
184 | 184 | ||
185 | #. **Depending on what you primary interests are with the Yocto Project, you | 185 | #. **Depending on what you primary interests are with the Yocto Project, you |