summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/structure.rst
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-10-27 15:09:08 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-10-28 15:48:03 +0100
commitb44fbe5b1b425b8a8c23e4f0ba80583944ab303a (patch)
tree5e1787b385f95ffaf7fa2cf5507ff2a91ef39d07 /documentation/ref-manual/structure.rst
parent50458d923826ae96deaf799fa7ee1e0584cb57ff (diff)
downloadpoky-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.rst33
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
57This directory contains user configuration files and the output 57This directory contains user configuration files and the output
58generated by the OpenEmbedded build system in its standard configuration 58generated by the OpenEmbedded build system in its standard configuration
59where the source tree is combined with the output. The :term:`Build Directory` 59where the source tree is combined with the output. The :term:`Build Directory`
60is created initially when you ``source`` 60is created initially when you ``source`` the OpenEmbedded build environment
61the OpenEmbedded build environment setup script (i.e. 61setup script (i.e. :ref:`structure-core-script`).
62:ref:`structure-core-script`).
63 62
64It is also possible to place output and configuration files in a 63It is also possible to place output and configuration files in a
65directory separate from the :term:`Source Directory` by 64directory separate from the :term:`Source Directory` by
@@ -153,10 +152,10 @@ BitBake commands. The script uses other scripts within the ``scripts``
153directory to do the bulk of the work. 152directory to do the bulk of the work.
154 153
155When you run this script, your Yocto Project environment is set up, a 154When 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
157directory becomes the Build Directory, and you are presented with some 156:term:`Build Directory`, and you are presented with some simple
158simple suggestions as to what to do next, including a list of some 157suggestions as to what to do next, including a list of some possible
159possible targets to build. Here is an example:: 158targets 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
182section in the Yocto Project Development Tasks Manual for more 181section in the Yocto Project Development Tasks Manual for more
183information. 182information.
184 183
185By default, running this script without a Build Directory argument 184By default, running this script without a :term:`Build Directory` argument
186creates the ``build/`` directory in your current working directory. If 185creates the ``build/`` directory in your current working directory. If
187you provide a Build Directory argument when you ``source`` the script, 186you provide a :term:`Build Directory` argument when you ``source`` the script,
188you direct the OpenEmbedded build system to create a Build Directory of 187you direct the OpenEmbedded build system to create a :term:`Build Directory` of
189your choice. For example, the following command creates a Build 188your choice. For example, the following command creates a
190Directory 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.
219The Build Directory --- ``build/`` 219The Build Directory --- ``build/``
220================================== 220==================================
221 221
222The OpenEmbedded build system creates the :term:`Build Directory` 222The OpenEmbedded build system creates the :term:`Build Directory` when you run
223when you run the build environment setup 223the build environment setup script :ref:`structure-core-script`. If you do not
224script :ref:`structure-core-script`. If you do not give the Build 224give the :term:`Build Directory` a specific name when you run the setup script,
225Directory a specific name when you run the setup script, the name 225the name defaults to ``build/``.
226defaults to ``build/``.
227 226
228For subsequent parsing and processing, the name of the Build directory 227For subsequent parsing and processing, the name of the Build directory
229is available via the :term:`TOPDIR` variable. 228is available via the :term:`TOPDIR` variable.