diff options
author | Kristi Rifenbark <kristi.rifenbark@gmail.com> | 2017-07-06 17:10:25 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2017-07-12 00:28:16 +0100 |
commit | 34fc5d0295880873fb5472de61c1bcae67b6f8e6 (patch) | |
tree | 4c0d06dbedcfb37cd038bec1afe97115f28da018 /documentation/yocto-project-qs | |
parent | f49fa46e19135668b372df3a3c7d9adefe4809da (diff) | |
download | poky-34fc5d0295880873fb5472de61c1bcae67b6f8e6.tar.gz |
yocto-project-qs: Updated Welcome and example board
Fixes [YOCTO #11715]
Replaced all instances of MinnowBoard MAX with
MinnowBoard Turbot.
Updated Welcome section to include links to key
sections of quick start.
(From yocto-docs rev: ed55dcd80ef5edddacb2d288e0a6cbe85dccf964)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/yocto-project-qs')
-rw-r--r-- | documentation/yocto-project-qs/yocto-project-qs.xml | 51 |
1 files changed, 35 insertions, 16 deletions
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index ce6eda85c8..0e79199a35 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml | |||
@@ -80,17 +80,33 @@ | |||
80 | basic understanding of what the Yocto Project is and how to use | 80 | basic understanding of what the Yocto Project is and how to use |
81 | some of its core components. | 81 | some of its core components. |
82 | You will also have worked through steps to produce two images: | 82 | You will also have worked through steps to produce two images: |
83 | one that is suitable for emulation and one that boots on actual | 83 | one that runs on the emulator (QEMU) and one that boots on actual |
84 | hardware. | 84 | hardware (i.e. MinnowBoard Turbot). |
85 | The examples highlight the ease with which you can use the | 85 | The examples highlight the ease with which you can use the |
86 | Yocto Project to create images for multiple types of hardware. | 86 | Yocto Project to create images for multiple types of hardware. |
87 | </para> | ||
88 | |||
89 | <para> | ||
90 | The following list directs you to key sections of this | ||
91 | quick start: | ||
92 | <itemizedlist> | ||
93 | <listitem><para> | ||
94 | <ulink url='http://www.yoctoproject.org/docs/2.4/yocto-project-qs/yocto-project-qs.html#yp-resources'>Setting Up to Use the Yocto Project</ulink> | ||
95 | </para></listitem> | ||
96 | <listitem><para> | ||
97 | <ulink url='http://www.yoctoproject.org/docs/2.4/yocto-project-qs/yocto-project-qs.html#building-an-image-for-emulation'>Building an Image for Emulation</ulink> | ||
98 | </para></listitem> | ||
99 | <listitem><para> | ||
100 | <ulink url='http://www.yoctoproject.org/docs/2.4/yocto-project-qs/yocto-project-qs.html#building-an-image-for-hardware'>Building an Image for Hardware</ulink> | ||
101 | </para></listitem> | ||
102 | </itemizedlist> | ||
87 | <note> | 103 | <note> |
88 | If you do not have a system that runs Linux and you want to give | 104 | If you do not have a system that runs Linux and you want to give |
89 | the Yocto Project a test run, you might consider using the Yocto | 105 | the Yocto Project a test run, you might consider using the Yocto |
90 | Project Build Appliance. | 106 | Project Build Appliance. |
91 | The Build Appliance allows you to build and boot a custom embedded | 107 | The Build Appliance allows you to build and boot a custom |
92 | Linux image with the Yocto Project using a non-Linux development | 108 | embedded Linux image with the Yocto Project using a non-Linux |
93 | system. | 109 | development system. |
94 | See the | 110 | See the |
95 | <ulink url='https://www.yoctoproject.org/tools-resources/projects/build-appliance'>Yocto Project Build Appliance</ulink> | 111 | <ulink url='https://www.yoctoproject.org/tools-resources/projects/build-appliance'>Yocto Project Build Appliance</ulink> |
96 | for more information. | 112 | for more information. |
@@ -473,7 +489,7 @@ | |||
473 | create a second image that you can load onto bootable | 489 | create a second image that you can load onto bootable |
474 | media and actually boot target hardware. | 490 | media and actually boot target hardware. |
475 | This example uses the MinnowBoard | 491 | This example uses the MinnowBoard |
476 | MAX-compatible boards. | 492 | Turbot-compatible boards. |
477 | </para></listitem> | 493 | </para></listitem> |
478 | </itemizedlist> | 494 | </itemizedlist> |
479 | <note> | 495 | <note> |
@@ -712,13 +728,13 @@ | |||
712 | <para id='qs-minnowboard-example'> | 728 | <para id='qs-minnowboard-example'> |
713 | The following steps show how easy it is to set up to build an | 729 | The following steps show how easy it is to set up to build an |
714 | image for a new machine. | 730 | image for a new machine. |
715 | These steps build an image for the MinnowBoard MAX, which is | 731 | These steps build an image for the MinnowBoard Turbot, which is |
716 | supported by the Yocto Project and the | 732 | supported by the Yocto Project and the |
717 | <filename>meta-intel</filename> <filename>intel-corei7-64</filename> | 733 | <filename>meta-intel</filename> <filename>intel-corei7-64</filename> |
718 | and <filename>intel-core2-32</filename> Board Support Packages | 734 | and <filename>intel-core2-32</filename> Board Support Packages |
719 | (BSPs). | 735 | (BSPs). |
720 | <note> | 736 | <note> |
721 | The MinnowBoard MAX ships with 64-bit firmware. | 737 | The MinnowBoard Turbot ships with 64-bit firmware. |
722 | If you want to use the board in 32-bit mode, you must | 738 | If you want to use the board in 32-bit mode, you must |
723 | download the | 739 | download the |
724 | <ulink url='http://firmware.intel.com/projects/minnowboard-max'>32-bit firmware</ulink>. | 740 | <ulink url='http://firmware.intel.com/projects/minnowboard-max'>32-bit firmware</ulink>. |
@@ -729,7 +745,8 @@ | |||
729 | <orderedlist> | 745 | <orderedlist> |
730 | <listitem><para><emphasis>Create a Local Copy of the | 746 | <listitem><para><emphasis>Create a Local Copy of the |
731 | <filename>meta-intel</filename> Repository:</emphasis> | 747 | <filename>meta-intel</filename> Repository:</emphasis> |
732 | Building an image for the MinnowBoard MAX requires the | 748 | Building an image for the MinnowBoard Turbot requires |
749 | the | ||
733 | <filename>meta-intel</filename> layer. | 750 | <filename>meta-intel</filename> layer. |
734 | Use the <filename>git clone</filename> command to create | 751 | Use the <filename>git clone</filename> command to create |
735 | a local copy of the repository inside your | 752 | a local copy of the repository inside your |
@@ -758,13 +775,13 @@ | |||
758 | repository by tag, you should use a | 775 | repository by tag, you should use a |
759 | <filename>meta-intel</filename> | 776 | <filename>meta-intel</filename> |
760 | tag that corresponds with the release you used for | 777 | tag that corresponds with the release you used for |
761 | <filename>poky</filename>. Consequently, you need to | 778 | <filename>poky</filename>. |
762 | checkout out the | 779 | Consequently, you need to checkout out the |
763 | "<filename>&METAINTELVERSION;-tbd-&YOCTO_DOC_VERSION;</filename>" | 780 | "<filename>&METAINTELVERSION;-&DISTRO_NAME_NO_CAP;-&YOCTO_DOC_VERSION;</filename>" |
764 | branch after cloning <filename>meta-intel</filename>: | 781 | branch after cloning <filename>meta-intel</filename>: |
765 | <literallayout class='monospaced'> | 782 | <literallayout class='monospaced'> |
766 | $ cd $HOME/poky/meta-intel | 783 | $ cd $HOME/poky/meta-intel |
767 | $ git checkout tags/&METAINTELVERSION;-tbd-&YOCTO_DOC_VERSION; -b meta-intel-&DISTRO_NAME_NO_CAP;-&YOCTO_DOC_VERSION; | 784 | $ git checkout tags/&METAINTELVERSION;-&DISTRO_NAME_NO_CAP;-&YOCTO_DOC_VERSION; -b meta-intel-&DISTRO_NAME_NO_CAP;-&YOCTO_DOC_VERSION; |
768 | Switched to a new branch 'meta-intel-&DISTRO_NAME_NO_CAP;-&YOCTO_DOC_VERSION;' | 785 | Switched to a new branch 'meta-intel-&DISTRO_NAME_NO_CAP;-&YOCTO_DOC_VERSION;' |
769 | </literallayout> | 786 | </literallayout> |
770 | The previous Git <filename>checkout</filename> command | 787 | The previous Git <filename>checkout</filename> command |
@@ -812,13 +829,15 @@ | |||
812 | </para> | 829 | </para> |
813 | </note> | 830 | </note> |
814 | </para></listitem> | 831 | </para></listitem> |
815 | <listitem><para><emphasis>Build an Image for MinnowBoard MAX:</emphasis> | 832 | <listitem><para> |
833 | <emphasis>Build an Image for MinnowBoard | ||
834 | Turbot:</emphasis> | ||
816 | The type of image you build depends on your goals. | 835 | The type of image you build depends on your goals. |
817 | For example, the previous build created a | 836 | For example, the previous build created a |
818 | <filename>core-image-sato</filename> image, which is an | 837 | <filename>core-image-sato</filename> image, which is an |
819 | image with Sato support. | 838 | image with Sato support. |
820 | It is possible to build many image types for the | 839 | It is possible to build many image types for the |
821 | MinnowBoard MAX. | 840 | MinnowBoard Turbot. |
822 | Some possibilities are <filename>core-image-base</filename>, | 841 | Some possibilities are <filename>core-image-base</filename>, |
823 | which is a console-only image. | 842 | which is a console-only image. |
824 | Another choice could be a | 843 | Another choice could be a |
@@ -894,7 +913,7 @@ | |||
894 | </para></listitem> | 913 | </para></listitem> |
895 | <listitem><para><emphasis>Boot the Hardware:</emphasis> | 914 | <listitem><para><emphasis>Boot the Hardware:</emphasis> |
896 | With the boot device provisioned, you can insert the | 915 | With the boot device provisioned, you can insert the |
897 | media into the MinnowBoard MAX and boot the hardware. | 916 | media into the MinnowBoard Turbot and boot the hardware. |
898 | The board should automatically detect the media and boot to | 917 | The board should automatically detect the media and boot to |
899 | the bootloader and subsequently the operating system. | 918 | the bootloader and subsequently the operating system. |
900 | </para> | 919 | </para> |