summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-10-24 08:42:21 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-11-01 17:09:51 +0000
commit524f1f5bf8fde145834c8b02a8cf6fe5b521ff30 (patch)
tree71b5bdd00a584577e048e4399fd59b665f8669b6 /documentation
parent458cc5cc2142ce0fed4f03b31d7679dbc06e4d19 (diff)
downloadpoky-524f1f5bf8fde145834c8b02a8cf6fe5b521ff30.tar.gz
yocto-project-qs: Updated the "Super User" section for no tarballs
Fixes [YOCTO #5368] Partial fix for this issue. This section had two options for setting up the Source Directory (tarball and cloned repo). I removed the tarball option. Also, I did some routine formatting as well as verified that the example runs on a more recent Linux distro. Previously, the example was confirmed and stated that it ran on 10.04 Ubuntu. Well, this distro is not even in the supported list any longer so I ran it on a 12.04 Ubuntu machine and stated that. (From yocto-docs rev: 1203e083ec8f7ac91bd832a27273ab4afc5aa4c8) 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.xml78
1 files changed, 41 insertions, 37 deletions
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
index 73da290303..250398e63a 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -804,29 +804,23 @@
804 </footnote> 804 </footnote>
805 gives you a minimal description of how to use the Yocto Project to build images 805 gives you a minimal description of how to use the Yocto Project to build images
806 for a BeagleBoard xM starting from scratch. 806 for a BeagleBoard xM starting from scratch.
807 The steps were performed on a 64-bit Ubuntu 10.04 system. 807 The steps were performed on a 64-bit Ubuntu 12.04 system.
808 </para> 808 </para>
809 809
810 <section id='getting-yocto'> 810 <section id='getting-yocto'>
811 <title>Getting the Yocto Project</title> 811 <title>Getting the Yocto Project</title>
812 812
813 <para> 813 <para>
814 Set up your <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> 814 Set up your
815 one of two ways: 815 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
816 <itemizedlist> 816 by using Git to clone the <filename>poky</filename> poky
817 <listitem><para><emphasis>Tarball:</emphasis> 817 repository and then check out the release branch:
818 Use if you want the latest stable release: 818 <literallayout class='monospaced'>
819 <literallayout class='monospaced'> 819 $ cd ~
820 $ wget &YOCTO_RELEASE_DL_URL;/&YOCTO_POKY_TARBALL;
821 $ tar xvjf &YOCTO_POKY_TARBALL;
822 </literallayout></para></listitem>
823 <listitem><para><emphasis>Git Repository:</emphasis>
824 Use if you want to work with cutting edge development content:
825 <literallayout class='monospaced'>
826 $ git clone git://git.yoctoproject.org/poky 820 $ git clone git://git.yoctoproject.org/poky
827 </literallayout></para></listitem> 821 $ cd poky
828 </itemizedlist> 822 $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME;
829 The remainder of the section assumes the Git repository method. 823 </literallayout>
830 </para> 824 </para>
831 </section> 825 </section>
832 826
@@ -835,7 +829,8 @@
835 829
836 <para> 830 <para>
837 You need some packages for everything to work. 831 You need some packages for everything to work.
838 Rather than duplicate them here, look at the "<link linkend='packages'>The Packages</link>" 832 Rather than duplicate them here, look at the
833 "<link linkend='packages'>The Packages</link>"
839 section earlier in this quick start. 834 section earlier in this quick start.
840 </para> 835 </para>
841 </section> 836 </section>
@@ -844,17 +839,18 @@
844 <title>Initializing the Build Environment</title> 839 <title>Initializing the Build Environment</title>
845 840
846 <para> 841 <para>
847 From the parent directory your 842 From the root directory of your
848 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>, 843 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,
849 initialize your environment and provide a meaningful 844 initialize your environment and provide a meaningful
850 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> 845 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
851 name: 846 name:
852 <literallayout class='monospaced'> 847 <literallayout class='monospaced'>
853 $ source poky/&OE_INIT_FILE; mybuilds 848 $ source &OE_INIT_FILE; mybuilds
854 </literallayout> 849 </literallayout>
855 At this point, the <filename>mybuilds</filename> directory has been created for you 850 At this point, the <filename>mybuilds</filename> directory has
856 and it is now your current working directory. 851 been created for you and it is now your current working directory.
857 If you don't provide your own directory name it defaults to <filename>build</filename>, 852 If you don't provide your own directory name,
853 it defaults to <filename>build</filename>,
858 which is inside the Source Directory. 854 which is inside the Source Directory.
859 </para> 855 </para>
860 </section> 856 </section>
@@ -863,18 +859,21 @@
863 <title>Configuring the local.conf File</title> 859 <title>Configuring the local.conf File</title>
864 860
865 <para> 861 <para>
866 Initializing the build environment creates a <filename>conf/local.conf</filename> configuration file 862 Initializing the build environment creates a
863 <filename>conf/local.conf</filename> configuration file
867 in the Build Directory. 864 in the Build Directory.
868 You need to manually edit this file to specify the machine you are building and to optimize 865 You need to manually edit this file to specify the machine you
869 your build time. 866 are building and to optimize your build time.
870 Here are the minimal changes to make: 867 Here are the minimal changes to make:
871 <literallayout class='monospaced'> 868 <literallayout class='monospaced'>
872 BB_NUMBER_THREADS = "8" 869 BB_NUMBER_THREADS = "8"
873 PARALLEL_MAKE = "-j 8" 870 PARALLEL_MAKE = "-j 8"
874 MACHINE ?= "beagleboard" 871 MACHINE ?= "beagleboard"
875 </literallayout> 872 </literallayout>
876 Briefly, set <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink> 873 Briefly, set
877 and <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> to 874 <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink>
875 and
876 <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> to
878 twice your host processor's number of cores. 877 twice your host processor's number of cores.
879 </para> 878 </para>
880 879
@@ -924,9 +923,10 @@
924 <title>Building the Image</title> 923 <title>Building the Image</title>
925 924
926 <para> 925 <para>
927 At this point, you need to select an image to build for the BeagleBoard xM. 926 At this point, you need to select an image to build for the
928 If this is your first build using the Yocto Project, you should try the smallest and simplest 927 BeagleBoard xM.
929 image: 928 If this is your first build using the Yocto Project, you should try
929 the smallest and simplest image:
930 <literallayout class='monospaced'> 930 <literallayout class='monospaced'>
931 $ bitbake core-image-minimal 931 $ bitbake core-image-minimal
932 </literallayout> 932 </literallayout>
@@ -936,15 +936,18 @@
936 <para> 936 <para>
937 Here are some variations on the build process that could be helpful: 937 Here are some variations on the build process that could be helpful:
938 <itemizedlist> 938 <itemizedlist>
939 <listitem><para>Fetch all the necessary sources without starting the build: 939 <listitem><para>Fetch all the necessary sources without starting
940 the build:
940 <literallayout class='monospaced'> 941 <literallayout class='monospaced'>
941 $ bitbake -c fetchall core-image-minimal 942 $ bitbake -c fetchall core-image-minimal
942 </literallayout> 943 </literallayout>
943 This variation guarantees that you have all the sources for that BitBake target 944 This variation guarantees that you have all the sources for
944 should you disconnect from the net and want to do the build later offline. 945 that BitBake target should you disconnect from the net and
945 </para></listitem> 946 want to do the build later offline.</para></listitem>
946 <listitem><para>Specify to continue the build even if BitBake encounters an error. 947 <listitem><para>Specify to continue the build even if BitBake
947 By default, BitBake aborts the build when it encounters an error. 948 encounters an error.
949 By default, BitBake aborts the build when it encounters an
950 error.
948 This command keeps a faulty build going: 951 This command keeps a faulty build going:
949 <literallayout class='monospaced'> 952 <literallayout class='monospaced'>
950 $ bitbake -k core-image-minimal 953 $ bitbake -k core-image-minimal
@@ -953,7 +956,8 @@
953 </para> 956 </para>
954 957
955 <para> 958 <para>
956 Once you have your image, you can take steps to load and boot it on the target hardware. 959 Once you have your image, you can take steps to load and boot it on
960 the target hardware.
957 </para> 961 </para>
958 </section> 962 </section>
959</section> 963</section>