summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorQuentin Schulz <foss@0leil.net>2020-09-17 01:59:02 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:36 +0100
commit177aee09fec494e8827a03cc98ba989f4acd459d (patch)
tree8cd19e638c3e5ed11b17a17b7da9a98d54c2b898 /documentation
parent528cdb7cd55184422b0b5361a7b6ab81314c1ba2 (diff)
downloadpoky-177aee09fec494e8827a03cc98ba989f4acd459d.tar.gz
sphinx: fix a few typos or missing/too many words
(From yocto-docs rev: 744b74b3420ae475a566307e03e0b098986773e4) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst10
-rw-r--r--documentation/overview-manual/overview-manual-concepts.rst8
-rw-r--r--documentation/overview-manual/overview-manual-yp-intro.rst8
-rw-r--r--documentation/transitioning-to-a-custom-environment.rst4
-rw-r--r--documentation/what-i-wish-id-known.rst4
5 files changed, 16 insertions, 18 deletions
diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
index 9d8b502f8c..6eabf3b806 100644
--- a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
+++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
@@ -102,7 +102,7 @@ commands to clone the Poky repository.
102 remote: Counting 102 remote: Counting
103 objects: 432160, done. remote: Compressing objects: 100% 103 objects: 432160, done. remote: Compressing objects: 100%
104 (102056/102056), done. remote: Total 432160 (delta 323116), reused 104 (102056/102056), done. remote: Total 432160 (delta 323116), reused
105 432037 (delta 323000) Receiving objects: 100% (432160/432160), 153.81 MiB \| 8.54 MiB/s, done. 105 432037 (delta 323000) Receiving objects: 100% (432160/432160), 153.81 MiB | 8.54 MiB/s, done.
106 Resolving deltas: 100% (323116/323116), done. 106 Resolving deltas: 100% (323116/323116), done.
107 Checking connectivity... done. 107 Checking connectivity... done.
108 108
@@ -287,7 +287,7 @@ Follow these steps to add a hardware layer:
287 This example adds the 287 This example adds the
288 `meta-altera <https://github.com/kraj/meta-altera>`__ hardware layer. 288 `meta-altera <https://github.com/kraj/meta-altera>`__ hardware layer.
289 289
290#. **Clone the Layer** Use Git to make a local copy of the layer on your 290#. **Clone the Layer:** Use Git to make a local copy of the layer on your
291 machine. You can put the copy in the top level of the copy of the 291 machine. You can put the copy in the top level of the copy of the
292 Poky repository created earlier: 292 Poky repository created earlier:
293 293
@@ -299,7 +299,7 @@ Follow these steps to add a hardware layer:
299 remote: Counting objects: 25170, done. 299 remote: Counting objects: 25170, done.
300 remote: Compressing objects: 100% (350/350), done. 300 remote: Compressing objects: 100% (350/350), done.
301 remote: Total 25170 (delta 645), reused 719 (delta 538), pack-reused 24219 301 remote: Total 25170 (delta 645), reused 719 (delta 538), pack-reused 24219
302 Receiving objects: 100% (25170/25170), 41.02 MiB \| 1.64 MiB/s, done. 302 Receiving objects: 100% (25170/25170), 41.02 MiB | 1.64 MiB/s, done.
303 Resolving deltas: 100% (13385/13385), done. 303 Resolving deltas: 100% (13385/13385), done.
304 Checking connectivity... done. 304 Checking connectivity... done.
305 305
@@ -340,7 +340,7 @@ Follow these steps to add a hardware layer:
340 $ cd ~/poky/build 340 $ cd ~/poky/build
341 $ bitbake-layers add-layer ../meta-altera 341 $ bitbake-layers add-layer ../meta-altera
342 NOTE: Starting bitbake server... 342 NOTE: Starting bitbake server...
343 Parsing recipes: 100% \|##################################################################\| Time: 0:00:32 343 Parsing recipes: 100% |##################################################################| Time: 0:00:32
344 Parsing of 918 .bb files complete (0 cached, 918 parsed). 1401 targets, 344 Parsing of 918 .bb files complete (0 cached, 918 parsed). 1401 targets,
345 123 skipped, 0 masked, 0 errors. 345 123 skipped, 0 masked, 0 errors.
346 346
@@ -388,7 +388,7 @@ Where To Go Next
388================ 388================
389 389
390Now that you have experienced using the Yocto Project, you might be 390Now that you have experienced using the Yocto Project, you might be
391asking yourself "What now?" The Yocto Project has many sources of 391asking yourself "What now?". The Yocto Project has many sources of
392information including the website, wiki pages, and user manuals: 392information including the website, wiki pages, and user manuals:
393 393
394- **Website:** The :yocto_home:`Yocto Project Website <>` provides 394- **Website:** The :yocto_home:`Yocto Project Website <>` provides
diff --git a/documentation/overview-manual/overview-manual-concepts.rst b/documentation/overview-manual/overview-manual-concepts.rst
index 935c01805e..9bd02a7001 100644
--- a/documentation/overview-manual/overview-manual-concepts.rst
+++ b/documentation/overview-manual/overview-manual-concepts.rst
@@ -787,7 +787,7 @@ Build Directory's hierarchy:
787- :term:`PN`: The name of the recipe used 787- :term:`PN`: The name of the recipe used
788 to build the package. This variable can have multiple meanings. 788 to build the package. This variable can have multiple meanings.
789 However, when used in the context of input files, ``PN`` represents 789 However, when used in the context of input files, ``PN`` represents
790 the the name of the recipe. 790 the name of the recipe.
791 791
792- :term:`WORKDIR`: The location 792- :term:`WORKDIR`: The location
793 where the OpenEmbedded build system builds a recipe (i.e. does the 793 where the OpenEmbedded build system builds a recipe (i.e. does the
@@ -1125,8 +1125,7 @@ build system has created the final image output files.
1125.. note:: 1125.. note::
1126 1126
1127 The entire image generation process is run under 1127 The entire image generation process is run under
1128 Pseudo 1128 Pseudo. Running under Pseudo ensures that the files in the root filesystem
1129 . Running under Pseudo ensures that the files in the root filesystem
1130 have correct ownership. 1129 have correct ownership.
1131 1130
1132.. _sdk-generation-dev-environment: 1131.. _sdk-generation-dev-environment:
@@ -1736,8 +1735,7 @@ objective of making native or cross packages relocatable.
1736.. note:: 1735.. note::
1737 1736
1738 Both native and cross packages run on the 1737 Both native and cross packages run on the
1739 build host 1738 build host. However, cross packages generate output for the target
1740 . However, cross packages generate output for the target
1741 architecture. 1739 architecture.
1742 1740
1743The checksum therefore needs to exclude ``WORKDIR``. The simplistic 1741The checksum therefore needs to exclude ``WORKDIR``. The simplistic
diff --git a/documentation/overview-manual/overview-manual-yp-intro.rst b/documentation/overview-manual/overview-manual-yp-intro.rst
index c83290ed5f..dee9922eb1 100644
--- a/documentation/overview-manual/overview-manual-yp-intro.rst
+++ b/documentation/overview-manual/overview-manual-yp-intro.rst
@@ -134,7 +134,7 @@ Project:
134- *License Manifest:* The Yocto Project provides a :ref:`license 134- *License Manifest:* The Yocto Project provides a :ref:`license
135 manifest <dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle>` 135 manifest <dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle>`
136 for review by people who need to track the use of open source 136 for review by people who need to track the use of open source
137 licenses (e.g.legal teams). 137 licenses (e.g. legal teams).
138 138
139.. _gs-challenges: 139.. _gs-challenges:
140 140
@@ -540,7 +540,7 @@ targets:
540 You can find the Matchbox source in the Yocto Project 540 You can find the Matchbox source in the Yocto Project
541 :yocto_git:`Source Repositories <>`. 541 :yocto_git:`Source Repositories <>`.
542 542
543- *Opkg* Open PacKaGe management (opkg) is a lightweight package 543- *Opkg:* Open PacKaGe management (opkg) is a lightweight package
544 management system based on the itsy package (ipkg) management system. 544 management system based on the itsy package (ipkg) management system.
545 Opkg is written in C and resembles Advanced Package Tool (APT) and 545 Opkg is written in C and resembles Advanced Package Tool (APT) and
546 Debian Package (dpkg) in operation. 546 Debian Package (dpkg) in operation.
@@ -655,7 +655,7 @@ Project.
655 virtualization technology. 655 virtualization technology.
656 656
657 For information on how to set up a Build Host with WSLv2, see the 657 For information on how to set up a Build Host with WSLv2, see the
658 ":ref:dev-manual/dev-manual-start:setting up to use windows subsystem for linux (wslv2)`" 658 ":ref:`dev-manual/dev-manual-start:setting up to use windows subsystem for linux (wslv2)`"
659 section in the Yocto Project Development Tasks Manual. 659 section in the Yocto Project Development Tasks Manual.
660 660
661- *Toaster:* Regardless of what your Build Host is running, you can use 661- *Toaster:* Regardless of what your Build Host is running, you can use
@@ -743,7 +743,7 @@ and Fall. For more information on the Yocto Project release schedule and
743cadence, see the ":doc:`../ref-manual/ref-release-process`" chapter in the 743cadence, see the ":doc:`../ref-manual/ref-release-process`" chapter in the
744Yocto Project Reference Manual. 744Yocto Project Reference Manual.
745 745
746Much has been said about Poky being a "default configuration." A default 746Much has been said about Poky being a "default configuration". A default
747configuration provides a starting image footprint. You can use Poky out 747configuration provides a starting image footprint. You can use Poky out
748of the box to create an image ranging from a shell-accessible minimal 748of the box to create an image ranging from a shell-accessible minimal
749image all the way up to a Linux Standard Base-compliant image that uses 749image all the way up to a Linux Standard Base-compliant image that uses
diff --git a/documentation/transitioning-to-a-custom-environment.rst b/documentation/transitioning-to-a-custom-environment.rst
index 43a646d87e..8dfcda379a 100644
--- a/documentation/transitioning-to-a-custom-environment.rst
+++ b/documentation/transitioning-to-a-custom-environment.rst
@@ -11,7 +11,7 @@ Transitioning to a custom environment for systems development
11 So you've finished the :doc:`brief-yoctoprojectqs/brief-yoctoprojectqs` and 11 So you've finished the :doc:`brief-yoctoprojectqs/brief-yoctoprojectqs` and
12 glanced over the document :doc:`what-i-wish-id-known`, the latter contains 12 glanced over the document :doc:`what-i-wish-id-known`, the latter contains
13 important information learned from other users. You're well prepared. But 13 important information learned from other users. You're well prepared. But
14 now, as you are starting your own project, isn't exactly straightforward what 14 now, as you are starting your own project, it isn't exactly straightforward what
15 to do. And, the documentation is daunting. We've put together a few hints to 15 to do. And, the documentation is daunting. We've put together a few hints to
16 get you started. 16 get you started.
17 17
@@ -67,7 +67,7 @@ Transitioning to a custom environment for systems development
67 BSP, :ref:`create your own layer for the BSP <bsp-guide/bsp:creating a new 67 BSP, :ref:`create your own layer for the BSP <bsp-guide/bsp:creating a new
68 bsp layer using the \`\`bitbake-layers\`\` script>`. For example, given a 68 bsp layer using the \`\`bitbake-layers\`\` script>`. For example, given a
69 64-bit x86-based machine, copy the conf/intel-corei7-64 definition and give 69 64-bit x86-based machine, copy the conf/intel-corei7-64 definition and give
70 it a machine a relevant name (think board name, not product name). Make sure 70 the machine a relevant name (think board name, not product name). Make sure
71 the layer configuration is dependent on the meta-intel layer (or at least, 71 the layer configuration is dependent on the meta-intel layer (or at least,
72 meta-intel remains in your bblayers.conf). Now you can put your custom BSP 72 meta-intel remains in your bblayers.conf). Now you can put your custom BSP
73 settings into your layer and you can re-use it for different applications. 73 settings into your layer and you can re-use it for different applications.
diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst
index 67bf84e07f..1afc2eff97 100644
--- a/documentation/what-i-wish-id-known.rst
+++ b/documentation/what-i-wish-id-known.rst
@@ -85,7 +85,7 @@ contact us with other suggestions.
85 pinpoint where trouble is occurring and how the build is breaking. The 85 pinpoint where trouble is occurring and how the build is breaking. The
86 workflow breaks down into the following steps: 86 workflow breaks down into the following steps:
87 87
88 #. Fetch – get the sourcecode 88 #. Fetch – get the source code
89 #. Extract – unpack the sources 89 #. Extract – unpack the sources
90 #. Patch – apply patches for bug fixes and new capability 90 #. Patch – apply patches for bug fixes and new capability
91 #. Configure – set up your environment specifications 91 #. Configure – set up your environment specifications
@@ -105,7 +105,7 @@ contact us with other suggestions.
105 You can use the "-g" option with BitBake to generate this graph. When you 105 You can use the "-g" option with BitBake to generate this graph. When you
106 start a build and the build breaks, you could see packages you have no clue 106 start a build and the build breaks, you could see packages you have no clue
107 about or have any idea why the build system has included them. The 107 about or have any idea why the build system has included them. The
108 dependency graph can clarify that confustion. You can learn more about 108 dependency graph can clarify that confusion. You can learn more about
109 dependency graphs and how to generate them in the 109 dependency graphs and how to generate them in the
110 :ref:`bitbake-user-manual/bitbake-user-manual-intro:generating dependency 110 :ref:`bitbake-user-manual/bitbake-user-manual-intro:generating dependency
111 graphs` section in the BitBake User Manual. 111 graphs` section in the BitBake User Manual.