diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-10-27 15:09:08 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-10-28 15:48:03 +0100 |
commit | b44fbe5b1b425b8a8c23e4f0ba80583944ab303a (patch) | |
tree | 5e1787b385f95ffaf7fa2cf5507ff2a91ef39d07 /documentation/ref-manual/structure.rst | |
parent | 50458d923826ae96deaf799fa7ee1e0584cb57ff (diff) | |
download | poky-b44fbe5b1b425b8a8c23e4f0ba80583944ab303a.tar.gz |
manuals: use references to the "Build Directory" term
Replace instances of "Build Directory" and "build directory"
(when applicable) by :term:`Build Directory` as already
done in most places.
Doing this, fix the indentation of the paragraphs with
this term.
(From yocto-docs rev: dce50679242d39f133e0cde5c8483b5e69f3eb54)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/structure.rst')
-rw-r--r-- | documentation/ref-manual/structure.rst | 33 |
1 files changed, 16 insertions, 17 deletions
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index fe27d17caa..8b08f88969 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
@@ -57,9 +57,8 @@ For more information on BitBake, see the :doc:`BitBake User Manual | |||
57 | This directory contains user configuration files and the output | 57 | This directory contains user configuration files and the output |
58 | generated by the OpenEmbedded build system in its standard configuration | 58 | generated by the OpenEmbedded build system in its standard configuration |
59 | where the source tree is combined with the output. The :term:`Build Directory` | 59 | where the source tree is combined with the output. The :term:`Build Directory` |
60 | is created initially when you ``source`` | 60 | is created initially when you ``source`` the OpenEmbedded build environment |
61 | the OpenEmbedded build environment setup script (i.e. | 61 | setup script (i.e. :ref:`structure-core-script`). |
62 | :ref:`structure-core-script`). | ||
63 | 62 | ||
64 | It is also possible to place output and configuration files in a | 63 | It is also possible to place output and configuration files in a |
65 | directory separate from the :term:`Source Directory` by | 64 | directory separate from the :term:`Source Directory` by |
@@ -153,10 +152,10 @@ BitBake commands. The script uses other scripts within the ``scripts`` | |||
153 | directory to do the bulk of the work. | 152 | directory to do the bulk of the work. |
154 | 153 | ||
155 | When you run this script, your Yocto Project environment is set up, a | 154 | When you run this script, your Yocto Project environment is set up, a |
156 | :term:`Build Directory` is created, your working | 155 | :term:`Build Directory` is created, your working directory becomes the |
157 | directory becomes the Build Directory, and you are presented with some | 156 | :term:`Build Directory`, and you are presented with some simple |
158 | simple suggestions as to what to do next, including a list of some | 157 | suggestions as to what to do next, including a list of some possible |
159 | possible targets to build. Here is an example:: | 158 | targets to build. Here is an example:: |
160 | 159 | ||
161 | $ source oe-init-build-env | 160 | $ source oe-init-build-env |
162 | 161 | ||
@@ -182,12 +181,13 @@ See the | |||
182 | section in the Yocto Project Development Tasks Manual for more | 181 | section in the Yocto Project Development Tasks Manual for more |
183 | information. | 182 | information. |
184 | 183 | ||
185 | By default, running this script without a Build Directory argument | 184 | By default, running this script without a :term:`Build Directory` argument |
186 | creates the ``build/`` directory in your current working directory. If | 185 | creates the ``build/`` directory in your current working directory. If |
187 | you provide a Build Directory argument when you ``source`` the script, | 186 | you provide a :term:`Build Directory` argument when you ``source`` the script, |
188 | you direct the OpenEmbedded build system to create a Build Directory of | 187 | you direct the OpenEmbedded build system to create a :term:`Build Directory` of |
189 | your choice. For example, the following command creates a Build | 188 | your choice. For example, the following command creates a |
190 | Directory named ``mybuilds/`` that is outside of the :term:`Source Directory`:: | 189 | :term:`Build Directory` named ``mybuilds/`` that is outside of the |
190 | :term:`Source Directory`:: | ||
191 | 191 | ||
192 | $ source oe-init-build-env ~/mybuilds | 192 | $ source oe-init-build-env ~/mybuilds |
193 | 193 | ||
@@ -219,11 +219,10 @@ These files are standard top-level files. | |||
219 | The Build Directory --- ``build/`` | 219 | The Build Directory --- ``build/`` |
220 | ================================== | 220 | ================================== |
221 | 221 | ||
222 | The OpenEmbedded build system creates the :term:`Build Directory` | 222 | The OpenEmbedded build system creates the :term:`Build Directory` when you run |
223 | when you run the build environment setup | 223 | the build environment setup script :ref:`structure-core-script`. If you do not |
224 | script :ref:`structure-core-script`. If you do not give the Build | 224 | give the :term:`Build Directory` a specific name when you run the setup script, |
225 | Directory a specific name when you run the setup script, the name | 225 | the name defaults to ``build/``. |
226 | defaults to ``build/``. | ||
227 | 226 | ||
228 | For subsequent parsing and processing, the name of the Build directory | 227 | For subsequent parsing and processing, the name of the Build directory |
229 | is available via the :term:`TOPDIR` variable. | 228 | is available via the :term:`TOPDIR` variable. |