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/terms.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/terms.rst')
| -rw-r--r-- | documentation/ref-manual/terms.rst | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index ee14df5684..40209528ba 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst | |||
| @@ -64,31 +64,31 @@ universal, the list includes them just in case: | |||
| 64 | builds. The area is created when you ``source`` the setup environment | 64 | builds. The area is created when you ``source`` the setup environment |
| 65 | script that is found in the Source Directory | 65 | script that is found in the Source Directory |
| 66 | (i.e. :ref:`ref-manual/structure:\`\`oe-init-build-env\`\``). The | 66 | (i.e. :ref:`ref-manual/structure:\`\`oe-init-build-env\`\``). The |
| 67 | :term:`TOPDIR` variable points to the Build Directory. | 67 | :term:`TOPDIR` variable points to the :term:`Build Directory`. |
| 68 | 68 | ||
| 69 | You have a lot of flexibility when creating the Build Directory. | 69 | You have a lot of flexibility when creating the :term:`Build Directory`. |
| 70 | Following are some examples that show how to create the directory. The | 70 | Following are some examples that show how to create the directory. The |
| 71 | examples assume your :term:`Source Directory` is named ``poky``: | 71 | examples assume your :term:`Source Directory` is named ``poky``: |
| 72 | 72 | ||
| 73 | - Create the Build Directory inside your Source Directory and let | 73 | - Create the :term:`Build Directory` inside your Source Directory and let |
| 74 | the name of the Build Directory default to ``build``: | 74 | the name of the :term:`Build Directory` default to ``build``: |
| 75 | 75 | ||
| 76 | .. code-block:: shell | 76 | .. code-block:: shell |
| 77 | 77 | ||
| 78 | $ cd poky | 78 | $ cd poky |
| 79 | $ source oe-init-build-env | 79 | $ source oe-init-build-env |
| 80 | 80 | ||
| 81 | - Create the Build Directory inside your home directory and | 81 | - Create the :term:`Build Directory` inside your home directory and |
| 82 | specifically name it ``test-builds``: | 82 | specifically name it ``test-builds``: |
| 83 | 83 | ||
| 84 | .. code-block:: shell | 84 | .. code-block:: shell |
| 85 | 85 | ||
| 86 | $ source poky/oe-init-build-env test-builds | 86 | $ source poky/oe-init-build-env test-builds |
| 87 | 87 | ||
| 88 | - Provide a directory path and specifically name the Build | 88 | - Provide a directory path and specifically name the |
| 89 | Directory. Any intermediate folders in the pathname must exist. | 89 | :term:`Build Directory`. Any intermediate folders in the pathname |
| 90 | This next example creates a Build Directory named | 90 | must exist. This next example creates a :term:`Build Directory` |
| 91 | ``YP-&DISTRO;`` within the existing directory ``mybuilds``: | 91 | named ``YP-&DISTRO;`` within the existing directory ``mybuilds``: |
| 92 | 92 | ||
| 93 | .. code-block:: shell | 93 | .. code-block:: shell |
| 94 | 94 | ||
| @@ -96,13 +96,13 @@ universal, the list includes them just in case: | |||
| 96 | 96 | ||
| 97 | .. note:: | 97 | .. note:: |
| 98 | 98 | ||
| 99 | By default, the Build Directory contains :term:`TMPDIR`, which is a | 99 | By default, the :term:`Build Directory` contains :term:`TMPDIR`, which is a |
| 100 | temporary directory the build system uses for its work. :term:`TMPDIR` cannot | 100 | temporary directory the build system uses for its work. :term:`TMPDIR` cannot |
| 101 | be under NFS. Thus, by default, the Build Directory cannot be under | 101 | be under NFS. Thus, by default, the :term:`Build Directory` cannot be under |
| 102 | NFS. However, if you need the Build Directory to be under NFS, you can | 102 | NFS. However, if you need the :term:`Build Directory` to be under NFS, you can |
| 103 | set this up by setting :term:`TMPDIR` in your ``local.conf`` file to use a local | 103 | set this up by setting :term:`TMPDIR` in your ``local.conf`` file to use a local |
| 104 | drive. Doing so effectively separates :term:`TMPDIR` from :term:`TOPDIR`, which is the | 104 | drive. Doing so effectively separates :term:`TMPDIR` from :term:`TOPDIR`, which is the |
| 105 | Build Directory. | 105 | :term:`Build Directory`. |
| 106 | 106 | ||
| 107 | :term:`Build Host` | 107 | :term:`Build Host` |
| 108 | The system used to build images in a Yocto Project Development | 108 | The system used to build images in a Yocto Project Development |
