summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-10-04 10:13:42 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-10-10 15:24:12 +0100
commit0a4f7521bb786b7ac84e3204812a2c76df29c0de (patch)
treebe6443c82f698de4dd4ae2f92775ac94472f5071 /documentation/dev-manual
parentc1261f843e0bd22ef09e9027e45f6a5d58760d13 (diff)
downloadpoky-0a4f7521bb786b7ac84e3204812a2c76df29c0de.tar.gz
documentation: dev-manual - Edits to setup part of example
Minor edits to the part of the example that sets up for the first core-image-minimal build. Put in the variable to use for the build environment setup script, updated some changed output from some of the commands, etc. (From yocto-docs rev: 0b4b2ddf9a78a9d6d218ed9a6f0acd3e876d9581) 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-kernel-appendix.xml63
-rw-r--r--documentation/dev-manual/dev-manual-start.xml4
2 files changed, 48 insertions, 19 deletions
diff --git a/documentation/dev-manual/dev-manual-kernel-appendix.xml b/documentation/dev-manual/dev-manual-kernel-appendix.xml
index 667640c86f..cf5fb4522a 100644
--- a/documentation/dev-manual/dev-manual-kernel-appendix.xml
+++ b/documentation/dev-manual/dev-manual-kernel-appendix.xml
@@ -76,16 +76,18 @@
76 <listitem><para><emphasis>Local Source Directory:</emphasis> 76 <listitem><para><emphasis>Local Source Directory:</emphasis>
77 This area contains all the metadata that supports building images 77 This area contains all the metadata that supports building images
78 using the OpenEmbedded build system. 78 using the OpenEmbedded build system.
79 In this example, the Source Directory also 79 In this example, the
80 contains the build directory, which contains the configuration directory 80 <link linkend='source-directory'>Source Directory</link> also
81 contains the
82 <link linkend='build-directory'>Build Directory</link>,
83 which contains the configuration directory
81 that lets you control the build. 84 that lets you control the build.
82 Also in this example, the Source Directory contains local copies of the 85 Also in this example, the Source Directory contains local copies of the
83 <filename>poky-extras</filename> Git repository.</para> 86 <filename>poky-extras</filename> Git repository.</para>
84 <para>See the bulleted item 87 <para>See the bulleted item
85 "<link linkend='local-yp-release'>Yocto Project Release</link>" 88 "<link linkend='local-yp-release'>Yocto Project Release</link>"
86 for information on how to get these files on your local system.</para></listitem> 89 for information on how to get these files on your local system.</para></listitem>
87 <listitem><para><emphasis>Local copies of the<filename>poky-extras</filename> 90 <listitem><para><emphasis>Local copies of the&nbsp;<filename>poky-extras</filename>&nbsp;Git Repository:</emphasis>
88 Git Repository:</emphasis>
89 This area contains the <filename>meta-kernel-dev</filename> layer, 91 This area contains the <filename>meta-kernel-dev</filename> layer,
90 which is where you make changes that append the kernel build recipes. 92 which is where you make changes that append the kernel build recipes.
91 You edit <filename>.bbappend</filename> files to locate your 93 You edit <filename>.bbappend</filename> files to locate your
@@ -132,7 +134,9 @@
132 <title>Setting Up the Local Source Directory</title> 134 <title>Setting Up the Local Source Directory</title>
133 135
134 <para> 136 <para>
135 You can set up the Source Directory through tarball extraction or by 137 You can set up the
138 <link linkend='source-directory'>Source Directory</link>
139 through tarball extraction or by
136 cloning the <filename>poky</filename> Git repository. 140 cloning the <filename>poky</filename> Git repository.
137 This example uses <filename>poky</filename> as the root directory of the 141 This example uses <filename>poky</filename> as the root directory of the
138 local Source Directory. 142 local Source Directory.
@@ -179,11 +183,12 @@
179 Because this example uses the Yocto Project &DISTRO; Release code 183 Because this example uses the Yocto Project &DISTRO; Release code
180 named "&DISTRO_NAME;", which maps to the <filename>&DISTRO_NAME;</filename> 184 named "&DISTRO_NAME;", which maps to the <filename>&DISTRO_NAME;</filename>
181 branch in the repository, you need to be sure you are using that 185 branch in the repository, you need to be sure you are using that
182 branch for <filename>poky-extra</filename>. 186 branch for <filename>poky-extras</filename>.
183 The following commands create and checkout the local 187 The following commands create and checkout the local
184 branch you are using for the <filename>&DISTRO_NAME;</filename> 188 branch you are using for the <filename>&DISTRO_NAME;</filename>
185 branch: 189 branch:
186 <literallayout class='monospaced'> 190 <literallayout class='monospaced'>
191 $ cd ~/poky/poky-extras
187 $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME; 192 $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME;
188 Branch &DISTRO_NAME; set up to track remote branch &DISTRO_NAME; from origin. 193 Branch &DISTRO_NAME; set up to track remote branch &DISTRO_NAME; from origin.
189 Switched to a new branch '&DISTRO_NAME;' 194 Switched to a new branch '&DISTRO_NAME;'
@@ -195,7 +200,7 @@
195 <title>Setting Up the Bare Clone and its Copy</title> 200 <title>Setting Up the Bare Clone and its Copy</title>
196 201
197 <para> 202 <para>
198 This example modifies the <filename>linux-yocto-3.2</filename> kernel. 203 This example modifies the <filename>linux-yocto-3.4</filename> kernel.
199 Thus, you need to create a bare clone of that kernel and then make a copy of the 204 Thus, you need to create a bare clone of that kernel and then make a copy of the
200 bare clone. 205 bare clone.
201 See the bulleted item 206 See the bulleted item
@@ -207,17 +212,16 @@
207 The bare clone exists for the kernel build tools and simply as the receiving end 212 The bare clone exists for the kernel build tools and simply as the receiving end
208 of <filename>git push</filename> 213 of <filename>git push</filename>
209 commands after you make edits and commits inside the copy of the clone. 214 commands after you make edits and commits inside the copy of the clone.
210 The copy (<filename>my-linux-yocto-3.2-work</filename> in this example) has to have 215 The copy (<filename>my-linux-yocto-3.4-work</filename> in this example) has to have
211 a local branch created and checked out for your work. 216 a local branch created and checked out for your work.
212 This example uses <filename>common-pc-base</filename> as the local branch. 217 This example uses <filename>common-pc-base</filename> as the local branch.
213 The following commands create and checkout the branch: 218 The following commands create and checkout the branch:
214 <literallayout class='monospaced'> 219 <literallayout class='monospaced'>
215 $ cd ~/my-linux-yocto-3.2-work 220 $ cd ~/my-linux-yocto-3.4-work
216 $ git checkout -b common-pc-base origin/standard/default/common-pc/base 221 $ git checkout -b standard-common-pc-base origin/standard/common-pc/base
217 Checking out files: 100% (532/532), done. 222 Branch standard-common-pc-base set up to track remote branch
218 Branch common-pc-base set up to track remote branch 223 standard/common-pc/base from origin.
219 standard/default/common-pc/base from origin. 224 Switched to a new branch 'standard-common-pc-base'
220 Switched to a new branch 'common-pc-base'
221 </literallayout> 225 </literallayout>
222 </para> 226 </para>
223 </section> 227 </section>
@@ -249,11 +253,36 @@
249 If necessary, the script creates the build directory: 253 If necessary, the script creates the build directory:
250 <literallayout class='monospaced'> 254 <literallayout class='monospaced'>
251 $ cd ~/poky 255 $ cd ~/poky
252 $ source oe-init-build-env 256 $ source &OE_INIT_FILE;
257 You had no conf/local.conf file. This configuration file has therefore been
258 created for you with some default values. You may wish to edit it to use a
259 different MACHINE (target hardware) or enable parallel build options to take
260 advantage of multiple cores for example. See the file for more information as
261 common configuration options are commented.
253 262
254 ### Shell environment set up for builds. ### 263 The Yocto Project has extensive documentation about OE including a reference manual
264 which can be found at:
265 http://yoctoproject.org/documentation
255 266
256 You can now run 'bitbake &lt;target&gt;' 267 For more information about OpenEmbedded see their website:
268 http://www.openembedded.org/
269
270 You had no conf/bblayers.conf file. The configuration file has been created for
271 you with some default values. To add additional metadata layers into your
272 configuration please add entries to this file.
273
274 The Yocto Project has extensive documentation about OE including a reference manual
275 which can be found at:
276 http://yoctoproject.org/documentation
277
278 For more information about OpenEmbedded see their website:
279 http://www.openembedded.org/
280
281
282
283 ### Shell environment set up for builds. ###
284
285 You can now run 'bitbake &lt;target&gt;>'
257 286
258 Common targets are: 287 Common targets are:
259 core-image-minimal 288 core-image-minimal
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index f9ec8d1d66..e55a07d87a 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -152,8 +152,8 @@
152 <para>Now create a clone of the bare clone just created: 152 <para>Now create a clone of the bare clone just created:
153 <literallayout class='monospaced'> 153 <literallayout class='monospaced'>
154 $ git clone linux-yocto-3.4.git my-linux-yocto-3.4-work 154 $ git clone linux-yocto-3.4.git my-linux-yocto-3.4-work
155 Initialized empty Git repository in /home/scottrif/my-linux-yocto-3.4-work/.git/ 155 Cloning into 'my-linux-yocto-3.4-work'...
156 Checking out files: 100% (37619/37619), done. 156 done.
157 </literallayout></para></listitem> 157 </literallayout></para></listitem>
158 <listitem id='poky-extras-repo'><para><emphasis> 158 <listitem id='poky-extras-repo'><para><emphasis>
159 The <filename>poky-extras</filename> Git Repository</emphasis>: 159 The <filename>poky-extras</filename> Git Repository</emphasis>: