diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-04-09 10:53:46 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-04-10 16:20:55 +0100 |
commit | 94b786bf91ed5ed655ae4c4543ba3a81faa9d583 (patch) | |
tree | 43f789a066b490c70639999bc28cf13d74924588 /documentation/dev-manual | |
parent | 90170fe4c92d3930690e427d1b21df3e4af03315 (diff) | |
download | poky-94b786bf91ed5ed655ae4c4543ba3a81faa9d583.tar.gz |
dev-manual: Updates to "Getting Set Up" section.
Updated the transcripts used to set things up. I also changed
the kernel used in the examples from 3.4 to 3.8.
(From yocto-docs rev: d83e5a5a73777baf95b5c4558f25a5b0b27c204c)
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 | 102 |
1 files changed, 54 insertions, 48 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index c4d91fff84..42a6e82c88 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
@@ -72,9 +72,12 @@ | |||
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 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 for the exact package | 75 | section in the Yocto Project Quick Start and the |
76 | requirements and the installation commands to install them | 76 | "<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>" |
77 | for the supported distributions.</para></listitem> | 77 | section in the Yocto Project Reference Manual for the exact |
78 | package requirements and the installation commands to install | ||
79 | them for the supported distributions. | ||
80 | </para></listitem> | ||
78 | <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis> | 81 | <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis> |
79 | You need a release of the Yocto Project. | 82 | You need a release of the Yocto Project. |
80 | You set that up with a local <link linkend='source-directory'>Source Directory</link> | 83 | You set that up with a local <link linkend='source-directory'>Source Directory</link> |
@@ -85,12 +88,15 @@ | |||
85 | hierarchical set of files as the "Source Directory." | 88 | hierarchical set of files as the "Source Directory." |
86 | </note> | 89 | </note> |
87 | <itemizedlist> | 90 | <itemizedlist> |
88 | <listitem><para><emphasis>Tarball Extraction:</emphasis> If you are not going to contribute | 91 | <listitem><para><emphasis>Tarball Extraction:</emphasis> |
89 | back into the Yocto Project, you can simply download a Yocto Project release you want | 92 | If you are not going to contribute back into the Yocto |
90 | from the website’s <ulink url='&YOCTO_HOME_URL;/download'>download page</ulink>. | 93 | Project, you can simply go to the |
91 | Once you have the tarball, just extract it into a directory of your choice.</para> | 94 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>, |
92 | <para>For example, the following command extracts the Yocto Project &DISTRO; | 95 | select the "Downloads" tab, and choose what you want. |
93 | release tarball | 96 | Once you have the tarball, just extract it into a |
97 | directory of your choice.</para> | ||
98 | <para>For example, the following command extracts the | ||
99 | Yocto Project &DISTRO; release tarball | ||
94 | into the current working directory and sets up the local Source Directory | 100 | into the current working directory and sets up the local Source Directory |
95 | with a top-level folder named <filename>&YOCTO_POKY;</filename>: | 101 | with a top-level folder named <filename>&YOCTO_POKY;</filename>: |
96 | <literallayout class='monospaced'> | 102 | <literallayout class='monospaced'> |
@@ -104,23 +110,23 @@ | |||
104 | Git repository of the upstream <filename>poky</filename> source repository. | 110 | Git repository of the upstream <filename>poky</filename> source repository. |
105 | Doing so creates a repository with a complete history of changes and allows | 111 | Doing so creates a repository with a complete history of changes and allows |
106 | you to easily submit your changes upstream to the project. | 112 | you to easily submit your changes upstream to the project. |
107 | Because you cloned the repository, you have access to all the Yocto Project development | 113 | Because you clone the repository, you have access to all the Yocto Project development |
108 | branches and tag names used in the upstream repository.</para> | 114 | branches and tag names used in the upstream repository.</para> |
109 | <para>The following transcript shows how to clone the <filename>poky</filename> | ||
110 | Git repository into the current working directory. | ||
111 | <note>You can view the Yocto Project Source Repositories at | 115 | <note>You can view the Yocto Project Source Repositories at |
112 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink></note> | 116 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink></note> |
117 | <para>The following transcript shows how to clone the <filename>poky</filename> | ||
118 | Git repository into the current working directory. | ||
113 | The command creates the local repository in a directory named <filename>poky</filename>. | 119 | The command creates the local repository in a directory named <filename>poky</filename>. |
114 | For information on Git used within the Yocto Project, see the | 120 | For information on Git used within the Yocto Project, see the |
115 | "<link linkend='git'>Git</link>" section. | 121 | "<link linkend='git'>Git</link>" section. |
116 | <literallayout class='monospaced'> | 122 | <literallayout class='monospaced'> |
117 | $ git clone git://git.yoctoproject.org/poky | 123 | $ git clone git://git.yoctoproject.org/poky |
118 | Initialized empty Git repository in /home/scottrif/poky/.git/ | 124 | Cloning into 'poky'... |
119 | remote: Counting objects: 141863, done. | 125 | remote: Counting objects: 183981, done. |
120 | remote: Compressing objects: 100% (38624/38624), done. | 126 | remote: Compressing objects: 100% (47428/47428), done. |
121 | remote: Total 141863 (delta 99661), reused 141816 (delta 99614) | 127 | remote: Total 183981 (delta 132271), reused 183703 (delta 132044) |
122 | Receiving objects: 100% (141863/141863), 76.64 MiB | 126 KiB/s, done. | 128 | Receiving objects: 100% (183981/183981), 89.71 MiB | 2.93 MiB/s, done. |
123 | Resolving deltas: 100% (99661/99661), done. | 129 | Resolving deltas: 100% (132271/132271), done. |
124 | </literallayout></para> | 130 | </literallayout></para> |
125 | <para>For another example of how to set up your own local Git repositories, see this | 131 | <para>For another example of how to set up your own local Git repositories, see this |
126 | <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> | 132 | <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> |
@@ -139,33 +145,32 @@ | |||
139 | For simplicity, it is recommended that you create these structures outside of the | 145 | For simplicity, it is recommended that you create these structures outside of the |
140 | Source Directory (usually <filename>poky</filename>).</para> | 146 | Source Directory (usually <filename>poky</filename>).</para> |
141 | <para>As an example, the following transcript shows how to create the bare clone | 147 | <para>As an example, the following transcript shows how to create the bare clone |
142 | of the <filename>linux-yocto-3.4</filename> kernel and then create a copy of | 148 | of the <filename>linux-yocto-3.8</filename> kernel and then create a copy of |
143 | that clone. | 149 | that clone. |
144 | <note>When you have a local Yocto Project kernel Git repository, you can | 150 | <note>When you have a local Yocto Project kernel Git repository, you can |
145 | reference that repository rather than the upstream Git repository as | 151 | reference that repository rather than the upstream Git repository as |
146 | part of the <filename>clone</filename> command. | 152 | part of the <filename>clone</filename> command. |
147 | Doing so can speed up the process.</note></para> | 153 | Doing so can speed up the process.</note></para> |
148 | <para>In the following example, the bare clone is named | 154 | <para>In the following example, the bare clone is named |
149 | <filename>linux-yocto-3.4.git</filename>, while the | 155 | <filename>linux-yocto-3.8.git</filename>, while the |
150 | copy is named <filename>my-linux-yocto-3.4-work</filename>: | 156 | copy is named <filename>my-linux-yocto-3.8-work</filename>: |
151 | <literallayout class='monospaced'> | 157 | <literallayout class='monospaced'> |
152 | $ git clone --bare git://git.yoctoproject.org/linux-yocto-3.4 linux-yocto-3.4.git | 158 | $ git clone --bare git://git.yoctoproject.org/linux-yocto-3.8 linux-yocto-3.8.git |
153 | Initialized empty Git repository in /home/scottrif/linux-yocto-3.4.git/ | 159 | Cloning into bare repository 'linux-yocto-3.8.git'... |
154 | remote: Counting objects: 2468027, done. | 160 | remote: Counting objects: 2847090, done. |
155 | remote: Compressing objects: 100% (392255/392255), done. | 161 | remote: Compressing objects: 100% (454675/454675), done. |
156 | remote: Total 2468027 (delta 2071693), reused 2448773 (delta 2052498) | 162 | remote: Total 2847090 (delta 2386170), reused 2825793 (delta 2364886) |
157 | Receiving objects: 100% (2468027/2468027), 530.46 MiB | 129 KiB/s, done. | 163 | Receiving objects: 100% (2847090/2847090), 603.19 MiB | 3.54 MiB/s, done. |
158 | Resolving deltas: 100% (2071693/2071693), done. | 164 | Resolving deltas: 100% (2386170/2386170), done. </literallayout></para> |
159 | </literallayout></para> | ||
160 | <para>Now create a clone of the bare clone just created: | 165 | <para>Now create a clone of the bare clone just created: |
161 | <literallayout class='monospaced'> | 166 | <literallayout class='monospaced'> |
162 | $ git clone linux-yocto-3.4.git my-linux-yocto-3.4-work | 167 | $ git clone linux-yocto-3.8.git my-linux-yocto-3.8-work |
163 | Cloning into 'my-linux-yocto-3.4-work'... | 168 | Cloning into 'my-linux-yocto-3.8-work'... |
164 | done. | 169 | done. |
165 | </literallayout></para></listitem> | 170 | </literallayout></para></listitem> |
166 | <listitem id='poky-extras-repo'><para><emphasis> | 171 | <listitem id='poky-extras-repo'><para><emphasis> |
167 | The <filename>poky-extras</filename> Git Repository</emphasis>: | 172 | The <filename>poky-extras</filename> Git Repository</emphasis>: |
168 | The <filename>poky-extras</filename> Git repository contains metadata needed | 173 | The <filename>poky-extras</filename> Git repository contains Metadata needed |
169 | only if you are modifying and building the kernel image. | 174 | only if you are modifying and building the kernel image. |
170 | In particular, it contains the kernel BitBake append (<filename>.bbappend</filename>) | 175 | In particular, it contains the kernel BitBake append (<filename>.bbappend</filename>) |
171 | files that you | 176 | files that you |
@@ -183,13 +188,12 @@ | |||
183 | <literallayout class='monospaced'> | 188 | <literallayout class='monospaced'> |
184 | $ cd ~/poky | 189 | $ cd ~/poky |
185 | $ git clone git://git.yoctoproject.org/poky-extras poky-extras | 190 | $ git clone git://git.yoctoproject.org/poky-extras poky-extras |
186 | Initialized empty Git repository in /home/scottrif/poky/poky-extras/.git/ | 191 | Cloning into 'poky-extras'... |
187 | remote: Counting objects: 618, done. | 192 | remote: Counting objects: 690, done. |
188 | remote: Compressing objects: 100% (558/558), done. | 193 | remote: Compressing objects: 100% (431/431), done. |
189 | remote: Total 618 (delta 192), reused 307 (delta 39) | 194 | remote: Total 690 (delta 238), reused 690 (delta 238) |
190 | Receiving objects: 100% (618/618), 526.26 KiB | 111 KiB/s, done. | 195 | Receiving objects: 100% (690/690), 532.60 KiB, done. |
191 | Resolving deltas: 100% (192/192), done. | 196 | Resolving deltas: 100% (238/238), done. </literallayout></para></listitem> |
192 | </literallayout></para></listitem> | ||
193 | <listitem><para id='supported-board-support-packages-(bsps)'><emphasis>Supported Board | 197 | <listitem><para id='supported-board-support-packages-(bsps)'><emphasis>Supported Board |
194 | Support Packages (BSPs):</emphasis> | 198 | Support Packages (BSPs):</emphasis> |
195 | The Yocto Project provides a layer called <filename>meta-intel</filename> and | 199 | The Yocto Project provides a layer called <filename>meta-intel</filename> and |
@@ -219,10 +223,12 @@ | |||
219 | information on BSP Layers. | 223 | information on BSP Layers. |
220 | <itemizedlist> | 224 | <itemizedlist> |
221 | <listitem><para><emphasis>Tarball Extraction:</emphasis> You can download any released | 225 | <listitem><para><emphasis>Tarball Extraction:</emphasis> You can download any released |
222 | BSP tarball from the same | 226 | BSP tarball from the same "Downloads" page of the |
223 | <ulink url='&YOCTO_HOME_URL;/download'>download site</ulink> used | 227 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink> |
224 | to get the Yocto Project release. | 228 | to get the Yocto Project release. |
225 | Once you have the tarball, just extract it into a directory of your choice. | 229 | Once on the "Download" page, look for "BSP" under the |
230 | "Type" heading.</para> | ||
231 | <para>Once you have the tarball, just extract it into a directory of your choice. | ||
226 | Again, this method just produces a snapshot of the BSP layer in the form | 232 | Again, this method just produces a snapshot of the BSP layer in the form |
227 | of a hierarchical directory structure.</para></listitem> | 233 | of a hierarchical directory structure.</para></listitem> |
228 | <listitem><para><emphasis>Git Repository Method:</emphasis> If you are working | 234 | <listitem><para><emphasis>Git Repository Method:</emphasis> If you are working |
@@ -239,12 +245,12 @@ | |||
239 | <literallayout class='monospaced'> | 245 | <literallayout class='monospaced'> |
240 | $ cd ~/poky | 246 | $ cd ~/poky |
241 | $ git clone git://git.yoctoproject.org/meta-intel.git | 247 | $ git clone git://git.yoctoproject.org/meta-intel.git |
242 | Initialized empty Git repository in /home/scottrif/poky/meta-intel/.git/ | 248 | Cloning into 'meta-intel'... |
243 | remote: Counting objects: 3380, done. | 249 | remote: Counting objects: 6264, done. |
244 | remote: Compressing objects: 100% (2750/2750), done. | 250 | remote: Compressing objects: 100% (2135/2135), done. |
245 | remote: Total 3380 (delta 1689), reused 227 (delta 113) | 251 | remote: Total 6264 (delta 3321), reused 6235 (delta 3293) |
246 | Receiving objects: 100% (3380/3380), 1.77 MiB | 128 KiB/s, done. | 252 | Receiving objects: 100% (6264/6264), 2.17 MiB | 2.63 MiB/s, done. |
247 | Resolving deltas: 100% (1689/1689), done. | 253 | Resolving deltas: 100% (3321/3321), done. |
248 | </literallayout></para> | 254 | </literallayout></para> |
249 | <para>The same | 255 | <para>The same |
250 | <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> | 256 | <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> |