diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-03-09 13:40:39 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-03-23 14:24:43 +0000 |
commit | aa3a201629c7e40341f53d4be57b6e4223a845c8 (patch) | |
tree | 24e16d12dc67523d68b7c62eb2d9e8079bee8eb2 /documentation/dev-manual/dev-manual-start.xml | |
parent | e9c32b6a856aa4be4ec47b5e361a4441446204f2 (diff) | |
download | poky-aa3a201629c7e40341f53d4be57b6e4223a845c8.tar.gz |
documentation/dev-manual: Converted to use poky.ent
I converted the hard links to use the variables as established
in the file poky.ent.
Also, Cleaned up some bad text in the term "Yocto Project Files."
Looks like a cut-and-paste problem.
(From yocto-docs rev: e2e20bf4895d80dae73595e93132f37fb31121d1)
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.xml | 53 |
1 files changed, 28 insertions, 25 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 53db4da056..fbebe4d65e 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
@@ -1,5 +1,6 @@ | |||
1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" |
3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | ||
3 | 4 | ||
4 | <chapter id='dev-manual-start'> | 5 | <chapter id='dev-manual-start'> |
5 | 6 | ||
@@ -9,7 +10,7 @@ | |||
9 | This chapter introduces the Yocto Project and gives you an idea of what you need to get started. | 10 | This chapter introduces the Yocto Project and gives you an idea of what you need to get started. |
10 | You can find enough information to set up your development host and build or use images for | 11 | You can find enough information to set up your development host and build or use images for |
11 | hardware supported by the Yocto Project by reading | 12 | hardware supported by the Yocto Project by reading |
12 | <ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html'> | 13 | <ulink url='&YOCTO_DOCS_QS_URL;'> |
13 | The Yocto Project Quick Start</ulink>. | 14 | The Yocto Project Quick Start</ulink>. |
14 | </para> | 15 | </para> |
15 | 16 | ||
@@ -57,7 +58,7 @@ | |||
57 | </para></listitem> | 58 | </para></listitem> |
58 | <listitem><para><emphasis>Packages:</emphasis> The Yocto Project requires certain packages | 59 | <listitem><para><emphasis>Packages:</emphasis> The Yocto Project requires certain packages |
59 | exist on your development system (e.g. Python 2.6 or 2.7). | 60 | exist on your development system (e.g. Python 2.6 or 2.7). |
60 | See "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#packages'>The Packages</ulink>" | 61 | See "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" |
61 | section in the Yocto Project Quick start for the exact package | 62 | section in the Yocto Project Quick start for the exact package |
62 | requirements and the installation commands to install them | 63 | requirements and the installation commands to install them |
63 | for the supported distributions.</para></listitem> | 64 | for the supported distributions.</para></listitem> |
@@ -75,13 +76,14 @@ | |||
75 | <itemizedlist> | 76 | <itemizedlist> |
76 | <listitem><para><emphasis>Tarball Extraction:</emphasis> If you are not going to contribute | 77 | <listitem><para><emphasis>Tarball Extraction:</emphasis> If you are not going to contribute |
77 | back into the Yocto Project, you can simply download the Yocto Project release you want | 78 | back into the Yocto Project, you can simply download the Yocto Project release you want |
78 | from the website’s <ulink url='http://yoctoproject.org/download'>download page</ulink>. | 79 | from the website’s <ulink url='&YOCTO_HOME_URL;/download'>download page</ulink>. |
79 | Once you have the tarball, just extract it into a directory of your choice.</para> | 80 | Once you have the tarball, just extract it into a directory of your choice.</para> |
80 | <para>For example, the following command extracts the Yocto Project 1.1 release tarball | 81 | <para>For example, the following command extracts the Yocto Project &DISTRO; |
82 | release tarball | ||
81 | into the current working directory and sets up the Yocto Project file structure | 83 | into the current working directory and sets up the Yocto Project file structure |
82 | with a top-level directory named <filename>poky-edison-6.0</filename>: | 84 | with a top-level directory named <filename>&YOCTO_POKY;</filename>: |
83 | <literallayout class='monospaced'> | 85 | <literallayout class='monospaced'> |
84 | $ tar xfj poky-edison-6.0.tar.bz2 | 86 | $ tar xfj &YOCTO_POKY_TARBALL; |
85 | </literallayout></para> | 87 | </literallayout></para> |
86 | <para>This method does not produce a Git repository. | 88 | <para>This method does not produce a Git repository. |
87 | Instead, you simply end up with a local snapshot of the | 89 | Instead, you simply end up with a local snapshot of the |
@@ -100,7 +102,7 @@ | |||
100 | <note>The name of the Yocto Project Files Git repository in the Yocto Project Files | 102 | <note>The name of the Yocto Project Files Git repository in the Yocto Project Files |
101 | Source Repositories is <filename>poky</filename>. | 103 | Source Repositories is <filename>poky</filename>. |
102 | You can view the Yocto Project Source Repositories at | 104 | You can view the Yocto Project Source Repositories at |
103 | <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink></note> | 105 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink></note> |
104 | The command creates the local repository in a directory named <filename>poky</filename>. | 106 | The command creates the local repository in a directory named <filename>poky</filename>. |
105 | For information on Git used within the Yocto Project, see the | 107 | For information on Git used within the Yocto Project, see the |
106 | "<link linkend='git'>Git</link>" section. | 108 | "<link linkend='git'>Git</link>" section. |
@@ -111,9 +113,10 @@ | |||
111 | remote: Compressing objects: 100% (35987/35987), done. | 113 | remote: Compressing objects: 100% (35987/35987), done. |
112 | remote: Total 116882 (delta 80651), reused 113045 (delta 77578) | 114 | remote: Total 116882 (delta 80651), reused 113045 (delta 77578) |
113 | Receiving objects: 100% (116882/116882), 72.13 MiB | 2.68 MiB/s, done. | 115 | Receiving objects: 100% (116882/116882), 72.13 MiB | 2.68 MiB/s, done. |
114 | Resolving deltas: 100% (80651/80651), done. </literallayout></para> | 116 | Resolving deltas: 100% (80651/80651), done. |
117 | </literallayout></para> | ||
115 | <para>For another example of how to set up your own local Git repositories, see this | 118 | <para>For another example of how to set up your own local Git repositories, see this |
116 | <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> | 119 | <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> |
117 | wiki page</ulink>, which describes how to create both <filename>poky</filename> | 120 | wiki page</ulink>, which describes how to create both <filename>poky</filename> |
118 | and <filename>meta-intel</filename> Git repositories.</para></listitem> | 121 | and <filename>meta-intel</filename> Git repositories.</para></listitem> |
119 | </itemizedlist></para></listitem> | 122 | </itemizedlist></para></listitem> |
@@ -122,7 +125,7 @@ | |||
122 | need to establish local copies of the source. | 125 | need to establish local copies of the source. |
123 | You can find Git repositories of supported Linux Yocto Kernels organized under | 126 | You can find Git repositories of supported Linux Yocto Kernels organized under |
124 | "Yocto Linux Kernel" in the Yocto Project Source Repositories at | 127 | "Yocto Linux Kernel" in the Yocto Project Source Repositories at |
125 | <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink>.</para> | 128 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> |
126 | <para>This setup involves creating a bare clone of the Linux Yocto kernel and then | 129 | <para>This setup involves creating a bare clone of the Linux Yocto kernel and then |
127 | copying that cloned repository. | 130 | copying that cloned repository. |
128 | 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. |
@@ -164,7 +167,7 @@ | |||
164 | source files from upstream each time you make changes to the kernel.</para> | 167 | source files from upstream each time you make changes to the kernel.</para> |
165 | <para>You can find the <filename>poky-extras</filename> Git Repository in the | 168 | <para>You can find the <filename>poky-extras</filename> Git Repository in the |
166 | "Yocto Metadata Layers" area of the Yocto Project Source Repositories at | 169 | "Yocto Metadata Layers" area of the Yocto Project Source Repositories at |
167 | <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink>. | 170 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>. |
168 | It is good practice to create this Git repository inside the Yocto Project | 171 | It is good practice to create this Git repository inside the Yocto Project |
169 | files Git repository.</para> | 172 | files Git repository.</para> |
170 | <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 |
@@ -185,7 +188,7 @@ | |||
185 | The Yocto Project provides a layer called <filename>meta-intel</filename> and | 188 | The Yocto Project provides a layer called <filename>meta-intel</filename> and |
186 | it is maintained in its own separate Git repository. | 189 | it is maintained in its own separate Git repository. |
187 | The <filename>meta-intel</filename> layer contains many supported | 190 | The <filename>meta-intel</filename> layer contains many supported |
188 | <ulink url='http://www.yoctoproject.org/docs/latest/bsp-guide/bsp-guide.html#bsp-layers'>BSP Layers</ulink>.</para> | 191 | <ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>.</para> |
189 | <para>Similar considerations exist for setting up the <filename>meta-intel</filename> | 192 | <para>Similar considerations exist for setting up the <filename>meta-intel</filename> |
190 | layer. | 193 | layer. |
191 | 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 |
@@ -204,13 +207,13 @@ | |||
204 | meta-n450 | 207 | meta-n450 |
205 | </literallayout> | 208 | </literallayout> |
206 | See the | 209 | See the |
207 | "<ulink url='http://www.yoctoproject.org/docs/latest/bsp-guide/bsp-guide.html#bsp-layers'>BSP Layers</ulink>" | 210 | "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" |
208 | section in the Yocto Project Board Support Package (BSP) Developer's Guide for more | 211 | section in the Yocto Project Board Support Package (BSP) Developer's Guide for more |
209 | information on BSP Layers. | 212 | information on BSP Layers. |
210 | <itemizedlist> | 213 | <itemizedlist> |
211 | <listitem><para><emphasis>Tarball Extraction:</emphasis> You can download any released | 214 | <listitem><para><emphasis>Tarball Extraction:</emphasis> You can download any released |
212 | BSP tarball from the same | 215 | BSP tarball from the same |
213 | <ulink url='http://yoctoproject.org/download'>download site</ulink> used | 216 | <ulink url='&YOCTO_HOME_URL;/download'>download site</ulink> used |
214 | to get the Yocto Project release. | 217 | to get the Yocto Project release. |
215 | Once you have the tarball, just extract it into a directory of your choice. | 218 | Once you have the tarball, just extract it into a directory of your choice. |
216 | 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 |
@@ -220,7 +223,7 @@ | |||
220 | to set up the <filename>meta-intel</filename> Git repository. | 223 | to set up the <filename>meta-intel</filename> Git repository. |
221 | 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 |
222 | "Yocto Metadata Layers" area of the Yocto Project Source Repositories at | 225 | "Yocto Metadata Layers" area of the Yocto Project Source Repositories at |
223 | <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink>.</para> | 226 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> |
224 | <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 |
225 | the Yocto Project Files Git repository. | 228 | the Yocto Project Files Git repository. |
226 | For example, the following transcript shows the steps to clone the | 229 | For example, the following transcript shows the steps to clone the |
@@ -237,7 +240,7 @@ | |||
237 | Resolving deltas: 100% (546/546), done. | 240 | Resolving deltas: 100% (546/546), done. |
238 | </literallayout></para> | 241 | </literallayout></para> |
239 | <para>The same | 242 | <para>The same |
240 | <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> | 243 | <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> |
241 | wiki page</ulink> referenced earlier covers how to | 244 | wiki page</ulink> referenced earlier covers how to |
242 | set up the <filename>meta-intel</filename> Git repository.</para></listitem> | 245 | set up the <filename>meta-intel</filename> Git repository.</para></listitem> |
243 | </itemizedlist></para></listitem> | 246 | </itemizedlist></para></listitem> |
@@ -245,7 +248,7 @@ | |||
245 | applications using the Eclipse Integrated Development Environment (IDE), | 248 | applications using the Eclipse Integrated Development Environment (IDE), |
246 | you will need this plug-in. | 249 | you will need this plug-in. |
247 | See the | 250 | See the |
248 | "<ulink url='http://www.yoctoproject.org/docs/latest/adt-manual/adt-manual.html#setting-up-the-eclipse-ide'>Setting up the Eclipse IDE</ulink>" | 251 | "<ulink url='&YOCTO_DOCS_ADT_URL;#setting-up-the-eclipse-ide'>Setting up the Eclipse IDE</ulink>" |
249 | section in the Yocto Application Development Toolkit (ADT) | 252 | section in the Yocto Application Development Toolkit (ADT) |
250 | User’s Guide for more information.</para></listitem> | 253 | User’s Guide for more information.</para></listitem> |
251 | </itemizedlist> | 254 | </itemizedlist> |
@@ -258,7 +261,7 @@ | |||
258 | <para> | 261 | <para> |
259 | The build process creates an entire Linux distribution, including the toolchain, from source. | 262 | The build process creates an entire Linux distribution, including the toolchain, from source. |
260 | For more information on this topic, see the | 263 | For more information on this topic, see the |
261 | "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#building-image'>Building an Image</ulink>" | 264 | "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" |
262 | section in the Yocto Project Quick Start. | 265 | section in the Yocto Project Quick Start. |
263 | </para> | 266 | </para> |
264 | 267 | ||
@@ -275,15 +278,15 @@ | |||
275 | is set up how you want it. | 278 | is set up how you want it. |
276 | This file defines many aspects of the build environment including | 279 | This file defines many aspects of the build environment including |
277 | the target machine architecture through the | 280 | the target machine architecture through the |
278 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-MACHINE'>MACHINE</ulink></filename> variable, | 281 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'>MACHINE</ulink></filename> variable, |
279 | the development machine's processor use through the | 282 | the development machine's processor use through the |
280 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</ulink></filename> and | 283 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</ulink></filename> and |
281 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PARALLEL_MAKE'>PARALLEL_MAKE</ulink></filename> variables, and | 284 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'>PARALLEL_MAKE</ulink></filename> variables, and |
282 | a centralized tarball download directory through the | 285 | a centralized tarball download directory through the |
283 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-DL_DIR'>DL_DIR</ulink></filename> variable.</para></listitem> | 286 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'>DL_DIR</ulink></filename> variable.</para></listitem> |
284 | <listitem><para>Build the image using the <filename>bitbake</filename> command. | 287 | <listitem><para>Build the image using the <filename>bitbake</filename> command. |
285 | If you want information on BitBake, see the user manual at | 288 | If you want information on BitBake, see the user manual at |
286 | <ulink url='http://docs.openembedded.org/bitbake/html'></ulink>.</para></listitem> | 289 | <ulink url='&OE_DOCS_URL;/bitbake/html'></ulink>.</para></listitem> |
287 | <listitem><para>Run the image either on the actual hardware or using the QEMU | 290 | <listitem><para>Run the image either on the actual hardware or using the QEMU |
288 | emulator.</para></listitem> | 291 | emulator.</para></listitem> |
289 | </orderedlist> | 292 | </orderedlist> |
@@ -305,7 +308,7 @@ | |||
305 | 308 | ||
306 | <para> | 309 | <para> |
307 | You can find details on all these steps in the | 310 | You can find details on all these steps in the |
308 | "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#using-pre-built'>Using Pre-Built Binaries and QEMU</ulink>" | 311 | "<ulink url='&YOCTO_DOCS_QS_URL;#using-pre-built'>Using Pre-Built Binaries and QEMU</ulink>" |
309 | section of the Yocto Project Quick Start. | 312 | section of the Yocto Project Quick Start. |
310 | </para> | 313 | </para> |
311 | </section> | 314 | </section> |