diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-08-19 10:22:48 +0300 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-09-22 13:04:42 +0100 |
commit | c7dffc7af14a46180c9e79fc8091eac8d9831952 (patch) | |
tree | 1fa4fe33e3b37fea00a4ceb632ccb6707f694936 /documentation/yocto-project-qs/yocto-project-qs.xml | |
parent | b4c03a7c2863d4943bfd8e50328b08f68d9a7d8e (diff) | |
download | poky-c7dffc7af14a46180c9e79fc8091eac8d9831952.tar.gz |
yocto-project-qs: Minor edits from a read-thru
* Added some text associated with the screencast we link to that
calls out the fact that the screencast is somewhat dated but
still useful.
* Replaced all user input in examples so that they are formatted
using the <replaceable></replaceable> tags.
* Fixed a few places so that they use better and clearer wording.
(From yocto-docs rev: f99536a7581ef9b8b57a446b65e4ebb902b4e4b1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/yocto-project-qs/yocto-project-qs.xml')
-rw-r--r-- | documentation/yocto-project-qs/yocto-project-qs.xml | 59 |
1 files changed, 31 insertions, 28 deletions
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index 333ccc4727..7a083bc064 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml | |||
@@ -86,10 +86,12 @@ | |||
86 | the Yocto Project Reference Manual. | 86 | the Yocto Project Reference Manual. |
87 | </para></listitem> | 87 | </para></listitem> |
88 | <listitem><para><emphasis>Developer Screencast:</emphasis> The | 88 | <listitem><para><emphasis>Developer Screencast:</emphasis> The |
89 | <ulink url='http://vimeo.com/36450321'>Getting Started with the Yocto Project - New | 89 | <ulink url='http://vimeo.com/36450321'>Getting Started with the Yocto Project - New Developer Screencast Tutorial</ulink> |
90 | Developer Screencast Tutorial</ulink> provides a 30-minute video | 90 | provides a 30-minute video created for users unfamiliar with |
91 | created for users unfamiliar with the Yocto Project but familiar | 91 | the Yocto Project but familiar with Linux build systems. |
92 | with Linux build systems.</para></listitem> | 92 | While this screencast is somewhat dated, the introductory |
93 | and fundamental concepts are useful for the beginner. | ||
94 | </para></listitem> | ||
93 | </itemizedlist> | 95 | </itemizedlist> |
94 | </para> | 96 | </para> |
95 | </section> | 97 | </section> |
@@ -177,7 +179,8 @@ | |||
177 | decrease the time needed to build images. | 179 | decrease the time needed to build images. |
178 | </para></listitem> | 180 | </para></listitem> |
179 | <listitem><para> | 181 | <listitem><para> |
180 | The right packages. | 182 | Appropriate packages installed on the system you are using for |
183 | builds. | ||
181 | </para></listitem> | 184 | </para></listitem> |
182 | <listitem><para> | 185 | <listitem><para> |
183 | A release of the Yocto Project. | 186 | A release of the Yocto Project. |
@@ -509,7 +512,7 @@ | |||
509 | Another couple of variables of interest are the | 512 | Another couple of variables of interest are the |
510 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink> and the | 513 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink> and the |
511 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> variables. | 514 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> variables. |
512 | By default, these variables are set to how ever many processor | 515 | By default, these variables are set to the number of processor |
513 | cores your build host uses. | 516 | cores your build host uses. |
514 | However, if your build host uses multiple processor cores, | 517 | However, if your build host uses multiple processor cores, |
515 | you should increase these settings to twice the number of | 518 | you should increase these settings to twice the number of |
@@ -546,7 +549,7 @@ | |||
546 | "<ulink url='&YOCTO_DOCS_REF_URL;#required-git-tar-and-python-versions'>Required Git, tar, and Python</ulink>" | 549 | "<ulink url='&YOCTO_DOCS_REF_URL;#required-git-tar-and-python-versions'>Required Git, tar, and Python</ulink>" |
547 | section in the Yocto Project Reference Manual. | 550 | section in the Yocto Project Reference Manual. |
548 | </note> | 551 | </note> |
549 | The final command runs the image: | 552 | The final command runs the image using the QEMU emulator: |
550 | <literallayout class='monospaced'> | 553 | <literallayout class='monospaced'> |
551 | $ runqemu qemux86 | 554 | $ runqemu qemux86 |
552 | </literallayout> | 555 | </literallayout> |
@@ -622,25 +625,25 @@ | |||
622 | </para> | 625 | </para> |
623 | 626 | ||
624 | <literallayout class='monospaced'> | 627 | <literallayout class='monospaced'> |
625 | poky-eglibc-<<emphasis>host_system</emphasis>>-<<emphasis>image_type</emphasis>>-<<emphasis>arch</emphasis>>-toolchain-<<emphasis>release_version</emphasis>>.sh | 628 | poky-eglibc-<replaceable>host_system</replaceable>-<replaceable>image_type</replaceable>-<replaceable>arch</replaceable>-toolchain-<replaceable>release_version</replaceable>.sh |
626 | 629 | ||
627 | Where: | 630 | Where: |
628 | <<emphasis>host_system</emphasis>> is a string representing your development system: | 631 | <replaceable>host_system</replaceable> is a string representing your development system: |
629 | 632 | ||
630 | i686 or x86_64. | 633 | i686 or x86_64. |
631 | 634 | ||
632 | <<emphasis>image_type</emphasis>> is a string representing the image you wish to | 635 | <replaceable>image_type</replaceable> is a string representing the image you wish to |
633 | develop a Software Development Toolkit (SDK) for use against. | 636 | develop a Software Development Toolkit (SDK) for use against. |
634 | The Yocto Project builds toolchain installers using the | 637 | The Yocto Project builds toolchain installers using the |
635 | following BitBake command: | 638 | following BitBake command: |
636 | 639 | ||
637 | bitbake core-image-sato -c populate_sdk | 640 | bitbake core-image-sato -c populate_sdk |
638 | 641 | ||
639 | <<emphasis>arch</emphasis>> is a string representing the tuned target architecture: | 642 | <replaceable>arch</replaceable> is a string representing the tuned target architecture: |
640 | 643 | ||
641 | i586, x86_64, powerpc, mips, armv7a or armv5te | 644 | i586, x86_64, powerpc, mips, armv7a or armv5te |
642 | 645 | ||
643 | <<emphasis>release_version</emphasis>> is a string representing the release number of the | 646 | <replaceable>release_version</replaceable> is a string representing the release number of the |
644 | Yocto Project: | 647 | Yocto Project: |
645 | 648 | ||
646 | &DISTRO;, &DISTRO;+snapshot | 649 | &DISTRO;, &DISTRO;+snapshot |
@@ -706,11 +709,11 @@ | |||
706 | <para> | 709 | <para> |
707 | Most kernel files have one of the following forms: | 710 | Most kernel files have one of the following forms: |
708 | <literallayout class='monospaced'> | 711 | <literallayout class='monospaced'> |
709 | *zImage-qemu<<emphasis>arch</emphasis>>.bin | 712 | *zImage-qemu<replaceable>arch</replaceable>.bin |
710 | vmlinux-qemu<<emphasis>arch</emphasis>>.bin | 713 | vmlinux-qemu<replaceable>arch</replaceable>.bin |
711 | 714 | ||
712 | Where: | 715 | Where: |
713 | <<emphasis>arch</emphasis>> is a string representing the target architecture: | 716 | <replaceable>arch</replaceable> is a string representing the target architecture: |
714 | x86, x86-64, ppc, mips, or arm. | 717 | x86, x86-64, ppc, mips, or arm. |
715 | </literallayout> | 718 | </literallayout> |
716 | </para> | 719 | </para> |
@@ -740,17 +743,17 @@ | |||
740 | The <filename>tar</filename> form can be flattened out in your host development system | 743 | The <filename>tar</filename> form can be flattened out in your host development system |
741 | and used for build purposes with the Yocto Project. | 744 | and used for build purposes with the Yocto Project. |
742 | <literallayout class='monospaced'> | 745 | <literallayout class='monospaced'> |
743 | core-image-<<emphasis>profile</emphasis>>-qemu<<emphasis>arch</emphasis>>.ext3 | 746 | core-image-<replaceable>profile</replaceable>-qemu<replaceable>arch</replaceable>.ext3 |
744 | core-image-<<emphasis>profile</emphasis>>-qemu<<emphasis>arch</emphasis>>.tar.bz2 | 747 | core-image-<replaceable>profile</replaceable>-qemu<replaceable>arch</replaceable>.tar.bz2 |
745 | 748 | ||
746 | Where: | 749 | Where: |
747 | <<emphasis>profile</emphasis>> is the filesystem image's profile: | 750 | <replaceable>profile</replaceable> is the filesystem image's profile: |
748 | lsb, lsb-dev, lsb-sdk, lsb-qt3, minimal, minimal-dev, sato, | 751 | lsb, lsb-dev, lsb-sdk, lsb-qt3, minimal, minimal-dev, sato, |
749 | sato-dev, or sato-sdk. For information on these types of image | 752 | sato-dev, or sato-sdk. For information on these types of image |
750 | profiles, see the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in the Yocto Project | 753 | profiles, see the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" |
751 | Reference Manual. | 754 | chapter in the Yocto Project Reference Manual. |
752 | 755 | ||
753 | <<emphasis>arch</emphasis>> is a string representing the target architecture: | 756 | <replaceable>arch</replaceable> is a string representing the target architecture: |
754 | x86, x86-64, ppc, mips, or arm. | 757 | x86, x86-64, ppc, mips, or arm. |
755 | </literallayout> | 758 | </literallayout> |
756 | </para> | 759 | </para> |
@@ -763,13 +766,13 @@ | |||
763 | Before you start the QEMU emulator, you need to set up the emulation environment. | 766 | Before you start the QEMU emulator, you need to set up the emulation environment. |
764 | The following command form sets up the emulation environment. | 767 | The following command form sets up the emulation environment. |
765 | <literallayout class='monospaced'> | 768 | <literallayout class='monospaced'> |
766 | $ source &YOCTO_ADTPATH_DIR;/environment-setup-<<emphasis>arch</emphasis>>-poky-linux-<<emphasis>if</emphasis>> | 769 | $ source &YOCTO_ADTPATH_DIR;/environment-setup-<replaceable>arch</replaceable>-poky-linux-<replaceable>if</replaceable> |
767 | 770 | ||
768 | Where: | 771 | Where: |
769 | <<emphasis>arch</emphasis>> is a string representing the target architecture: | 772 | <replaceable>arch</replaceable> is a string representing the target architecture: |
770 | i586, x86_64, ppc603e, mips, or armv5te. | 773 | i586, x86_64, ppc603e, mips, or armv5te. |
771 | 774 | ||
772 | <<emphasis>if</emphasis>> is a string representing an embedded application binary interface. | 775 | <replaceable>if</replaceable> is a string representing an embedded application binary interface. |
773 | Not all setup scripts include this string. | 776 | Not all setup scripts include this string. |
774 | </literallayout> | 777 | </literallayout> |
775 | </para> | 778 | </para> |
@@ -777,15 +780,15 @@ | |||
777 | <para> | 780 | <para> |
778 | Finally, this command form invokes the QEMU emulator | 781 | Finally, this command form invokes the QEMU emulator |
779 | <literallayout class='monospaced'> | 782 | <literallayout class='monospaced'> |
780 | $ runqemu <<emphasis>qemuarch</emphasis>> <<emphasis>kernel-image</emphasis>> <<emphasis>filesystem-image</emphasis>> | 783 | $ runqemu <replaceable>qemuarch</replaceable> <replaceable>kernel-image</replaceable> <replaceable>filesystem-image</replaceable> |
781 | 784 | ||
782 | Where: | 785 | Where: |
783 | <<emphasis>qemuarch</emphasis>> is a string representing the target architecture: qemux86, qemux86-64, | 786 | <replaceable>qemuarch</replaceable> is a string representing the target architecture: qemux86, qemux86-64, |
784 | qemuppc, qemumips, or qemuarm. | 787 | qemuppc, qemumips, or qemuarm. |
785 | 788 | ||
786 | <<emphasis>kernel-image</emphasis>> is the architecture-specific kernel image. | 789 | <replaceable>kernel-image</replaceable> is the architecture-specific kernel image. |
787 | 790 | ||
788 | <<emphasis>filesystem-image</emphasis>> is the .ext3 filesystem image. | 791 | <replaceable>filesystem-image</replaceable> is the .ext3 filesystem image. |
789 | 792 | ||
790 | </literallayout> | 793 | </literallayout> |
791 | </para> | 794 | </para> |