diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index 7ae0ddc349..a7b7703a8f 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst @@ -184,16 +184,14 @@ an entire Linux distribution, including the toolchain, from source. ":yocto_wiki:`Working Behind a Network Proxy `" page of the Yocto Project Wiki. -#. **Initialize the Build Environment:** From within the ``poky`` - directory, run the :ref:`ref-manual/structure:\`\`oe-init-build-env\`\`` - environment - setup script to define Yocto Project's build environment on your +#. **Initialize the Build Environment:** From within the parent directory of + the ``poky`` directory, run the :ref:`ref-manual/structure:\`\`oe-init-build-env\`\`` + environment setup script to define Yocto Project's build environment on your build host. .. code-block:: shell - $ cd poky - $ source oe-init-build-env + $ source poky/oe-init-build-env You had no conf/local.conf file. This configuration file has therefore been created for you with some default values. You may wish to edit it to, for example, select a different MACHINE (target hardware). See conf/local.conf @@ -361,7 +359,7 @@ Follow these steps to add a hardware layer: .. code-block:: shell - $ cd poky/build + $ cd build $ bitbake-layers add-layer ../meta-altera NOTE: Starting bitbake server... Parsing recipes: 100% |##################################################################| Time: 0:00:32 diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 7e17b42886..42c0baf2e7 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst @@ -228,13 +228,13 @@ section. Resolving deltas: 100% (2447/2447), done. Checking connectivity... done. -#. *Initialize the Build Environment:* While in the root directory of - the Source Directory (i.e. ``poky``), run the +#. *Initialize the Build Environment:* Outside of the the Source Directory + (i.e. ``poky``), for example in the parent directory, run the :ref:`ref-manual/structure:\`\`oe-init-build-env\`\`` environment setup script to define the OpenEmbedded build environment on your build host. :: - $ source oe-init-build-env + $ source poky/oe-init-build-env Among other things, the script creates the :term:`Build Directory`, which is ``build`` in this case and is located in the :term:`Source Directory`. After diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 0d4e814f66..fbfd6a6a18 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -3022,8 +3022,7 @@ The following steps describe how to set up the AUH utility: script to create a fresh build directory that you use exclusively for running the AUH utility:: - $ cd poky - $ source oe-init-build-env your_AUH_build_directory + $ source poky/oe-init-build-env your_AUH_build_directory Re-using an existing build directory and its configurations is not recommended as existing settings could cause AUH to fail or behave @@ -3667,7 +3666,7 @@ The following figure and list overviews the build process: by sourcing the build environment script (i.e. :ref:`structure-core-script`):: - $ source oe-init-build-env [build_dir] + $ source poky/oe-init-build-env [build_dir] When you use the initialization script, the OpenEmbedded build system uses ``build`` as the default :term:`Build Directory` in your current work diff --git a/documentation/dev-manual/qemu.rst b/documentation/dev-manual/qemu.rst index 9f4bc264a3..a57a290c52 100644 --- a/documentation/dev-manual/qemu.rst +++ b/documentation/dev-manual/qemu.rst @@ -57,8 +57,7 @@ available. Follow these general steps to run QEMU: unpacked a Yocto Project release tarball, you can source the build environment script (i.e. :ref:`structure-core-script`):: - $ cd poky - $ source oe-init-build-env + $ source poky/oe-init-build-env - If you installed a cross-toolchain, you can run the script that initializes the toolchain. For example, the following commands run diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst index 0a1819ceae..be0d4291d5 100644 --- a/documentation/kernel-dev/common.rst +++ b/documentation/kernel-dev/common.rst @@ -56,8 +56,7 @@ section: you need to initialize the BitBake build environment by sourcing the build environment script (i.e. :ref:`structure-core-script`):: - $ cd poky - $ source oe-init-build-env + $ source poky/oe-init-build-env .. note:: @@ -177,7 +176,8 @@ section: $ git branch master * &DISTRO_NAME_NO_CAP; - $ source oe-init-build-env + $ cd .. + $ source poky/oe-init-build-env .. note:: @@ -1074,8 +1074,8 @@ The following commands initialize the BitBake environment, run the task, and launch ``menuconfig``. These commands assume the Source Directory's top-level folder is ``poky``:: - $ cd poky - $ source oe-init-build-env + $ cd poky/.. + $ source poky/oe-init-build-env $ bitbake linux-yocto -c kernel_configme -f $ bitbake linux-yocto -c menuconfig diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst index 49f8af4a74..60b9ecdb66 100644 --- a/documentation/profile-manual/usage.rst +++ b/documentation/profile-manual/usage.rst @@ -1907,8 +1907,8 @@ Running a Script on a Target Once you've done that, you should be able to run a systemtap script on the target:: - $ cd /path/to/yocto - $ source oe-init-build-env + $ cd /path/to/poky/.. + $ source poky/oe-init-build-env ### Shell environment set up for builds. ### diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index fe27d17caa..4440ac4f3d 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst @@ -158,7 +158,7 @@ directory becomes the Build Directory, and you are presented with some simple suggestions as to what to do next, including a list of some possible targets to build. Here is an example:: - $ source oe-init-build-env + $ source poky/oe-init-build-env ### Shell environment set up for builds. ### @@ -189,7 +189,7 @@ you direct the OpenEmbedded build system to create a Build Directory of your choice. For example, the following command creates a Build Directory named ``mybuilds/`` that is outside of the :term:`Source Directory`:: - $ source oe-init-build-env ~/mybuilds + $ source poky/oe-init-build-env ~/mybuilds The OpenEmbedded build system uses the template configuration files, which are found by default in the ``meta-poky/conf/templates/default`` directory in the Source diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index 1e3f718a8f..6af2eb6385 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst @@ -70,14 +70,6 @@ universal, the list includes them just in case: Following are some examples that show how to create the directory. The examples assume your :term:`Source Directory` is named ``poky``: - - Create the Build Directory inside your Source Directory and let - the name of the Build Directory default to ``build``: - - .. code-block:: shell - - $ cd poky - $ source oe-init-build-env - - Create the Build Directory inside your home directory and specifically name it ``test-builds``: diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst index 7a09a83af8..5568d3cc34 100644 --- a/documentation/sdk-manual/appendix-obtain.rst +++ b/documentation/sdk-manual/appendix-obtain.rst @@ -107,14 +107,14 @@ build the SDK installer. Follow these steps: how to clone the ``poky`` repository and check out the appropriate branch for your work. -3. *Initialize the Build Environment:* While in the root directory of +3. *Initialize the Build Environment:* While in the parent directory of the Source Directory (i.e. ``poky``), run the :ref:`structure-core-script` environment setup script to define the OpenEmbedded build environment on your build host. :: - $ source oe-init-build-env + $ source poky/oe-init-build-env Among other things, the script creates the :term:`Build Directory`, diff --git a/documentation/toaster-manual/setup-and-use.rst b/documentation/toaster-manual/setup-and-use.rst index 72a15b5f2d..14fc23ce4d 100644 --- a/documentation/toaster-manual/setup-and-use.rst +++ b/documentation/toaster-manual/setup-and-use.rst @@ -14,14 +14,14 @@ dependencies as described in the ":ref:`toaster-manual/start:Preparing to Use Toaster`" chapter, you are ready to start Toaster. -Navigate to the root of your +Navigate to the parent directory of the root of your :term:`Source Directory` (e.g. ``poky``):: - $ cd poky + $ cd poky/.. Once in that directory, source the build environment script:: - $ source oe-init-build-env + $ source poky/oe-init-build-env Next, from the build directory (e.g. ``poky/build``), start Toaster using this command:: @@ -437,9 +437,9 @@ Perform the following steps to install Toaster: #export http_proxy=http://proxy.host.com:8080 #export https_proxy=http://proxy.host.com:8080 #export GIT_PROXY_COMMAND=$HOME/bin/gitproxy - cd poky/ - source ./oe-init-build-env build - source ../bitbake/bin/toaster $1 noweb + cd poky/.. + source poky/oe-init-build-env build + source ../poky/bitbake/bin/toaster $1 noweb [ "$1" == 'start' ] && /bin/bash #. Run the service::