summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-03-30 11:05:46 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-04-06 22:29:49 +0100
commitaeb59935e91f02454cfe453d5bef77ac05e46542 (patch)
tree0354abf2df9ae979f78bc018a9c600efe06f0b2a
parent9df4fd6d39820ea4eb13ba6ee7477745001ef53c (diff)
downloadpoky-aeb59935e91f02454cfe453d5bef77ac05e46542.tar.gz
manuals: fix suspicious newlines
- That could originate from documentation migration issues - Checked that the corresponding links still exist (From yocto-docs rev: 38bae8f6067bc12f3617ed38587737d22dd7b32c) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/common-tasks.rst19
-rw-r--r--documentation/overview-manual/concepts.rst3
-rw-r--r--documentation/overview-manual/yp-intro.rst20
-rw-r--r--documentation/ref-manual/variables.rst4
-rw-r--r--documentation/sdk-manual/working-projects.rst9
5 files changed, 19 insertions, 36 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index e5a90e15df..3f35dc6361 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -2061,16 +2061,12 @@ sysroot are cataloged in manifests in order to ensure the files can be
2061removed later when a recipe is either modified or removed. Thus, the 2061removed later when a recipe is either modified or removed. Thus, the
2062sysroot is able to remain free from stale files. 2062sysroot is able to remain free from stale files.
2063 2063
2064A subset of the files installed by the 2064A subset of the files installed by the :ref:`ref-tasks-install` task are
2065:ref:`ref-tasks-install` task are 2065used by the :ref:`ref-tasks-populate_sysroot` task as defined by the the
2066used by the 2066:term:`SYSROOT_DIRS` variable to automatically populate the sysroot. It
2067:ref:`ref-tasks-populate_sysroot` 2067is possible to modify the list of directories that populate the sysroot.
2068task as defined by the 2068The following example shows how you could add the ``/opt`` directory to
2069:term:`SYSROOT_DIRS` variable to 2069the list of directories within a recipe:
2070automatically populate the sysroot. It is possible to modify the list of
2071directories that populate the sysroot. The following example shows how
2072you could add the ``/opt`` directory to the list of directories within a
2073recipe:
2074:: 2070::
2075 2071
2076 SYSROOT_DIRS += "/opt" 2072 SYSROOT_DIRS += "/opt"
@@ -2081,8 +2077,7 @@ recipe:
2081 that are not included in the target filesystem, allowing them to share 2077 that are not included in the target filesystem, allowing them to share
2082 these artifacts without needing to use the ``DEPLOY_DIR``. 2078 these artifacts without needing to use the ``DEPLOY_DIR``.
2083 2079
2084For a more complete description of the 2080For a more complete description of the :ref:`ref-tasks-populate_sysroot`
2085:ref:`ref-tasks-populate_sysroot`
2086task and its associated functions, see the 2081task and its associated functions, see the
2087:ref:`staging <ref-classes-staging>` class. 2082:ref:`staging <ref-classes-staging>` class.
2088 2083
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index 257de44ec8..f0c7dab4c8 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -2111,8 +2111,7 @@ accomplished using fakeroot.
2111 under fakeroot. Otherwise, the task cannot run root-only operations, 2111 under fakeroot. Otherwise, the task cannot run root-only operations,
2112 and cannot see the fake file ownership and permissions set by the 2112 and cannot see the fake file ownership and permissions set by the
2113 other task. You need to also add a dependency on 2113 other task. You need to also add a dependency on
2114 virtual/fakeroot-native:do_populate_sysroot 2114 ``virtual/fakeroot-native:do_populate_sysroot``, giving the following:
2115 , giving the following:
2116 :: 2115 ::
2117 2116
2118 fakeroot do_mytask () { 2117 fakeroot do_mytask () {
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
index b146db5e4d..b01b4e6a8f 100644
--- a/documentation/overview-manual/yp-intro.rst
+++ b/documentation/overview-manual/yp-intro.rst
@@ -262,8 +262,7 @@ with the string ``meta-``.
262.. note:: 262.. note::
263 263
264 It is not a requirement that a layer name begin with the prefix 264 It is not a requirement that a layer name begin with the prefix
265 meta- 265 ``meta-``, but it is a commonly accepted standard in the Yocto Project
266 , but it is a commonly accepted standard in the Yocto Project
267 community. 266 community.
268 267
269For example, if you were to examine the :yocto_git:`tree view </poky/tree/>` 268For example, if you were to examine the :yocto_git:`tree view </poky/tree/>`
@@ -283,8 +282,7 @@ The Yocto Project employs a collection of components and tools used by
283the project itself, by project developers, and by those using the Yocto 282the project itself, by project developers, and by those using the Yocto
284Project. These components and tools are open source projects and 283Project. These components and tools are open source projects and
285metadata that are separate from the reference distribution 284metadata that are separate from the reference distribution
286(:term:`Poky`) and the 285(:term:`Poky`) and the :term:`OpenEmbedded Build System`. Most of the
287:term:`OpenEmbedded Build System`. Most of the
288components and tools are downloaded separately. 286components and tools are downloaded separately.
289 287
290This section provides brief overviews of the components and tools 288This section provides brief overviews of the components and tools
@@ -655,14 +653,12 @@ Reference Embedded Distribution (Poky)
655 653
656"Poky", which is pronounced *Pock*-ee, is the name of the Yocto 654"Poky", which is pronounced *Pock*-ee, is the name of the Yocto
657Project's reference distribution or Reference OS Kit. Poky contains the 655Project's reference distribution or Reference OS Kit. Poky contains the
658:term:`OpenEmbedded Build System` 656:term:`OpenEmbedded Build System` (:term:`BitBake` and
659(:term:`BitBake` and 657:term:`OpenEmbedded-Core (OE-Core)`) as well as a set of
660:term:`OpenEmbedded-Core (OE-Core)`) as well as a set 658:term:`Metadata` to get you started building your own distro. In other
661of :term:`Metadata` to get you started 659words, Poky is a base specification of the functionality needed for a
662building your own distro. In other words, Poky is a base specification 660typical embedded system as well as the components from the Yocto Project
663of the functionality needed for a typical embedded system as well as the 661that allow you to build a distribution into a usable binary image.
664components from the Yocto Project that allow you to build a distribution
665into a usable binary image.
666 662
667Poky is a combined repository of BitBake, OpenEmbedded-Core (which is 663Poky is a combined repository of BitBake, OpenEmbedded-Core (which is
668found in ``meta``), ``meta-poky``, ``meta-yocto-bsp``, and documentation 664found in ``meta``), ``meta-poky``, ``meta-yocto-bsp``, and documentation
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 6a9fed0c68..19f5e34c58 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -768,9 +768,7 @@ system and gives an overview of their function and contents.
768 .. note:: 768 .. note::
769 769
770 If you run BitBake from a directory outside of the 770 If you run BitBake from a directory outside of the
771 Build Directory 771 :term:`Build Directory`, you must be sure to set ``BBPATH``
772 , you must be sure to set
773 BBPATH
774 to point to the Build Directory. Set the variable as you would any 772 to point to the Build Directory. Set the variable as you would any
775 environment variable and then run BitBake: 773 environment variable and then run BitBake:
776 :: 774 ::
diff --git a/documentation/sdk-manual/working-projects.rst b/documentation/sdk-manual/working-projects.rst
index bddf00a7dc..f880cbe0d5 100644
--- a/documentation/sdk-manual/working-projects.rst
+++ b/documentation/sdk-manual/working-projects.rst
@@ -104,10 +104,7 @@ project:
104 104
105 .. note:: 105 .. note::
106 106
107 If you get errors from 107 If you get errors from ``configure.ac``, which ``autoreconf``
108 configure.ac
109 , which
110 autoreconf
111 runs, that indicate missing files, you can use the "-i" option, 108 runs, that indicate missing files, you can use the "-i" option,
112 which ensures missing auxiliary files are copied to the build 109 which ensures missing auxiliary files are copied to the build
113 host. 110 host.
@@ -206,9 +203,7 @@ regarding variable behavior:
206.. note:: 203.. note::
207 204
208 Regardless of how you set your variables, if you use the "-e" option 205 Regardless of how you set your variables, if you use the "-e" option
209 with 206 with ``make``, the variables from the SDK setup script take precedence:
210 make
211 , the variables from the SDK setup script take precedence:
212 :: 207 ::
213 208
214 $ make -e target 209 $ make -e target