diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2021-03-22 17:10:57 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-03-23 22:54:55 +0000 |
commit | a306baf850a826c89c83e4cfcd4629421c56f73f (patch) | |
tree | e7163f3899e27b005a7a510c80450f38d13e4d7b /documentation/ref-manual | |
parent | 5de939f61c3d753fa7170e6e71ed31e1fe328d9a (diff) | |
download | poky-a306baf850a826c89c83e4cfcd4629421c56f73f.tar.gz |
Do not assume working from $HOME
In the "Yocto Project Quick Build" instructions
(https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html#)
there is an inconsistency that impacts several documents...
People are first instructed to clone the poky git repository, but not
mentioning from which directory. Then, it's consistent to instruct
people to run "cd poky/".
However, later in the instructions, readers are instructed to run "cd
~/poky", which assumes that cloning poky was done from the home
directory. Many other places in the documentation make such an assumption.
This change fixes this, and makes no assumption on where people
have chosen to store their data, in particular where they cloned
the "poky" repository.
This also fixes a few whitespace issues.
(From yocto-docs rev: fd4e365c85df212d7ed70fc1abb3657a4a88b294)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r-- | documentation/ref-manual/terms.rst | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index bf46148876..32bb75b271 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst | |||
@@ -28,7 +28,7 @@ universal, the list includes them just in case: | |||
28 | to allow for matching recipe names. For example, suppose you have an | 28 | to allow for matching recipe names. For example, suppose you have an |
29 | append file named as follows: | 29 | append file named as follows: |
30 | :: | 30 | :: |
31 | 31 | ||
32 | busybox_1.21.%.bbappend | 32 | busybox_1.21.%.bbappend |
33 | 33 | ||
34 | That append file | 34 | That append file |
@@ -76,7 +76,7 @@ universal, the list includes them just in case: | |||
76 | 76 | ||
77 | .. code-block:: shell | 77 | .. code-block:: shell |
78 | 78 | ||
79 | $ cd $HOME/poky | 79 | $ cd poky |
80 | $ source oe-init-build-env | 80 | $ source oe-init-build-env |
81 | 81 | ||
82 | - Create the Build Directory inside your home directory and | 82 | - Create the Build Directory inside your home directory and |
@@ -84,19 +84,16 @@ universal, the list includes them just in case: | |||
84 | 84 | ||
85 | .. code-block:: shell | 85 | .. code-block:: shell |
86 | 86 | ||
87 | $ cd $HOME | ||
88 | $ source poky/oe-init-build-env test-builds | 87 | $ source poky/oe-init-build-env test-builds |
89 | 88 | ||
90 | - Provide a directory path and specifically name the Build | 89 | - Provide a directory path and specifically name the Build |
91 | Directory. Any intermediate folders in the pathname must exist. | 90 | Directory. Any intermediate folders in the pathname must exist. |
92 | This next example creates a Build Directory named | 91 | This next example creates a Build Directory named |
93 | ``YP-&POKYVERSION;`` in your home directory within the existing | 92 | ``YP-&POKYVERSION;`` within the existing directory ``mybuilds``: |
94 | directory ``mybuilds``: | ||
95 | 93 | ||
96 | .. code-block:: shell | 94 | .. code-block:: shell |
97 | 95 | ||
98 | $ cd $HOME | 96 | $ source poky/oe-init-build-env mybuilds/YP-&POKYVERSION; |
99 | $ source $HOME/poky/oe-init-build-env $HOME/mybuilds/YP-&POKYVERSION; | ||
100 | 97 | ||
101 | .. note:: | 98 | .. note:: |
102 | 99 | ||