summaryrefslogtreecommitdiffstats
path: root/documentation/sdk-manual
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-03-22 17:10:57 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-03-23 22:54:55 +0000
commita306baf850a826c89c83e4cfcd4629421c56f73f (patch)
treee7163f3899e27b005a7a510c80450f38d13e4d7b /documentation/sdk-manual
parent5de939f61c3d753fa7170e6e71ed31e1fe328d9a (diff)
downloadpoky-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/sdk-manual')
-rw-r--r--documentation/sdk-manual/appendix-obtain.rst4
-rw-r--r--documentation/sdk-manual/extensible.rst2
2 files changed, 3 insertions, 3 deletions
diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst
index f158c244ab..395102c3bd 100644
--- a/documentation/sdk-manual/appendix-obtain.rst
+++ b/documentation/sdk-manual/appendix-obtain.rst
@@ -173,7 +173,7 @@ build the SDK installer. Follow these steps:
173 ``tmp/deploy/sdk`` in the Build Directory. Following is an example: 173 ``tmp/deploy/sdk`` in the Build Directory. Following is an example:
174 :: 174 ::
175 175
176 $ cd ~/poky/build/tmp/deploy/sdk 176 $ cd poky/build/tmp/deploy/sdk
177 $ ./poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh 177 $ ./poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh
178 178
179 During execution of the script, you choose the root location for the 179 During execution of the script, you choose the root location for the
@@ -249,7 +249,7 @@ Follow these steps to extract the root filesystem:
249 ":ref:`sdk-manual/appendix-obtain:locating pre-built sdk installers`" section: 249 ":ref:`sdk-manual/appendix-obtain:locating pre-built sdk installers`" section:
250 :: 250 ::
251 251
252 $ source ~/poky_sdk/environment-setup-core2-64-poky-linux 252 $ source poky_sdk/environment-setup-core2-64-poky-linux
253 253
2543. *Extract the Root Filesystem:* Use the ``runqemu-extract-sdk`` 2543. *Extract the Root Filesystem:* Use the ``runqemu-extract-sdk``
255 command and provide the root filesystem image. 255 command and provide the root filesystem image.
diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst
index 5962e9460a..d2ed9a9b83 100644
--- a/documentation/sdk-manual/extensible.rst
+++ b/documentation/sdk-manual/extensible.rst
@@ -118,7 +118,7 @@ architecture. The example assumes the SDK installer is located in
118 $ ./Downloads/poky-glibc-x86_64-core-image-minimal-core2-64-toolchain-ext-2.5.sh 118 $ ./Downloads/poky-glibc-x86_64-core-image-minimal-core2-64-toolchain-ext-2.5.sh
119 Poky (Yocto Project Reference Distro) Extensible SDK installer version 2.5 119 Poky (Yocto Project Reference Distro) Extensible SDK installer version 2.5
120 ========================================================================== 120 ==========================================================================
121 Enter target directory for SDK (default: ~/poky_sdk): 121 Enter target directory for SDK (default: poky_sdk):
122 You are about to install the SDK to "/home/scottrif/poky_sdk". Proceed [Y/n]? Y 122 You are about to install the SDK to "/home/scottrif/poky_sdk". Proceed [Y/n]? Y
123 Extracting SDK..............done 123 Extracting SDK..............done
124 Setting it up... 124 Setting it up...