From a306baf850a826c89c83e4cfcd4629421c56f73f Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Mon, 22 Mar 2021 17:10:57 +0100 Subject: 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 Signed-off-by: Richard Purdie --- documentation/dev-manual/common-tasks.rst | 20 ++++++++++---------- documentation/dev-manual/qemu.rst | 4 ++-- documentation/dev-manual/start.rst | 2 +- 3 files changed, 13 insertions(+), 13 deletions(-) (limited to 'documentation/dev-manual') diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index b7b59c1727..820b8314d1 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -3007,7 +3007,7 @@ The following steps describe how to set up the AUH utility: running the AUH utility: :: - $ cd ~/poky + $ cd poky $ source oe-init-build-env your_AUH_build_directory Re-using an existing build directory and its configurations is not @@ -5956,8 +5956,8 @@ the existing kernel, and then inserts a new kernel: kernel: :: - $ wic cp ~/poky_sdk/tmp/work/qemux86-poky-linux/linux-yocto/4.12.12+git999-r0/linux-yocto-4.12.12+git999/arch/x86/boot/bzImage \ - ~/poky/build/tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic:1/vmlinuz + $ wic cp poky_sdk/tmp/work/qemux86-poky-linux/linux-yocto/4.12.12+git999-r0/linux-yocto-4.12.12+git999/arch/x86/boot/bzImage \ + poky/build/tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic:1/vmlinuz Once the new kernel is added back into the image, you can use the ``dd`` command or :ref:`bmaptool @@ -6956,7 +6956,7 @@ variable to specify the format: 1. Open the ``local.conf`` file inside your :term:`Build Directory` (e.g. - ``~/poky/build/conf/local.conf``). + ``poky/build/conf/local.conf``). 2. Select the desired package format as follows: :: @@ -7048,11 +7048,11 @@ From within the build directory where you have built an image based on your packaging choice (i.e. the :term:`PACKAGE_CLASSES` setting), simply start the server. The following example assumes a build -directory of ``~/poky/build/tmp/deploy/rpm`` and a ``PACKAGE_CLASSES`` +directory of ``poky/build/tmp/deploy/rpm`` and a ``PACKAGE_CLASSES`` setting of "package_rpm": :: - $ cd ~/poky/build/tmp/deploy/rpm + $ cd poky/build/tmp/deploy/rpm $ python3 -m http.server Target Setup @@ -8409,7 +8409,7 @@ that queries the Git repository and prints just the differences that might be significant in human-readable form. Here is an example: :: - $ ~/poky/poky/scripts/buildhistory-diff . HEAD^ + $ poky/poky/scripts/buildhistory-diff . HEAD^ Changes to images/qemux86_64/glibc/core-image-minimal (files-in-image.txt): /etc/anotherpkg.conf was added /sbin/anotherpkg was added @@ -10738,7 +10738,7 @@ been followed: are ``create-pull-request`` and ``send-pull-request``. You can find these scripts in the ``scripts`` directory within the :term:`Source Directory` (e.g. - ``~/poky/scripts``). + ``poky/scripts``). Using these scripts correctly formats the requests without introducing any whitespace or HTML formatting. The maintainer that @@ -10752,7 +10752,7 @@ been followed: line in the created patch files: :: - $ ~/poky/scripts/create-pull-request -u meta-intel-contrib -s "Updated Manual Section Reference in README" + $ poky/scripts/create-pull-request -u meta-intel-contrib -s "Updated Manual Section Reference in README" Running this script forms ``*.patch`` files in a folder named ``pull-``\ `PID` in the current directory. One of the patch files is a @@ -10766,7 +10766,7 @@ been followed: list: :: - $ ~/poky/scripts/send-pull-request -p ~/meta-intel/pull-10565 -t meta-intel@yoctoproject.org + $ poky/scripts/send-pull-request -p ~/meta-intel/pull-10565 -t meta-intel@yoctoproject.org You need to follow the prompts as the script is interactive. diff --git a/documentation/dev-manual/qemu.rst b/documentation/dev-manual/qemu.rst index 766691b97b..c6bb9e9776 100644 --- a/documentation/dev-manual/qemu.rst +++ b/documentation/dev-manual/qemu.rst @@ -58,7 +58,7 @@ available. Follow these general steps to run QEMU: environment script (i.e. :ref:`structure-core-script`): :: - $ cd ~/poky + $ cd poky $ source oe-init-build-env - If you installed a cross-toolchain, you can run the script that @@ -66,7 +66,7 @@ available. Follow these general steps to run QEMU: the initialization script from the default ``poky_sdk`` directory: :: - . ~/poky_sdk/environment-setup-core2-64-poky-linux + . poky_sdk/environment-setup-core2-64-poky-linux 3. *Ensure the Artifacts are in Place:* You need to be sure you have a pre-built kernel that will boot in QEMU. You also need the target diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 03061a79f3..efe369c751 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst @@ -768,7 +768,7 @@ Follow these steps to create a local version of the upstream exists on your system and by default, it is checked out: :: - $ cd ~/poky + $ cd poky $ git status On branch master Your branch is up-to-date with 'origin/master'. -- cgit v1.2.3-54-g00ecf