diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-07-02 09:59:11 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-07-03 14:55:02 +0100 |
| commit | 85673e5466804f6918be72b3b27328783b5ac5c9 (patch) | |
| tree | 27bbb4622ad024268b1a5980eb2d842fb6e4739d /documentation/dev-manual/dev-manual-start.xml | |
| parent | 7606c30c1915bfa192e5b0d125dc6b6e5e7f1857 (diff) | |
| download | poky-85673e5466804f6918be72b3b27328783b5ac5c9.tar.gz | |
documentation/dev-manual: Scrub for Yocto Project term
I have replaced the term "Yocto Project" with more appropriate terms
where possible.
(From yocto-docs rev: 622ef9a2b4897ecd151b641b43d7706ab673c989)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/dev-manual-start.xml')
| -rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 72 |
1 files changed, 33 insertions, 39 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 4dc2cfca00..15748ebfac 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
| @@ -24,14 +24,15 @@ | |||
| 24 | 24 | ||
| 25 | <para> | 25 | <para> |
| 26 | The Yocto Project is an open-source collaboration project focused on embedded Linux development. | 26 | The Yocto Project is an open-source collaboration project focused on embedded Linux development. |
| 27 | The project currently provides a build system, which is sometimes referred to as "Poky", | 27 | The project currently provides a build system, which is |
| 28 | and provides various ancillary tools suitable for the embedded developer. | 28 | referred to as the OpenEmbedded build system in the Yocto Project documentation. |
| 29 | The Yocto Project also features the Sato reference User Interface, which is optimized for | 29 | The Yocto Project provides various ancillary tools suitable for the embedded developer |
| 30 | and also features the Sato reference User Interface, which is optimized for | ||
| 30 | stylus driven, low-resolution screens. | 31 | stylus driven, low-resolution screens. |
| 31 | </para> | 32 | </para> |
| 32 | 33 | ||
| 33 | <para> | 34 | <para> |
| 34 | You can use the Yocto Project build system, which uses | 35 | You can use the OpenEmbedded build system, which uses |
| 35 | <ulink url='http://bitbake.berlios.de/manual/'>BitBake</ulink>, to develop complete Linux | 36 | <ulink url='http://bitbake.berlios.de/manual/'>BitBake</ulink>, to develop complete Linux |
| 36 | images and associated user-space applications for architectures based on ARM, MIPS, PowerPC, | 37 | images and associated user-space applications for architectures based on ARM, MIPS, PowerPC, |
| 37 | x86 and x86-64. | 38 | x86 and x86-64. |
| @@ -53,56 +54,50 @@ | |||
| 53 | <listitem><para><emphasis>Host System:</emphasis> You should have a reasonably current | 54 | <listitem><para><emphasis>Host System:</emphasis> You should have a reasonably current |
| 54 | Linux-based host system. | 55 | Linux-based host system. |
| 55 | You will have the best results with a recent release of Fedora, | 56 | You will have the best results with a recent release of Fedora, |
| 56 | OpenSUSE, or Ubuntu as these releases are frequently tested against the Yocto Project | 57 | OpenSUSE, Ubuntu, or CentOS as these releases are frequently tested against the Yocto Project |
| 57 | and officially supported. | 58 | and officially supported. |
| 58 | You should also have about 100 gigabytes of free disk space for building images. | 59 | You should also have about 100 gigabytes of free disk space for building images. |
| 59 | </para></listitem> | 60 | </para></listitem> |
| 60 | <listitem><para><emphasis>Packages:</emphasis> The Yocto Project requires certain packages | 61 | <listitem><para><emphasis>Packages:</emphasis> The OpenEmbedded build system |
| 61 | exist on your development system (e.g. Python 2.6 or 2.7). | 62 | requires certain packages exist on your development system (e.g. Python 2.6 or 2.7). |
| 62 | See "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" | 63 | See "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" |
| 63 | section in the Yocto Project Quick Start for the exact package | 64 | section in the Yocto Project Quick Start for the exact package |
| 64 | requirements and the installation commands to install them | 65 | requirements and the installation commands to install them |
| 65 | for the supported distributions.</para></listitem> | 66 | for the supported distributions.</para></listitem> |
| 66 | <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis> | 67 | <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis> |
| 67 | You need a release of the Yocto Project. | 68 | You need a release of the Yocto Project. |
| 68 | You can get set up with local | 69 | You set up a with local <link linkend='source-directory'>source directory</link> |
| 69 | <link linkend='yocto-project-files'>Yocto Project Files</link> one of two ways | 70 | one of two ways depending on whether you |
| 70 | depending on whether you | 71 | are going to contribute back into the Yocto Project or not. |
| 71 | are going to be contributing back into the Yocto Project source repository or not. | ||
| 72 | <note> | 72 | <note> |
| 73 | Regardless of the method you use, this manual refers to the resulting | 73 | Regardless of the method you use, this manual refers to the resulting local |
| 74 | hierarchical set of files as the "Yocto Project Files" or the "Yocto Project File | 74 | hierarchical set of files as the "source directory." |
| 75 | Structure." | ||
| 76 | </note> | 75 | </note> |
| 77 | <itemizedlist> | 76 | <itemizedlist> |
| 78 | <listitem><para><emphasis>Tarball Extraction:</emphasis> If you are not going to contribute | 77 | <listitem><para><emphasis>Tarball Extraction:</emphasis> If you are not going to contribute |
| 79 | back into the Yocto Project, you can simply download the Yocto Project release you want | 78 | back into the Yocto Project, you can simply download a Yocto Project release you want |
| 80 | from the website’s <ulink url='&YOCTO_HOME_URL;/download'>download page</ulink>. | 79 | from the website’s <ulink url='&YOCTO_HOME_URL;/download'>download page</ulink>. |
| 81 | Once you have the tarball, just extract it into a directory of your choice.</para> | 80 | Once you have the tarball, just extract it into a directory of your choice.</para> |
| 82 | <para>For example, the following command extracts the Yocto Project &DISTRO; | 81 | <para>For example, the following command extracts the Yocto Project &DISTRO; |
| 83 | release tarball | 82 | release tarball |
| 84 | into the current working directory and sets up the Yocto Project file structure | 83 | into the current working directory and sets up the local source directory |
| 85 | with a top-level directory named <filename>&YOCTO_POKY;</filename>: | 84 | with a top-level folder named <filename>&YOCTO_POKY;</filename>: |
| 86 | <literallayout class='monospaced'> | 85 | <literallayout class='monospaced'> |
| 87 | $ tar xfj &YOCTO_POKY_TARBALL; | 86 | $ tar xfj &YOCTO_POKY_TARBALL; |
| 88 | </literallayout></para> | 87 | </literallayout></para> |
| 89 | <para>This method does not produce a Git repository. | 88 | <para>This method does not produce a local Git repository. |
| 90 | Instead, you simply end up with a local snapshot of the | 89 | Instead, you simply end up with a snapshot of the release.</para></listitem> |
| 91 | Yocto Project files that are based on the particular release in the | ||
| 92 | tarball.</para></listitem> | ||
| 93 | <listitem><para><emphasis>Git Repository Method:</emphasis> If you are going to be contributing | 90 | <listitem><para><emphasis>Git Repository Method:</emphasis> If you are going to be contributing |
| 94 | back into the Yocto Project or you simply want to keep up | 91 | back into the Yocto Project or you simply want to keep up |
| 95 | with the latest developments, you should use Git commands to set up a local | 92 | with the latest developments, you should use Git commands to set up a local |
| 96 | Git repository of the Yocto Project Files. | 93 | Git repository of the upstream <filename>poky</filename> source repository. |
| 97 | Doing so creates a Git repository with a complete history of changes and allows | 94 | Doing so creates a repository with a complete history of changes and allows |
| 98 | you to easily submit your changes upstream to the project. | 95 | you to easily submit your changes upstream to the project. |
| 99 | Because you cloned the repository, you have access to all the Yocto Project development | 96 | Because you cloned the repository, you have access to all the Yocto Project development |
| 100 | branches and tag names used in the upstream repository.</para> | 97 | branches and tag names used in the upstream repository.</para> |
| 101 | <para>The following transcript shows how to clone the Yocto Project Files' | 98 | <para>The following transcript shows how to clone the <filename>poky</filename> |
| 102 | Git repository into the current working directory. | 99 | Git repository into the current working directory. |
| 103 | <note>The name of the Yocto Project Files Git repository in the Yocto Project Files | 100 | <note>You can view the Yocto Project Source Repositories at |
| 104 | Source Repositories is <filename>poky</filename>. | ||
| 105 | You can view the Yocto Project Source Repositories at | ||
| 106 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink></note> | 101 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink></note> |
| 107 | The command creates the local repository in a directory named <filename>poky</filename>. | 102 | The command creates the local repository in a directory named <filename>poky</filename>. |
| 108 | For information on Git used within the Yocto Project, see the | 103 | For information on Git used within the Yocto Project, see the |
| @@ -131,7 +126,7 @@ | |||
| 131 | copying that cloned repository. | 126 | copying that cloned repository. |
| 132 | You can create the bare clone and the copy of the bare clone anywhere you like. | 127 | You can create the bare clone and the copy of the bare clone anywhere you like. |
| 133 | For simplicity, it is recommended that you create these structures outside of the | 128 | For simplicity, it is recommended that you create these structures outside of the |
| 134 | Yocto Project Files Git repository.</para> | 129 | source directory (usually <filename>poky</filename>).</para> |
| 135 | <para>As an example, the following transcript shows how to create the bare clone | 130 | <para>As an example, the following transcript shows how to create the bare clone |
| 136 | of the <filename>linux-yocto-3.2</filename> kernel and then create a copy of | 131 | of the <filename>linux-yocto-3.2</filename> kernel and then create a copy of |
| 137 | that clone. | 132 | that clone. |
| @@ -166,15 +161,14 @@ | |||
| 166 | edit to point to your locally modified kernel source files and to build the kernel | 161 | edit to point to your locally modified kernel source files and to build the kernel |
| 167 | image. | 162 | image. |
| 168 | Pointing to these local files is much more efficient than requiring a download of the | 163 | Pointing to these local files is much more efficient than requiring a download of the |
| 169 | source files from upstream each time you make changes to the kernel.</para> | 164 | kernel's source files from upstream each time you make changes to the kernel.</para> |
| 170 | <para>You can find the <filename>poky-extras</filename> Git Repository in the | 165 | <para>You can find the <filename>poky-extras</filename> Git Repository in the |
| 171 | "Yocto Metadata Layers" area of the Yocto Project Source Repositories at | 166 | "Yocto Metadata Layers" area of the Yocto Project Source Repositories at |
| 172 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>. | 167 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>. |
| 173 | It is good practice to create this Git repository inside the Yocto Project | 168 | It is good practice to create this Git repository inside the source directory.</para> |
| 174 | files Git repository.</para> | ||
| 175 | <para>Following is an example that creates the <filename>poky-extras</filename> Git | 169 | <para>Following is an example that creates the <filename>poky-extras</filename> Git |
| 176 | repository inside the Yocto Project files Git repository, which is named | 170 | repository inside the source directory, which is named <filename>poky</filename> |
| 177 | <filename>poky</filename> in this case: | 171 | in this case: |
| 178 | <literallayout class='monospaced'> | 172 | <literallayout class='monospaced'> |
| 179 | $ git clone git://git.yoctoproject.org/poky-extras poky-extras | 173 | $ git clone git://git.yoctoproject.org/poky-extras poky-extras |
| 180 | Initialized empty Git repository in /home/scottrif/poky/poky-extras/.git/ | 174 | Initialized empty Git repository in /home/scottrif/poky/poky-extras/.git/ |
| @@ -194,7 +188,7 @@ | |||
| 194 | layer. | 188 | layer. |
| 195 | You can get set up for BSP development one of two ways: tarball extraction or | 189 | You can get set up for BSP development one of two ways: tarball extraction or |
| 196 | with a local Git repository. | 190 | with a local Git repository. |
| 197 | It is a good idea to use the same method used to set up the Yocto Project Files. | 191 | It is a good idea to use the same method that you used to set up the source directory. |
| 198 | Regardless of the method you use, the Yocto Project uses the following BSP layer | 192 | Regardless of the method you use, the Yocto Project uses the following BSP layer |
| 199 | naming scheme: | 193 | naming scheme: |
| 200 | <literallayout class='monospaced'> | 194 | <literallayout class='monospaced'> |
| @@ -220,16 +214,16 @@ | |||
| 220 | Again, this method just produces a snapshot of the BSP layer in the form | 214 | Again, this method just produces a snapshot of the BSP layer in the form |
| 221 | of a hierarchical directory structure.</para></listitem> | 215 | of a hierarchical directory structure.</para></listitem> |
| 222 | <listitem><para><emphasis>Git Repository Method:</emphasis> If you are working | 216 | <listitem><para><emphasis>Git Repository Method:</emphasis> If you are working |
| 223 | with a Yocto Project Files Git repository, you should also use this method | 217 | with a local Git repository for your source directory, you should also use this method |
| 224 | to set up the <filename>meta-intel</filename> Git repository. | 218 | to set up the <filename>meta-intel</filename> Git repository. |
| 225 | You can locate the <filename>meta-intel</filename> Git repository in the | 219 | You can locate the <filename>meta-intel</filename> Git repository in the |
| 226 | "Yocto Metadata Layers" area of the Yocto Project Source Repositories at | 220 | "Yocto Metadata Layers" area of the Yocto Project Source Repositories at |
| 227 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> | 221 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> |
| 228 | <para>Typically, you set up the <filename>meta-intel</filename> Git repository inside | 222 | <para>Typically, you set up the <filename>meta-intel</filename> Git repository inside |
| 229 | the Yocto Project Files Git repository. | 223 | the source directory. |
| 230 | For example, the following transcript shows the steps to clone the | 224 | For example, the following transcript shows the steps to clone the |
| 231 | <filename>meta-intel</filename> | 225 | <filename>meta-intel</filename> |
| 232 | Git repository inside the <filename>poky</filename> Git repository. | 226 | Git repository inside the local <filename>poky</filename> Git repository. |
| 233 | <literallayout class='monospaced'> | 227 | <literallayout class='monospaced'> |
| 234 | $ git clone git://git.yoctoproject.org/meta-intel.git | 228 | $ git clone git://git.yoctoproject.org/meta-intel.git |
| 235 | Initialized empty Git repository in /home/scottrif/poky/meta-intel/.git/ | 229 | Initialized empty Git repository in /home/scottrif/poky/meta-intel/.git/ |
| @@ -268,13 +262,13 @@ | |||
| 268 | <para> | 262 | <para> |
| 269 | The build process is as follows: | 263 | The build process is as follows: |
| 270 | <orderedlist> | 264 | <orderedlist> |
| 271 | <listitem><para>Make sure you have the Yocto Project files as described in the | 265 | <listitem><para>Make sure you have set up the source directory described in the |
| 272 | previous section.</para></listitem> | 266 | previous section.</para></listitem> |
| 273 | <listitem><para>Initialize the build environment by sourcing a build environment | 267 | <listitem><para>Initialize the build environment by sourcing a build environment |
| 274 | script.</para></listitem> | 268 | script.</para></listitem> |
| 275 | <listitem><para>Optionally ensure the <filename>conf/local.conf</filename> configuration file, | 269 | <listitem><para>Optionally ensure the <filename>conf/local.conf</filename> configuration file, |
| 276 | which is found in the | 270 | which is found in the |
| 277 | <link linkend='yocto-project-build-directory'>Yocto Project Build Directory</link>, | 271 | <link linkend='build-directory'>build directory</link>, |
| 278 | is set up how you want it. | 272 | is set up how you want it. |
| 279 | This file defines many aspects of the build environment including | 273 | This file defines many aspects of the build environment including |
| 280 | the target machine architecture through the | 274 | the target machine architecture through the |
