summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-start.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-10-22 13:16:49 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-10-23 00:03:13 +0100
commit2b51188de67f16423da2b0c0b3859b8900de6828 (patch)
tree097066d4bd084095625d8006c8913f760cc16b5d /documentation/dev-manual/dev-manual-start.xml
parentf3c1226cc8572a00fece289e93f0a0fd0c090fa6 (diff)
downloadpoky-2b51188de67f16423da2b0c0b3859b8900de6828.tar.gz
documentation: dev-manual - Final changes before 1.3 lockdown.
Made minor changes as needed due to some new sections, links, and capitalization standards. (From yocto-docs rev: bc966e5a78dadd14ecf1896a36e40a9b256bae77) 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.xml31
1 files changed, 16 insertions, 15 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index e55a07d87a..11d4adca9f 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -56,8 +56,9 @@
56 OpenSUSE, Ubuntu, or CentOS as these releases are frequently tested against the Yocto Project 56 OpenSUSE, Ubuntu, or CentOS as these releases are frequently tested against the Yocto Project
57 and officially supported. 57 and officially supported.
58 For a list of the distributions under validation and their status, see the 58 For a list of the distributions under validation and their status, see the
59 <ulink url='&YOCTO_WIKI_URL;/wiki/Distribution_Support'>Distribution 59 "<ulink url='&YOCTO_DOCS_REF_URL;#detailed-supported-distros'>Supported Linux Distributions</ulink>" section
60 Support</ulink> wiki page.</para> 60 in the Yocto Project Reference Manual and the wiki page at
61 <ulink url='&YOCTO_WIKI_URL;/wiki/Distribution_Support'>Distribution Support</ulink>.</para>
61 <para> 62 <para>
62 You should also have about 100 gigabytes of free disk space for building images. 63 You should also have about 100 gigabytes of free disk space for building images.
63 </para></listitem> 64 </para></listitem>
@@ -69,12 +70,12 @@
69 for the supported distributions.</para></listitem> 70 for the supported distributions.</para></listitem>
70 <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis> 71 <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis>
71 You need a release of the Yocto Project. 72 You need a release of the Yocto Project.
72 You set up a with local <link linkend='source-directory'>source directory</link> 73 You set up a with local <link linkend='source-directory'>Source Directory</link>
73 one of two ways depending on whether you 74 one of two ways depending on whether you
74 are going to contribute back into the Yocto Project or not. 75 are going to contribute back into the Yocto Project or not.
75 <note> 76 <note>
76 Regardless of the method you use, this manual refers to the resulting local 77 Regardless of the method you use, this manual refers to the resulting local
77 hierarchical set of files as the "source directory." 78 hierarchical set of files as the "Source Directory."
78 </note> 79 </note>
79 <itemizedlist> 80 <itemizedlist>
80 <listitem><para><emphasis>Tarball Extraction:</emphasis> If you are not going to contribute 81 <listitem><para><emphasis>Tarball Extraction:</emphasis> If you are not going to contribute
@@ -83,7 +84,7 @@
83 Once you have the tarball, just extract it into a directory of your choice.</para> 84 Once you have the tarball, just extract it into a directory of your choice.</para>
84 <para>For example, the following command extracts the Yocto Project &DISTRO; 85 <para>For example, the following command extracts the Yocto Project &DISTRO;
85 release tarball 86 release tarball
86 into the current working directory and sets up the local source directory 87 into the current working directory and sets up the local Source Directory
87 with a top-level folder named <filename>&YOCTO_POKY;</filename>: 88 with a top-level folder named <filename>&YOCTO_POKY;</filename>:
88 <literallayout class='monospaced'> 89 <literallayout class='monospaced'>
89 $ tar xfj &YOCTO_POKY_TARBALL; 90 $ tar xfj &YOCTO_POKY_TARBALL;
@@ -125,11 +126,11 @@
125 You can find Git repositories of supported Yocto Project Kernels organized under 126 You can find Git repositories of supported Yocto Project Kernels organized under
126 "Yocto Linux Kernel" in the Yocto Project Source Repositories at 127 "Yocto Linux Kernel" in the Yocto Project Source Repositories at
127 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> 128 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para>
128 <para>This setup involves creating a bare clone of the Yocto Project kernel and then 129 <para>This setup can involve creating a bare clone of the Yocto Project kernel and then
129 copying that cloned repository. 130 copying that cloned repository.
130 You can create the bare clone and the copy of the bare clone anywhere you like. 131 You can create the bare clone and the copy of the bare clone anywhere you like.
131 For simplicity, it is recommended that you create these structures outside of the 132 For simplicity, it is recommended that you create these structures outside of the
132 source directory (usually <filename>poky</filename>).</para> 133 Source Directory (usually <filename>poky</filename>).</para>
133 <para>As an example, the following transcript shows how to create the bare clone 134 <para>As an example, the following transcript shows how to create the bare clone
134 of the <filename>linux-yocto-3.4</filename> kernel and then create a copy of 135 of the <filename>linux-yocto-3.4</filename> kernel and then create a copy of
135 that clone. 136 that clone.
@@ -168,9 +169,9 @@
168 <para>You can find the <filename>poky-extras</filename> Git Repository in the 169 <para>You can find the <filename>poky-extras</filename> Git Repository in the
169 "Yocto Metadata Layers" area of the Yocto Project Source Repositories at 170 "Yocto Metadata Layers" area of the Yocto Project Source Repositories at
170 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>. 171 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.
171 It is good practice to create this Git repository inside the source directory.</para> 172 It is good practice to create this Git repository inside the Source Directory.</para>
172 <para>Following is an example that creates the <filename>poky-extras</filename> Git 173 <para>Following is an example that creates the <filename>poky-extras</filename> Git
173 repository inside the source directory, which is named <filename>poky</filename> 174 repository inside the Source Directory, which is named <filename>poky</filename>
174 in this case: 175 in this case:
175 <literallayout class='monospaced'> 176 <literallayout class='monospaced'>
176 $ cd ~/poky 177 $ cd ~/poky
@@ -192,7 +193,7 @@
192 layer. 193 layer.
193 You can get set up for BSP development one of two ways: tarball extraction or 194 You can get set up for BSP development one of two ways: tarball extraction or
194 with a local Git repository. 195 with a local Git repository.
195 It is a good idea to use the same method that you used to set up the source directory. 196 It is a good idea to use the same method that you used to set up the Source Directory.
196 Regardless of the method you use, the Yocto Project uses the following BSP layer 197 Regardless of the method you use, the Yocto Project uses the following BSP layer
197 naming scheme: 198 naming scheme:
198 <literallayout class='monospaced'> 199 <literallayout class='monospaced'>
@@ -218,13 +219,13 @@
218 Again, this method just produces a snapshot of the BSP layer in the form 219 Again, this method just produces a snapshot of the BSP layer in the form
219 of a hierarchical directory structure.</para></listitem> 220 of a hierarchical directory structure.</para></listitem>
220 <listitem><para><emphasis>Git Repository Method:</emphasis> If you are working 221 <listitem><para><emphasis>Git Repository Method:</emphasis> If you are working
221 with a local Git repository for your source directory, you should also use this method 222 with a local Git repository for your Source Directory, you should also use this method
222 to set up the <filename>meta-intel</filename> Git repository. 223 to set up the <filename>meta-intel</filename> Git repository.
223 You can locate the <filename>meta-intel</filename> Git repository in the 224 You can locate the <filename>meta-intel</filename> Git repository in the
224 "Yocto Metadata Layers" area of the Yocto Project Source Repositories at 225 "Yocto Metadata Layers" area of the Yocto Project Source Repositories at
225 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> 226 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para>
226 <para>Typically, you set up the <filename>meta-intel</filename> Git repository inside 227 <para>Typically, you set up the <filename>meta-intel</filename> Git repository inside
227 the source directory. 228 the Source Directory.
228 For example, the following transcript shows the steps to clone the 229 For example, the following transcript shows the steps to clone the
229 <filename>meta-intel</filename> 230 <filename>meta-intel</filename>
230 Git repository inside the local <filename>poky</filename> Git repository. 231 Git repository inside the local <filename>poky</filename> Git repository.
@@ -266,13 +267,13 @@
266 <para> 267 <para>
267 The build process is as follows: 268 The build process is as follows:
268 <orderedlist> 269 <orderedlist>
269 <listitem><para>Make sure you have set up the source directory described in the 270 <listitem><para>Make sure you have set up the Source Directory described in the
270 previous section.</para></listitem> 271 previous section.</para></listitem>
271 <listitem><para>Initialize the build environment by sourcing a build environment 272 <listitem><para>Initialize the build environment by sourcing a build environment
272 script.</para></listitem> 273 script.</para></listitem>
273 <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,
274 which is found in the 275 which is found in the
275 <link linkend='build-directory'>build directory</link>, 276 <link linkend='build-directory'>Build Directory</link>,
276 is set up how you want it. 277 is set up how you want it.
277 This file defines many aspects of the build environment including 278 This file defines many aspects of the build environment including
278 the target machine architecture through the 279 the target machine architecture through the
@@ -298,7 +299,7 @@
298 <para> 299 <para>
299 Another option you have to get started is to use pre-built binaries. 300 Another option you have to get started is to use pre-built binaries.
300 The Yocto Project provides many types of binaries with each release. 301 The Yocto Project provides many types of binaries with each release.
301 See the <ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink> 302 See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>"
302 chapter in the Yocto Project Reference Manual 303 chapter in the Yocto Project Reference Manual
303 for descriptions of the types of binaries that ship with a Yocto Project 304 for descriptions of the types of binaries that ship with a Yocto Project
304 release. 305 release.