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/dev-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/dev-manual')
-rw-r--r-- | documentation/dev-manual/common-tasks.rst | 20 | ||||
-rw-r--r-- | documentation/dev-manual/qemu.rst | 4 | ||||
-rw-r--r-- | documentation/dev-manual/start.rst | 2 |
3 files changed, 13 insertions, 13 deletions
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: | |||
3007 | running the AUH utility: | 3007 | running the AUH utility: |
3008 | :: | 3008 | :: |
3009 | 3009 | ||
3010 | $ cd ~/poky | 3010 | $ cd poky |
3011 | $ source oe-init-build-env your_AUH_build_directory | 3011 | $ source oe-init-build-env your_AUH_build_directory |
3012 | 3012 | ||
3013 | Re-using an existing build directory and its configurations is not | 3013 | Re-using an existing build directory and its configurations is not |
@@ -5956,8 +5956,8 @@ the existing kernel, and then inserts a new kernel: | |||
5956 | kernel: | 5956 | kernel: |
5957 | :: | 5957 | :: |
5958 | 5958 | ||
5959 | $ 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 \ | 5959 | $ 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 \ |
5960 | ~/poky/build/tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic:1/vmlinuz | 5960 | poky/build/tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic:1/vmlinuz |
5961 | 5961 | ||
5962 | Once the new kernel is added back into the image, you can use the | 5962 | Once the new kernel is added back into the image, you can use the |
5963 | ``dd`` command or :ref:`bmaptool | 5963 | ``dd`` command or :ref:`bmaptool |
@@ -6956,7 +6956,7 @@ variable to specify the format: | |||
6956 | 6956 | ||
6957 | 1. Open the ``local.conf`` file inside your | 6957 | 1. Open the ``local.conf`` file inside your |
6958 | :term:`Build Directory` (e.g. | 6958 | :term:`Build Directory` (e.g. |
6959 | ``~/poky/build/conf/local.conf``). | 6959 | ``poky/build/conf/local.conf``). |
6960 | 6960 | ||
6961 | 2. Select the desired package format as follows: | 6961 | 2. Select the desired package format as follows: |
6962 | :: | 6962 | :: |
@@ -7048,11 +7048,11 @@ From within the build directory where you have built an image based on | |||
7048 | your packaging choice (i.e. the | 7048 | your packaging choice (i.e. the |
7049 | :term:`PACKAGE_CLASSES` | 7049 | :term:`PACKAGE_CLASSES` |
7050 | setting), simply start the server. The following example assumes a build | 7050 | setting), simply start the server. The following example assumes a build |
7051 | directory of ``~/poky/build/tmp/deploy/rpm`` and a ``PACKAGE_CLASSES`` | 7051 | directory of ``poky/build/tmp/deploy/rpm`` and a ``PACKAGE_CLASSES`` |
7052 | setting of "package_rpm": | 7052 | setting of "package_rpm": |
7053 | :: | 7053 | :: |
7054 | 7054 | ||
7055 | $ cd ~/poky/build/tmp/deploy/rpm | 7055 | $ cd poky/build/tmp/deploy/rpm |
7056 | $ python3 -m http.server | 7056 | $ python3 -m http.server |
7057 | 7057 | ||
7058 | Target Setup | 7058 | Target Setup |
@@ -8409,7 +8409,7 @@ that queries the Git repository and prints just the differences that | |||
8409 | might be significant in human-readable form. Here is an example: | 8409 | might be significant in human-readable form. Here is an example: |
8410 | :: | 8410 | :: |
8411 | 8411 | ||
8412 | $ ~/poky/poky/scripts/buildhistory-diff . HEAD^ | 8412 | $ poky/poky/scripts/buildhistory-diff . HEAD^ |
8413 | Changes to images/qemux86_64/glibc/core-image-minimal (files-in-image.txt): | 8413 | Changes to images/qemux86_64/glibc/core-image-minimal (files-in-image.txt): |
8414 | /etc/anotherpkg.conf was added | 8414 | /etc/anotherpkg.conf was added |
8415 | /sbin/anotherpkg was added | 8415 | /sbin/anotherpkg was added |
@@ -10738,7 +10738,7 @@ been followed: | |||
10738 | are ``create-pull-request`` and ``send-pull-request``. You can find | 10738 | are ``create-pull-request`` and ``send-pull-request``. You can find |
10739 | these scripts in the ``scripts`` directory within the | 10739 | these scripts in the ``scripts`` directory within the |
10740 | :term:`Source Directory` (e.g. | 10740 | :term:`Source Directory` (e.g. |
10741 | ``~/poky/scripts``). | 10741 | ``poky/scripts``). |
10742 | 10742 | ||
10743 | Using these scripts correctly formats the requests without | 10743 | Using these scripts correctly formats the requests without |
10744 | introducing any whitespace or HTML formatting. The maintainer that | 10744 | introducing any whitespace or HTML formatting. The maintainer that |
@@ -10752,7 +10752,7 @@ been followed: | |||
10752 | line in the created patch files: | 10752 | line in the created patch files: |
10753 | :: | 10753 | :: |
10754 | 10754 | ||
10755 | $ ~/poky/scripts/create-pull-request -u meta-intel-contrib -s "Updated Manual Section Reference in README" | 10755 | $ poky/scripts/create-pull-request -u meta-intel-contrib -s "Updated Manual Section Reference in README" |
10756 | 10756 | ||
10757 | Running this script forms ``*.patch`` files in a folder named | 10757 | Running this script forms ``*.patch`` files in a folder named |
10758 | ``pull-``\ `PID` in the current directory. One of the patch files is a | 10758 | ``pull-``\ `PID` in the current directory. One of the patch files is a |
@@ -10766,7 +10766,7 @@ been followed: | |||
10766 | list: | 10766 | list: |
10767 | :: | 10767 | :: |
10768 | 10768 | ||
10769 | $ ~/poky/scripts/send-pull-request -p ~/meta-intel/pull-10565 -t meta-intel@yoctoproject.org | 10769 | $ poky/scripts/send-pull-request -p ~/meta-intel/pull-10565 -t meta-intel@yoctoproject.org |
10770 | 10770 | ||
10771 | You need to follow the prompts as the script is interactive. | 10771 | You need to follow the prompts as the script is interactive. |
10772 | 10772 | ||
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: | |||
58 | environment script (i.e. :ref:`structure-core-script`): | 58 | environment script (i.e. :ref:`structure-core-script`): |
59 | :: | 59 | :: |
60 | 60 | ||
61 | $ cd ~/poky | 61 | $ cd poky |
62 | $ source oe-init-build-env | 62 | $ source oe-init-build-env |
63 | 63 | ||
64 | - If you installed a cross-toolchain, you can run the script that | 64 | - If you installed a cross-toolchain, you can run the script that |
@@ -66,7 +66,7 @@ available. Follow these general steps to run QEMU: | |||
66 | the initialization script from the default ``poky_sdk`` directory: | 66 | the initialization script from the default ``poky_sdk`` directory: |
67 | :: | 67 | :: |
68 | 68 | ||
69 | . ~/poky_sdk/environment-setup-core2-64-poky-linux | 69 | . poky_sdk/environment-setup-core2-64-poky-linux |
70 | 70 | ||
71 | 3. *Ensure the Artifacts are in Place:* You need to be sure you have a | 71 | 3. *Ensure the Artifacts are in Place:* You need to be sure you have a |
72 | pre-built kernel that will boot in QEMU. You also need the target | 72 | 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 | |||
768 | exists on your system and by default, it is checked out: | 768 | exists on your system and by default, it is checked out: |
769 | :: | 769 | :: |
770 | 770 | ||
771 | $ cd ~/poky | 771 | $ cd poky |
772 | $ git status | 772 | $ git status |
773 | On branch master | 773 | On branch master |
774 | Your branch is up-to-date with 'origin/master'. | 774 | Your branch is up-to-date with 'origin/master'. |