diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-03-13 14:52:34 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-03-25 12:29:38 +0000 |
commit | 35e026504e5ab757623c63d8e9a85343eb981868 (patch) | |
tree | 2eb4ac09e4ccf707531dfcdac162dce71762e89f /documentation | |
parent | 65cef19e8a81e1dcd1336403c11f1fb9771a42e1 (diff) | |
download | poky-35e026504e5ab757623c63d8e9a85343eb981868.tar.gz |
yocto-project-qs: Added recommendation for cloning YP bits.
I re-cast the section where we describe getting a copy of of the
Yocto Project such that we recommend cloning poky now.
Aside from this change, I found some other minor tweaks that needing
fixing.
(From yocto-docs rev: f10fc4afabddce8bd6296e83c4fecbbbd4683140)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/yocto-project-qs/yocto-project-qs.xml | 87 |
1 files changed, 51 insertions, 36 deletions
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index 8752aedcd5..77292d676b 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml | |||
@@ -159,7 +159,8 @@ | |||
159 | <title>What You Need and How You Get It</title> | 159 | <title>What You Need and How You Get It</title> |
160 | 160 | ||
161 | <para> | 161 | <para> |
162 | You need these things to develop in the Yocto Project environment: | 162 | You need these things to develop projects in the Yocto Project |
163 | environment: | ||
163 | </para> | 164 | </para> |
164 | 165 | ||
165 | <itemizedlist> | 166 | <itemizedlist> |
@@ -210,8 +211,8 @@ | |||
210 | <listitem><para>Python 2.7.3 or greater excluding Python | 211 | <listitem><para>Python 2.7.3 or greater excluding Python |
211 | 3.x, which is not supported.</para></listitem> | 212 | 3.x, which is not supported.</para></listitem> |
212 | </itemizedlist> | 213 | </itemizedlist> |
213 | Earlier releases of Python are known to not work and the system | 214 | Earlier releases of Python are known to not work and the |
214 | does not support Python 3 at this time. | 215 | system does not support Python 3 at this time. |
215 | If your system does not meet any of these three listed | 216 | If your system does not meet any of these three listed |
216 | version requirements, you can | 217 | version requirements, you can |
217 | take steps to prepare the system so that you can still use the build | 218 | take steps to prepare the system so that you can still use the build |
@@ -331,26 +332,30 @@ | |||
331 | <title>Yocto Project Release</title> | 332 | <title>Yocto Project Release</title> |
332 | 333 | ||
333 | <para> | 334 | <para> |
334 | You can download the latest Yocto Project release by going to the | 335 | It is recommended that you get the latest Yocto Project files |
335 | <ulink url="&YOCTO_HOME_URL;">Yocto Project website</ulink> | 336 | by setting up (cloning in |
336 | clicking "Downloads" in the navigation pane to the left to view all | 337 | <ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> terms) a local |
337 | available Yocto Project releases. | 338 | copy of the |
338 | Current and archived releases are available for download to the | 339 | <filename>poky</filename> Git repository on your host development |
339 | right. | ||
340 | Nightly and developmental builds are also maintained at | ||
341 | <ulink url="&YOCTO_AB_NIGHTLY_URL;"></ulink>. | ||
342 | However, for this document a released version of Yocto Project is used. | ||
343 | </para> | ||
344 | |||
345 | <para> | ||
346 | You can also get the Yocto Project files you need by setting up (cloning in Git terms) | ||
347 | a local copy of the <filename>poky</filename> Git repository on your host development | ||
348 | system. | 340 | system. |
349 | Doing so allows you to contribute back to the Yocto Project project. | 341 | Doing so allows you to contribute back to the Yocto Project project. |
350 | For information on how to get set up using this method, see the | 342 | For information on how to get set up using this method, see the |
351 | "<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto | 343 | "<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto |
352 | Project Release</ulink>" item in the Yocto Project Development Manual. | 344 | Project Release</ulink>" item in the Yocto Project Development Manual. |
353 | </para> | 345 | </para> |
346 | |||
347 | <para> | ||
348 | You can also get the Yocto Project Files by downloading | ||
349 | Yocto Project releases from the | ||
350 | <ulink url="&YOCTO_HOME_URL;">Yocto Project website</ulink>. | ||
351 | From the website, you just click "Downloads" in the navigation pane | ||
352 | to the left to display all Yocto Project downloads. | ||
353 | Current and archived releases are available for download. | ||
354 | Nightly and developmental builds are also maintained at | ||
355 | <ulink url="&YOCTO_AB_NIGHTLY_URL;"></ulink>. | ||
356 | However, for this document a released version of Yocto Project is used. | ||
357 | </para> | ||
358 | |||
354 | </section> | 359 | </section> |
355 | </section> | 360 | </section> |
356 | 361 | ||
@@ -364,10 +369,14 @@ | |||
364 | 369 | ||
365 | <itemizedlist> | 370 | <itemizedlist> |
366 | <listitem> | 371 | <listitem> |
367 | <para>Build an image and run it in the QEMU emulator</para> | 372 | <para> |
373 | Build an image and run it in the QEMU emulator. | ||
374 | </para> | ||
368 | </listitem> | 375 | </listitem> |
369 | <listitem> | 376 | <listitem> |
370 | <para>Use a pre-built image and run it in the QEMU emulator</para> | 377 | <para> |
378 | Use a pre-built image and run it in the QEMU emulator. | ||
379 | </para> | ||
371 | </listitem> | 380 | </listitem> |
372 | </itemizedlist> | 381 | </itemizedlist> |
373 | 382 | ||
@@ -400,13 +409,16 @@ | |||
400 | recommend having at least 100GB of free disk space. | 409 | recommend having at least 100GB of free disk space. |
401 | </para></note> | 410 | </para></note> |
402 | 411 | ||
403 | <note><para> | 412 | <note> |
404 | By default, the build process searches for source code using a pre-determined order | 413 | <para> |
405 | through a set of locations. | 414 | By default, the build process searches for source code using |
406 | If you encounter problems with the build process finding and downloading source code, see the | 415 | a pre-determined order through a set of locations. |
407 | "<ulink url='&YOCTO_DOCS_REF_URL;#how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>How does the OpenEmbedded build system obtain source code and will it work behind my | 416 | If you encounter problems with the build process finding and |
408 | firewall or proxy server?</ulink>" in the Yocto Project Reference Manual. | 417 | downloading source code, see the |
409 | </para></note> | 418 | "<ulink url='&YOCTO_DOCS_REF_URL;#how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>How does the OpenEmbedded build system obtain source code and will it work behind my firewall or proxy server?</ulink>" |
419 | entry in the Yocto Project Reference Manual FAQ. | ||
420 | </para> | ||
421 | </note> | ||
410 | 422 | ||
411 | <para> | 423 | <para> |
412 | <literallayout class='monospaced'> | 424 | <literallayout class='monospaced'> |
@@ -417,16 +429,19 @@ | |||
417 | </literallayout> | 429 | </literallayout> |
418 | </para> | 430 | </para> |
419 | 431 | ||
420 | <tip><para> | 432 | <tip> |
421 | To help conserve disk space during builds, you can add the following statement | 433 | <para> |
422 | to your project's configuration file, which for this example | 434 | To help conserve disk space during builds, you can add the |
423 | is <filename>&YOCTO_POKY;/build/conf/local.conf</filename>. | 435 | following statement to your project's configuration file, |
424 | Adding this statement deletes the work directory used for building a package | 436 | which for this example is |
425 | once the package is built. | 437 | <filename>poky/build/conf/local.conf</filename>. |
426 | <literallayout class='monospaced'> | 438 | Adding this statement deletes the work directory used for |
439 | building a package once the package is built. | ||
440 | <literallayout class='monospaced'> | ||
427 | INHERIT += "rm_work" | 441 | INHERIT += "rm_work" |
428 | </literallayout> | 442 | </literallayout> |
429 | </para></tip> | 443 | </para> |
444 | </tip> | ||
430 | 445 | ||
431 | <itemizedlist> | 446 | <itemizedlist> |
432 | <listitem><para>In the previous example, the first command uses | 447 | <listitem><para>In the previous example, the first command uses |
@@ -495,7 +510,7 @@ | |||
495 | You can control this configuration by using the | 510 | You can control this configuration by using the |
496 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink></filename> variable. | 511 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink></filename> variable. |
497 | For additional package manager selection information, see the | 512 | For additional package manager selection information, see the |
498 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'>Packaging - <filename>package*.bbclass</filename></ulink>" | 513 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'><filename>package*.bbclass</filename></ulink>" |
499 | section in the Yocto Project Reference Manual. | 514 | section in the Yocto Project Reference Manual. |
500 | </para> | 515 | </para> |
501 | 516 | ||