summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-start.xml
diff options
context:
space:
mode:
authorRobert P. J. Day <rpjday@crashcourse.ca>2013-11-11 10:26:00 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-12-03 12:53:54 +0000
commit803300cc126ab5581454d0dfb153d5c11998f5bc (patch)
treef5574258f8ec6634479289998b820df829f2f7ed /documentation/dev-manual/dev-manual-start.xml
parent4cab968da8bda8d1bdc231417b3c8c9c9396ec10 (diff)
downloadpoky-803300cc126ab5581454d0dfb153d5c11998f5bc.tar.gz
dev-manual: A few tweaks to Ch2 of dev-manual
scott (or anyone else) is welcome to use any or all of this, or tweak to taste. i have a few other concerns with ch 2 but i'll read it more carefully to make sure i'm reading it correctly. - rpjday I implemented all but the addition of MIPS64 as it is not tested using the autobuilder yet. - scottrif (From yocto-docs rev: 9ae733456e1d39de66ad6235172f26cab4a33269) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Conflicts: documentation/dev-manual/dev-manual-start.xml 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.xml33
1 files changed, 22 insertions, 11 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 0729baa0da..8ee626406b 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -55,12 +55,12 @@
55 <title>Getting Set Up</title> 55 <title>Getting Set Up</title>
56 56
57 <para> 57 <para>
58 Here is what you need to get set up to use the Yocto Project: 58 Here is what you need to use the Yocto Project:
59 <itemizedlist> 59 <itemizedlist>
60 <listitem><para><emphasis>Host System:</emphasis> You should have a reasonably current 60 <listitem><para><emphasis>Host System:</emphasis> You should have a reasonably current
61 Linux-based host system. 61 Linux-based host system.
62 You will have the best results with a recent release of Fedora, 62 You will have the best results with a recent release of Fedora,
63 OpenSUSE, Debian, Ubuntu, or CentOS as these releases are frequently tested against the Yocto Project 63 openSUSE, Debian, Ubuntu, or CentOS as these releases are frequently tested against the Yocto Project
64 and officially supported. 64 and officially supported.
65 For a list of the distributions under validation and their status, see the 65 For a list of the distributions under validation and their status, see the
66 "<ulink url='&YOCTO_DOCS_REF_URL;#detailed-supported-distros'>Supported Linux Distributions</ulink>" section 66 "<ulink url='&YOCTO_DOCS_REF_URL;#detailed-supported-distros'>Supported Linux Distributions</ulink>" section
@@ -70,7 +70,7 @@
70 You should also have about 100 gigabytes of free disk space for building images. 70 You should also have about 100 gigabytes of free disk space for building images.
71 </para></listitem> 71 </para></listitem>
72 <listitem><para><emphasis>Packages:</emphasis> The OpenEmbedded build system 72 <listitem><para><emphasis>Packages:</emphasis> The OpenEmbedded build system
73 requires certain packages exist on your development system (e.g. Python 2.6 or 2.7). 73 requires that certain packages exist on your development system (e.g. Python 2.6 or 2.7).
74 See "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" 74 See "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>"
75 section in the Yocto Project Quick Start and the 75 section in the Yocto Project Quick Start and the
76 "<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>" 76 "<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>"
@@ -79,13 +79,24 @@
79 them for the supported distributions. 79 them for the supported distributions.
80 </para></listitem> 80 </para></listitem>
81 <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis> 81 <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis>
82 You need a release of the Yocto Project. 82 You need a release of the Yocto Project installed locally on
83 You set that up with a local <link linkend='source-directory'>Source Directory</link> 83 your development system.
84 one of two ways depending on whether you 84 This local area is referred to as the
85 are going to contribute back into the Yocto Project or not. 85 <link linkend='source-directory'>Source Directory</link>
86 <note> 86 and is created when you use
87 Regardless of the method you use, this manual refers to the resulting local 87 <link linkend='git'>Git</link> to clone a local copy
88 hierarchical set of files as the "Source Directory." 88 of the upstream <filename>poky</filename> repository,
89 or when you download an official release of the corresponding tarball.</para>
90 <para>Working from a copy of the upstream repository allows you
91 to contribute back into the Yocto Project or simply work with
92 the latest software on a development branch.
93 Because Git maintains and creates an upstream repository with
94 a complete history of changes and you are working with a local
95 clone of that repository, you have access to all the Yocto
96 Project development branches and tag names used in the upstream
97 repository.</para>
98 <note>You can view the Yocto Project Source Repositories at
99 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>
89 </note> 100 </note>
90 <itemizedlist> 101 <itemizedlist>
91 <listitem><para><emphasis>Tarball Extraction:</emphasis> 102 <listitem><para><emphasis>Tarball Extraction:</emphasis>
@@ -136,7 +147,7 @@
136 <listitem id='local-kernel-files'><para><emphasis>Yocto Project Kernel:</emphasis> 147 <listitem id='local-kernel-files'><para><emphasis>Yocto Project Kernel:</emphasis>
137 If you are going to be making modifications to a supported Yocto Project kernel, you 148 If you are going to be making modifications to a supported Yocto Project kernel, you
138 need to establish local copies of the source. 149 need to establish local copies of the source.
139 You can find Git repositories of supported Yocto Project Kernels organized under 150 You can find Git repositories of supported Yocto Project kernels organized under
140 "Yocto Linux Kernel" in the Yocto Project Source Repositories at 151 "Yocto Linux Kernel" in the Yocto Project Source Repositories at
141 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> 152 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para>
142 <para>This setup can involve creating a bare clone of the Yocto Project kernel and then 153 <para>This setup can involve creating a bare clone of the Yocto Project kernel and then