diff options
Diffstat (limited to 'documentation/dev-manual/start.rst')
-rw-r--r-- | documentation/dev-manual/start.rst | 33 |
1 files changed, 22 insertions, 11 deletions
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 8539bc0889..44bd2de137 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst | |||
@@ -109,7 +109,7 @@ particular working environment and set of practices. | |||
109 | 109 | ||
110 | - Keep your cross-development toolchains updated. You can do this | 110 | - Keep your cross-development toolchains updated. You can do this |
111 | through provisioning either as new toolchain downloads or as | 111 | through provisioning either as new toolchain downloads or as |
112 | updates through a package update mechanism using ``opkg`` to | 112 | updates through a package update mechanism to |
113 | provide updates to an existing toolchain. The exact mechanics of | 113 | provide updates to an existing toolchain. The exact mechanics of |
114 | how and when to do this depend on local policy. | 114 | how and when to do this depend on local policy. |
115 | 115 | ||
@@ -159,7 +159,7 @@ particular working environment and set of practices. | |||
159 | are made. | 159 | are made. |
160 | 160 | ||
161 | - Allows triggering of automated image booting and testing under | 161 | - Allows triggering of automated image booting and testing under |
162 | the QuickEMUlator (QEMU). | 162 | the Quick EMUlator (QEMU). |
163 | 163 | ||
164 | - Supports incremental build testing and from-scratch builds. | 164 | - Supports incremental build testing and from-scratch builds. |
165 | 165 | ||
@@ -234,7 +234,7 @@ particular working environment and set of practices. | |||
234 | - The Yocto Project community encourages you to send patches to the | 234 | - The Yocto Project community encourages you to send patches to the |
235 | project to fix bugs or add features. If you do submit patches, | 235 | project to fix bugs or add features. If you do submit patches, |
236 | follow the project commit guidelines for writing good commit | 236 | follow the project commit guidelines for writing good commit |
237 | messages. See the ":doc:`../contributor-guide/submit-changes`" | 237 | messages. See the ":doc:`/contributor-guide/submit-changes`" |
238 | section in the Yocto Project and OpenEmbedded Contributor Guide. | 238 | section in the Yocto Project and OpenEmbedded Contributor Guide. |
239 | 239 | ||
240 | - Send changes to the core sooner than later as others are likely | 240 | - Send changes to the core sooner than later as others are likely |
@@ -310,7 +310,7 @@ Project Build Host: | |||
310 | 310 | ||
311 | - GNU make &MIN_MAKE_VERSION; or greater | 311 | - GNU make &MIN_MAKE_VERSION; or greater |
312 | 312 | ||
313 | If your build host does not meet any of these listed version | 313 | If your build host does not satisfy all of these listed version |
314 | requirements, you can take steps to prepare the system so that you | 314 | requirements, you can take steps to prepare the system so that you |
315 | can still use the Yocto Project. See the | 315 | can still use the Yocto Project. See the |
316 | ":ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions`" | 316 | ":ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions`" |
@@ -568,7 +568,7 @@ extension accordingly. | |||
568 | Locating Yocto Project Source Files | 568 | Locating Yocto Project Source Files |
569 | =================================== | 569 | =================================== |
570 | 570 | ||
571 | This section shows you how to locate, fetch and configure the source | 571 | This section shows you how to locate, fetch, unpack, patch and configure the source |
572 | files you'll need to work with the Yocto Project. | 572 | files you'll need to work with the Yocto Project. |
573 | 573 | ||
574 | .. note:: | 574 | .. note:: |
@@ -615,11 +615,11 @@ Accessing Source Archives | |||
615 | The Yocto Project also provides source archives of its releases, which | 615 | The Yocto Project also provides source archives of its releases, which |
616 | are available on :yocto_dl:`/releases/yocto/`. Then, choose the subdirectory | 616 | are available on :yocto_dl:`/releases/yocto/`. Then, choose the subdirectory |
617 | containing the release you wish to use, for example | 617 | containing the release you wish to use, for example |
618 | :yocto_dl:`yocto-&DISTRO; </releases/yocto/yocto-&DISTRO;/>`. | 618 | :yocto_dl:`&DISTRO_REL_LATEST_TAG; </releases/yocto/&DISTRO_REL_LATEST_TAG;/>`. |
619 | 619 | ||
620 | You will find there source archives of individual components (if you wish | 620 | You will find there source archives of individual components (if you wish |
621 | to use them individually), and of the corresponding Poky release bundling | 621 | to use them individually), and of the corresponding Poky release bundling |
622 | a selection of these components. | 622 | a selection of these components. |
623 | 623 | ||
624 | .. note:: | 624 | .. note:: |
625 | 625 | ||
@@ -720,11 +720,11 @@ Follow these steps to create a local version of the upstream | |||
720 | $ git branch | 720 | $ git branch |
721 | * master | 721 | * master |
722 | 722 | ||
723 | Your local repository of poky is identical to the | 723 | Your local repository of poky is initially identical to the |
724 | upstream poky repository at the time from which it was cloned. As you | 724 | upstream poky repository from which it was cloned. As you |
725 | work with the local branch, you can periodically use the | 725 | work with the local branch, you can periodically use the |
726 | ``git pull --rebase`` command to be sure you are up-to-date | 726 | ``git pull`` command to be sure you stay up-to-date |
727 | with the upstream branch. | 727 | with the upstream poky branch. |
728 | 728 | ||
729 | Checking Out by Branch in Poky | 729 | Checking Out by Branch in Poky |
730 | ------------------------------ | 730 | ------------------------------ |
@@ -853,3 +853,14 @@ similar to checking out by branch name except you use tag names. | |||
853 | ``checkout`` command are a snapshot of the "&DISTRO_NAME_NO_CAP;" | 853 | ``checkout`` command are a snapshot of the "&DISTRO_NAME_NO_CAP;" |
854 | development branch at the point where Yocto Project &DISTRO; was | 854 | development branch at the point where Yocto Project &DISTRO; was |
855 | released. | 855 | released. |
856 | |||
857 | Initializing the Build Environment | ||
858 | ================================== | ||
859 | |||
860 | Before you can use Yocto you need to setup the build environment. | ||
861 | From within the ``poky`` directory, source the :ref:`ref-manual/structure:``oe-init-build-env``` environment | ||
862 | setup script to define Yocto Project's build environment on your build host:: | ||
863 | |||
864 | $ source oe-init-build-env | ||
865 | |||
866 | Note, that this step will have to be repeated every time you open a new shell. | ||