diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-03-17 08:45:10 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-03-25 12:29:41 +0000 |
commit | 90dfac064fab79cc902d611a07432f6411b84095 (patch) | |
tree | 6752c833f8b3bdc5370de3fa52e7e6d6c62a1f59 /documentation/dev-manual | |
parent | 2e56389e56bfe3174a43d7195c4e0c3925885885 (diff) | |
download | poky-90dfac064fab79cc902d611a07432f6411b84095.tar.gz |
dev-manual: General edits to the getting started chapter.
Did a read-through of this chapter in preparation for the YP
1.6 release. Found several little areas that needed attention.
(From yocto-docs rev: 73d56a4c948c675afd4cde0e3321a944a02013cf)
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')
-rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 59 |
1 files changed, 33 insertions, 26 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 997ae035cd..05cb8fc9d9 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
@@ -81,14 +81,15 @@ | |||
81 | them for the supported distributions. | 81 | them for the supported distributions. |
82 | </para></listitem> | 82 | </para></listitem> |
83 | <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis> | 83 | <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis> |
84 | You need a release of the Yocto Project installed locally on | 84 | You need a release of the Yocto Project locally installed on |
85 | your development system. | 85 | your development system. |
86 | This local area is referred to as the | 86 | The documentation refers to this set of locally installed files |
87 | <link linkend='source-directory'>Source Directory</link> | 87 | as the <link linkend='source-directory'>Source Directory</link>. |
88 | and is created when you use | 88 | You create your Source Directory by using |
89 | <link linkend='git'>Git</link> to clone a local copy | 89 | <link linkend='git'>Git</link> to clone a local copy |
90 | of the upstream <filename>poky</filename> repository, | 90 | of the upstream <filename>poky</filename> repository, |
91 | or when you download an official release of the corresponding tarball.</para> | 91 | or by downloading and unpacking a tarball of an official |
92 | Yocto Project release.</para> | ||
92 | <para>Working from a copy of the upstream repository allows you | 93 | <para>Working from a copy of the upstream repository allows you |
93 | to contribute back into the Yocto Project or simply work with | 94 | to contribute back into the Yocto Project or simply work with |
94 | the latest software on a development branch. | 95 | the latest software on a development branch. |
@@ -110,18 +111,19 @@ | |||
110 | <literallayout class='monospaced'> | 111 | <literallayout class='monospaced'> |
111 | $ git clone git://git.yoctoproject.org/poky | 112 | $ git clone git://git.yoctoproject.org/poky |
112 | Cloning into 'poky'... | 113 | Cloning into 'poky'... |
113 | remote: Counting objects: 203728, done. | 114 | remote: Counting objects: 226790, done. |
114 | remote: Compressing objects: 100% (52371/52371), done. | 115 | remote: Compressing objects: 100% (57465/57465), done. |
115 | remote: Total 203728 (delta 147444), reused 202891 (delta 146614) | 116 | remote: Total 226790 (delta 165212), reused 225887 (delta 164327) |
116 | Receiving objects: 100% (203728/203728), 95.54 MiB | 308 KiB/s, done. | 117 | Receiving objects: 100% (226790/226790), 100.98 MiB | 263 KiB/s, done. |
117 | Resolving deltas: 100% (147444/147444), done. | 118 | Resolving deltas: 100% (165212/165212), done. |
118 | </literallayout></para> | 119 | </literallayout></para> |
119 | <para>For another example of how to set up your own local Git | 120 | <para>For another example of how to set up your own local Git |
120 | repositories, see this | 121 | repositories, see this |
121 | <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> | 122 | <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> |
122 | wiki page</ulink>, which describes how to create both | 123 | wiki page</ulink>, which describes how to create local |
123 | <filename>poky</filename> and <filename>meta-intel</filename> | 124 | Git repositories for both |
124 | Git repositories.</para></listitem> | 125 | <filename>poky</filename> and <filename>meta-intel</filename>. |
126 | </para></listitem> | ||
125 | <listitem id='local-kernel-files'><para><emphasis>Yocto Project Kernel:</emphasis> | 127 | <listitem id='local-kernel-files'><para><emphasis>Yocto Project Kernel:</emphasis> |
126 | If you are going to be making modifications to a supported Yocto Project kernel, you | 128 | If you are going to be making modifications to a supported Yocto Project kernel, you |
127 | need to establish local copies of the source. | 129 | need to establish local copies of the source. |
@@ -132,7 +134,7 @@ | |||
132 | copying that cloned repository. | 134 | copying that cloned repository. |
133 | You can create the bare clone and the copy of the bare clone anywhere you like. | 135 | You can create the bare clone and the copy of the bare clone anywhere you like. |
134 | For simplicity, it is recommended that you create these structures outside of the | 136 | For simplicity, it is recommended that you create these structures outside of the |
135 | Source Directory (usually <filename>poky</filename>).</para> | 137 | Source Directory, which is usually named <filename>poky</filename>.</para> |
136 | <para>As an example, the following transcript shows how to create the bare clone | 138 | <para>As an example, the following transcript shows how to create the bare clone |
137 | of the <filename>linux-yocto-3.10</filename> kernel and then create a copy of | 139 | of the <filename>linux-yocto-3.10</filename> kernel and then create a copy of |
138 | that clone. | 140 | that clone. |
@@ -182,7 +184,7 @@ | |||
182 | remote: Counting objects: 727, done. | 184 | remote: Counting objects: 727, done. |
183 | remote: Compressing objects: 100% (452/452), done. | 185 | remote: Compressing objects: 100% (452/452), done. |
184 | remote: Total 727 (delta 260), reused 719 (delta 252) | 186 | remote: Total 727 (delta 260), reused 719 (delta 252) |
185 | Receiving objects: 100% (727/727), 536.36 KiB | 102 KiB/s, done. | 187 | Receiving objects: 100% (727/727), 536.36 KiB | 240 KiB/s, done. |
186 | Resolving deltas: 100% (260/260), done. | 188 | Resolving deltas: 100% (260/260), done. |
187 | </literallayout></para></listitem> | 189 | </literallayout></para></listitem> |
188 | <listitem><para id='supported-board-support-packages-(bsps)'><emphasis>Supported Board | 190 | <listitem><para id='supported-board-support-packages-(bsps)'><emphasis>Supported Board |
@@ -227,11 +229,11 @@ | |||
227 | $ cd ~/poky | 229 | $ cd ~/poky |
228 | $ git clone git://git.yoctoproject.org/meta-intel.git | 230 | $ git clone git://git.yoctoproject.org/meta-intel.git |
229 | Cloning into 'meta-intel'... | 231 | Cloning into 'meta-intel'... |
230 | remote: Counting objects: 7366, done. | 232 | remote: Counting objects: 8844, done. |
231 | remote: Compressing objects: 100% (2491/2491), done. | 233 | remote: Compressing objects: 100% (2864/2864), done. |
232 | remote: Total 7366 (delta 3997), reused 7299 (delta 3930) | 234 | remote: Total 8844 (delta 4931), reused 8780 (delta 4867) |
233 | Receiving objects: 100% (7366/7366), 2.31 MiB | 95 KiB/s, done. | 235 | Receiving objects: 100% (8844/8844), 2.48 MiB | 264 KiB/s, done. |
234 | Resolving deltas: 100% (3997/3997), done. | 236 | Resolving deltas: 100% (4931/4931), done. |
235 | </literallayout></para> | 237 | </literallayout></para> |
236 | <para>The same | 238 | <para>The same |
237 | <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'>wiki page</ulink> | 239 | <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'>wiki page</ulink> |
@@ -263,8 +265,12 @@ | |||
263 | <orderedlist> | 265 | <orderedlist> |
264 | <listitem><para>Make sure you have set up the Source Directory described in the | 266 | <listitem><para>Make sure you have set up the Source Directory described in the |
265 | previous section.</para></listitem> | 267 | previous section.</para></listitem> |
266 | <listitem><para>Initialize the build environment by sourcing a build environment | 268 | <listitem><para>Initialize the build environment by sourcing a build |
267 | script.</para></listitem> | 269 | environment script (i.e. |
270 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> | ||
271 | or | ||
272 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>). | ||
273 | </para></listitem> | ||
268 | <listitem><para>Optionally ensure the <filename>conf/local.conf</filename> configuration file, | 274 | <listitem><para>Optionally ensure the <filename>conf/local.conf</filename> configuration file, |
269 | which is found in the | 275 | which is found in the |
270 | <link linkend='build-directory'>Build Directory</link>, | 276 | <link linkend='build-directory'>Build Directory</link>, |
@@ -277,10 +283,11 @@ | |||
277 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'>PARALLEL_MAKE</ulink></filename> variables, and | 283 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'>PARALLEL_MAKE</ulink></filename> variables, and |
278 | a centralized tarball download directory through the | 284 | a centralized tarball download directory through the |
279 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'>DL_DIR</ulink></filename> variable.</para></listitem> | 285 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'>DL_DIR</ulink></filename> variable.</para></listitem> |
280 | <listitem><para>Build the image using the <filename>bitbake</filename> command. | 286 | <listitem><para> |
281 | If you want information on BitBake, see the user manual included in the | 287 | Build the image using the <filename>bitbake</filename> command. |
282 | <filename>bitbake/doc/manual</filename> directory of the | 288 | If you want information on BitBake, see the |
283 | <link linkend='source-directory'>Source Directory</link>.</para></listitem> | 289 | <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual</ulink>. |
290 | </para></listitem> | ||
284 | <listitem><para>Run the image either on the actual hardware or using the QEMU | 291 | <listitem><para>Run the image either on the actual hardware or using the QEMU |
285 | emulator.</para></listitem> | 292 | emulator.</para></listitem> |
286 | </orderedlist> | 293 | </orderedlist> |