summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-03-13 15:26:41 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-03-25 12:29:38 +0000
commit4741bb0c1c382ed0982ed82f420f2a3debf27487 (patch)
tree3d3b38ecd59bc267a9fa4ed8130ff8b3f8ed448f
parent35e026504e5ab757623c63d8e9a85343eb981868 (diff)
downloadpoky-4741bb0c1c382ed0982ed82f420f2a3debf27487.tar.gz
yocto-project-qs, poky.ent: Misc fixes in the Quick Start:
I did the following to the yocto-project-qs.xml file: * I integrated some cross-referencing to the BitBake User Manual in a few spots. * I fixed a few grammar items. * I also noted the super user system uses four cores. I did the following to poky.ent: * Added a new variable for links into the BitBake User Manual. Variable is YOCTO_DOCS_BB_URL. (From yocto-docs rev: 3eba14c0dc9e71dfcf967d76e4525b26ac02c9c2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/poky.ent1
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml42
2 files changed, 28 insertions, 15 deletions
diff --git a/documentation/poky.ent b/documentation/poky.ent
index 1ae0617d71..1cc9fab6b9 100644
--- a/documentation/poky.ent
+++ b/documentation/poky.ent
@@ -50,6 +50,7 @@
50<!ENTITY YOCTO_DOCS_KERNEL_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/kernel-manual/kernel-manual.html"> 50<!ENTITY YOCTO_DOCS_KERNEL_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/kernel-manual/kernel-manual.html">
51<!ENTITY YOCTO_DOCS_KERNEL_DEV_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/kernel-dev/kernel-dev.html"> 51<!ENTITY YOCTO_DOCS_KERNEL_DEV_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/kernel-dev/kernel-dev.html">
52<!ENTITY YOCTO_DOCS_PROF_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/profile-manual/profile-manual.html"> 52<!ENTITY YOCTO_DOCS_PROF_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/profile-manual/profile-manual.html">
53<!ENTITY YOCTO_DOCS_BB_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/user-manual/user-manual.html">
53<!ENTITY YOCTO_ADTPATH_DIR "/opt/poky/&DISTRO;"> 54<!ENTITY YOCTO_ADTPATH_DIR "/opt/poky/&DISTRO;">
54<!ENTITY YOCTO_POKY_TARBALL "&YOCTO_POKY;.tar.bz2"> 55<!ENTITY YOCTO_POKY_TARBALL "&YOCTO_POKY;.tar.bz2">
55<!ENTITY OE_INIT_PATH "&YOCTO_POKY;/oe-init-build-env"> 56<!ENTITY OE_INIT_PATH "&YOCTO_POKY;/oe-init-build-env">
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
index 77292d676b..e99a63726a 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -518,9 +518,11 @@
518 Continue with the following command to build an OS image for the target, which is 518 Continue with the following command to build an OS image for the target, which is
519 <filename>core-image-sato</filename> in this example. 519 <filename>core-image-sato</filename> in this example.
520 For information on the <filename>-k</filename> option use the 520 For information on the <filename>-k</filename> option use the
521 <filename>bitbake --help</filename> command or see the 521 <filename>bitbake --help</filename> command, see the
522 "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>" section in 522 "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>"
523 the Yocto Project Reference Manual. 523 section in the Yocto Project Reference Manual, or see the
524 "<ulink url='&YOCTO_DOCS_BB_URL;#user-manual-command'>BitBake Command</ulink>"
525 section in the BitBake User Manual.
524 <literallayout class='monospaced'> 526 <literallayout class='monospaced'>
525 $ bitbake -k core-image-sato 527 $ bitbake -k core-image-sato
526 </literallayout> 528 </literallayout>
@@ -534,12 +536,16 @@
534 <literallayout class='monospaced'> 536 <literallayout class='monospaced'>
535 $ runqemu qemux86 537 $ runqemu qemux86
536 </literallayout> 538 </literallayout>
537 <note><para> 539 <note>
538 Depending on the number of processors and cores, the amount or RAM, the speed of your 540 <para>
539 Internet connection and other factors, the build process could take several hours the first 541 Depending on the number of processors and cores, the amount
540 time you run it. 542 of RAM, the speed of your Internet connection and other
541 Subsequent builds run much faster since parts of the build are cached. 543 factors, the build process could take several hours the
542 </para></note> 544 first time you run it.
545 Subsequent builds run much faster since parts of the build
546 are cached.
547 </para>
548 </note>
543 </para> 549 </para>
544 </section> 550 </section>
545 551
@@ -598,7 +604,7 @@
598 The names of the tarball installer scripts are such that a 604 The names of the tarball installer scripts are such that a
599 string representing the host system appears first in the 605 string representing the host system appears first in the
600 filename and then is immediately followed by a string 606 filename and then is immediately followed by a string
601 that represents the target architecture. 607 representing the target architecture.
602 </para> 608 </para>
603 609
604 <literallayout class='monospaced'> 610 <literallayout class='monospaced'>
@@ -813,9 +819,10 @@
813 pages. 819 pages.
814 </para> 820 </para>
815 </footnote> 821 </footnote>
816 gives you a minimal description of how to use the Yocto Project to build images 822 gives you a minimal description of how to use the Yocto Project to build
817 for a BeagleBoard xM starting from scratch. 823 images for a BeagleBoard xM starting from scratch.
818 The steps were performed on a 64-bit Ubuntu 12.04 system. 824 The steps were performed on a 64-bit Ubuntu 12.04 system that
825 has four cores.
819 </para> 826 </para>
820 827
821 <section id='getting-yocto'> 828 <section id='getting-yocto'>
@@ -824,7 +831,7 @@
824 <para> 831 <para>
825 Set up your 832 Set up your
826 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> 833 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
827 by using Git to clone the <filename>poky</filename> poky 834 by using Git to clone the <filename>poky</filename>
828 repository and then check out the release branch: 835 repository and then check out the release branch:
829 <literallayout class='monospaced'> 836 <literallayout class='monospaced'>
830 $ cd ~ 837 $ cd ~
@@ -860,7 +867,7 @@
860 </literallayout> 867 </literallayout>
861 At this point, the <filename>mybuilds</filename> directory has 868 At this point, the <filename>mybuilds</filename> directory has
862 been created for you and it is now your current working directory. 869 been created for you and it is now your current working directory.
863 If you don't provide your own directory name, 870 If you do not provide your own directory name,
864 it defaults to <filename>build</filename>, 871 it defaults to <filename>build</filename>,
865 which is inside the Source Directory. 872 which is inside the Source Directory.
866 </para> 873 </para>
@@ -970,6 +977,11 @@
970 Once you have your image, you can take steps to load and boot it on 977 Once you have your image, you can take steps to load and boot it on
971 the target hardware. 978 the target hardware.
972 </para> 979 </para>
980
981 <para>
982 You can learn about BitBake in general by reading the
983 <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual</ulink>.
984 </para>
973 </section> 985 </section>
974</section> 986</section>
975 987