summaryrefslogtreecommitdiffstats
path: root/documentation/README
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/README
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/README')
-rw-r--r--documentation/README2
1 files changed, 1 insertions, 1 deletions
diff --git a/documentation/README b/documentation/README
index be03bb119a..15623ce6c1 100644
--- a/documentation/README
+++ b/documentation/README
@@ -222,7 +222,7 @@ For example, the following .rst content will produce the 'expected'
222content: 222content:
223 223
224 .. code-block:: 224 .. code-block::
225 $ mkdir ~/poky-&DISTRO; 225 $ mkdir poky-&DISTRO;
226 or 226 or
227 $ git clone &YOCTO_GIT_URL;/git/poky -b &DISTRO_NAME_NO_CAP; 227 $ git clone &YOCTO_GIT_URL;/git/poky -b &DISTRO_NAME_NO_CAP;
228 228