summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-04-10 21:46:02 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-04-12 11:35:47 (GMT)
commit853c5613acd65ef76996931ca39e55cab11594e1 (patch)
tree736de7d73e747d73ad0b9362d48d4e28c7dfd1d2
parent17c4134ebdbb43b01eced4feddbed6988998a6fa (diff)
downloadpoky-853c5613acd65ef76996931ca39e55cab11594e1.tar.gz
documentation: Run-through changes for 1.2
Reading through the manual I discovered some inconsistencies with how links were handled. I fixed this in both the QS and one anchor in the FAQ appendix of the YP Reference Manual. (From yocto-docs rev: 32444e839a1541ab2c02fa31cd094605d1a2429a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/poky-ref-manual/faq.xml2
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml37
2 files changed, 17 insertions, 22 deletions
diff --git a/documentation/poky-ref-manual/faq.xml b/documentation/poky-ref-manual/faq.xml
index 249a28d..e0dbb1d 100644
--- a/documentation/poky-ref-manual/faq.xml
+++ b/documentation/poky-ref-manual/faq.xml
@@ -493,7 +493,7 @@
493 <qandaentry> 493 <qandaentry>
494 <question> 494 <question>
495 <para id='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'> 495 <para id='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>
496 How does the Yocto Project obtain source code and will it work behind my 496 How does the Yocto Project build system obtain source code and will it work behind my
497 firewall or proxy server? 497 firewall or proxy server?
498 </para> 498 </para>
499 </question> 499 </question>
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
index 9ab11a5..96610f4 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -294,9 +294,7 @@
294 Doing so allows you to contribute back to the project. 294 Doing so allows you to contribute back to the project.
295 For information on how to get set up using this method, see the 295 For information on how to get set up using this method, see the
296 "<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto 296 "<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto
297 Project Release</ulink>" item in 297 Project Release</ulink>" item in The Yocto Project Development Manual.
298 <ulink url='&YOCTO_DOCS_DEV_URL;'>The Yocto Project
299 Development Manual</ulink>.
300 </para> 298 </para>
301 </section> 299 </section>
302</section> 300</section>
@@ -351,9 +349,9 @@
351 By default, the Yocto Project searches for source code using a pre-determined order 349 By default, the Yocto Project searches for source code using a pre-determined order
352 through a set of locations. 350 through a set of locations.
353 If you encounter problems with the Yocto Project finding and downloading source code, see 351 If you encounter problems with the Yocto Project finding and downloading source code, see
354 the FAQ entry "How does Poky obtain source code and will it work behind my 352 the FAQ entry "How does the Yocto Project build system obtain source code and will it work behind my
355 firewall or proxy server?" in 353 firewall or proxy server?" in
356 <ulink url='&YOCTO_DOCS_REF_URL;'> 354 <ulink url='&YOCTO_DOCS_REF_URL;#faq'>
357 The Yocto Project Reference Manual</ulink>. 355 The Yocto Project Reference Manual</ulink>.
358 </para></note> 356 </para></note>
359 357
@@ -361,14 +359,14 @@
361 <literallayout class='monospaced'> 359 <literallayout class='monospaced'>
362 $ wget &YOCTO_POKY_DL_URL; 360 $ wget &YOCTO_POKY_DL_URL;
363 $ tar xjf &YOCTO_POKY;.tar.bz2 361 $ tar xjf &YOCTO_POKY;.tar.bz2
364 $ source &OE_INIT_PATH; edison-6.0-build 362 $ source &OE_INIT_PATH; &YOCTO_POKY;-build
365 </literallayout> 363 </literallayout>
366 </para> 364 </para>
367 365
368 <tip><para> 366 <tip><para>
369 To help conserve disk space during builds, you can add the following statement 367 To help conserve disk space during builds, you can add the following statement
370 to your project's configuration file, which for this example 368 to your project's configuration file, which for this example
371 is <filename>edison-6.0-build/conf/local.conf</filename>. 369 is <filename>&YOCTO_POKY;-build/conf/local.conf</filename>.
372 Adding this statement deletes the work directory used for building a package 370 Adding this statement deletes the work directory used for building a package
373 once the package is built. 371 once the package is built.
374 <literallayout class='monospaced'> 372 <literallayout class='monospaced'>
@@ -384,13 +382,13 @@
384 <ulink url='&YOCTO_HOME_URL;/download'>Yocto Project website</ulink> 382 <ulink url='&YOCTO_HOME_URL;/download'>Yocto Project website</ulink>
385 Downloads page to retrieve the tarball.</para></listitem> 383 Downloads page to retrieve the tarball.</para></listitem>
386 <listitem><para>The second command extracts the files from the tarball and places 384 <listitem><para>The second command extracts the files from the tarball and places
387 them into a directory named <filename>poky-edison-6.0</filename> in the current 385 them into a directory named <filename>&YOCTO_POKY;</filename> in the current
388 directory.</para></listitem> 386 directory.</para></listitem>
389 <listitem><para>The third command runs the Yocto Project environment setup script. 387 <listitem><para>The third command runs the Yocto Project environment setup script.
390 Running this script defines Yocto Project build environment settings needed to 388 Running this script defines Yocto Project build environment settings needed to
391 complete the build. 389 complete the build.
392 The script also creates the Yocto Project 390 The script also creates the Yocto Project
393 build directory, which is <filename>edison-6.0-build</filename> in this case. 391 build directory, which is <filename>&YOCTO_POKY;-build</filename> in this case.
394 After the script runs, your current working directory is set 392 After the script runs, your current working directory is set
395 to the build directory. 393 to the build directory.
396 Later, when the build completes, the build directory contains all the files 394 Later, when the build completes, the build directory contains all the files
@@ -430,9 +428,8 @@
430 You can control this configuration by using the 428 You can control this configuration by using the
431 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink></filename> variable. 429 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink></filename> variable.
432 For additional package manager selection information, see 430 For additional package manager selection information, see
433 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'>Packaging - <filename>package*.bbclass</filename></ulink>" in 431 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'>Packaging - <filename>package*.bbclass</filename></ulink>"
434 <ulink url='&YOCTO_DOCS_REF_URL;'> 432 in The Yocto Project Reference Manual.
435 The Yocto Project Reference Manual</ulink>.
436 </para> 433 </para>
437 434
438 <para> 435 <para>
@@ -441,15 +438,15 @@
441 For information on the <filename>-k</filename> option use the 438 For information on the <filename>-k</filename> option use the
442 <filename>bitbake --help</filename> command or see the 439 <filename>bitbake --help</filename> command or see the
443 "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>" section in 440 "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>" section in
444 <ulink url='&YOCTO_DOCS_REF_URL;'>The Yocto Project Reference Manual</ulink>. 441 The Yocto Project Reference Manual.
445 <literallayout class='monospaced'> 442 <literallayout class='monospaced'>
446 $ bitbake -k core-image-sato 443 $ bitbake -k core-image-sato
447 </literallayout> 444 </literallayout>
448 <note><para> 445 <note><para>
449 BitBake requires Python 2.6 or 2.7. For more information on this requirement, 446 BitBake requires Python 2.6 or 2.7. For more information on this requirement,
450 see the FAQ appendix in 447 see the
451 <ulink url='&YOCTO_DOCS_REF_URL;'> 448 <ulink url='&YOCTO_DOCS_REF_URL;#faq'>FAQ</ulink> in The Yocto Project Reference
452 The Yocto Project Reference Manual</ulink>. 449 Manual.
453 </para></note> 450 </para></note>
454 The final command runs the image: 451 The final command runs the image:
455 <literallayout class='monospaced'> 452 <literallayout class='monospaced'>
@@ -550,9 +547,8 @@
550 <para> 547 <para>
551 For more information on how to install tarballs, see the 548 For more information on how to install tarballs, see the
552 "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" and 549 "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" and
553 "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using BitBake and the Yocto Project Build Tree</ulink>" sections in 550 "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using BitBake and the Yocto Project Build Tree</ulink>" sections in The Yocto Project Application Development Toolkit (ADT)
554 <ulink url='&YOCTO_DOCS_ADT_URL;'>The Yocto Project 551 User's Guide.
555 Application Development Toolkit (ADT) User's Guide</ulink>.
556 </para> 552 </para>
557 </section> 553 </section>
558 554
@@ -583,8 +579,7 @@
583 <para> 579 <para>
584 You can learn more about downloading a Yocto Project kernel in the 580 You can learn more about downloading a Yocto Project kernel in the
585 "<ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Linux Yocto Kernel</ulink>" section of 581 "<ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Linux Yocto Kernel</ulink>" section of
586 <ulink url='&YOCTO_DOCS_DEV_URL;'>The 582 The Yocto Project Development Manual.
587 Yocto Project Development Manual</ulink>.
588 </para> 583 </para>
589 </section> 584 </section>
590 585