summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-07-20 08:14:00 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-07-27 23:00:23 +0100
commit38ee8ae87614f790cbdd79137451994c28b69b05 (patch)
tree4692d28d45f9ee84aa191fbac31edb8b486b1a0f /documentation/dev-manual
parentaec9e9b1dc81ac0f0bc9079e32b537734a1372d1 (diff)
downloadpoky-38ee8ae87614f790cbdd79137451994c28b69b05.tar.gz
dev-manual: Added steps to set up native linux host
Fixes [YOCTO #11630] Added content for steps to set up a native Linux host for using the Yocto Project. (From yocto-docs rev: d8a18d382c584dbdfa7f5f190a92cc7cde0f9601) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-start.xml77
1 files changed, 48 insertions, 29 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index e70d79e424..1332a26416 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -20,30 +20,23 @@
20 <para> 20 <para>
21 This section provides procedures to set up your development host to 21 This section provides procedures to set up your development host to
22 use the Yocto Project. 22 use the Yocto Project.
23 For a Linux system to use the Yocto Project, you need to be sure 23 You can use the Yocto Project on a native Linux development host or
24 you are running a supported Linux distribution and have the proper 24 you can use
25 host packages installed. 25 <ulink url='https://git.yoctoproject.org/cgit/cgit.cgi/crops/about/'>CROPS</ulink>,
26 If you are using 26 which leverages
27 <ulink url='https://git.yoctoproject.org/cgit/cgit.cgi/crops/about/'>CROPS</ulink>
28 that leverages
29 <ulink url='https://www.docker.com/'>Docker Containers</ulink>, 27 <ulink url='https://www.docker.com/'>Docker Containers</ulink>,
30 host setup differs from that of a native Linux machine. 28 to prepare any Linux, Mac, or Windows development host.
31 </para> 29 </para>
32 30
33 <section id='setting-up-a-native-linux-host'> 31 <section id='setting-up-a-native-linux-host'>
34 <title>Setting Up a Native Linux Host</title> 32 <title>Setting Up a Native Linux Host</title>
35 33
36 <para role='writernotes'>
37 Need text - Following is some basics for a Linux host system.
38 This information needs to be worked in.
39 </para>
40
41 <para> 34 <para>
42 Setup consists of making sure you have a supported operating system, 35 Follow these steps to prepare a native Linux machine as your
43 installing host packages, and Here is what you need to use the Yocto Project: 36 Yocto Project development host:
44 <itemizedlist> 37 <orderedlist>
45 <listitem><para> 38 <listitem><para>
46 <emphasis>Host System:</emphasis> 39 <emphasis>Use a Supported Linux Distribution:</emphasis>
47 You should have a reasonably current Linux-based host 40 You should have a reasonably current Linux-based host
48 system. 41 system.
49 You will have the best results with a recent release of 42 You will have the best results with a recent release of
@@ -54,25 +47,51 @@
54 status, see the 47 status, see the
55 "<ulink url='&YOCTO_DOCS_REF_URL;#detailed-supported-distros'>Supported Linux Distributions</ulink>" section 48 "<ulink url='&YOCTO_DOCS_REF_URL;#detailed-supported-distros'>Supported Linux Distributions</ulink>" section
56 in the Yocto Project Reference Manual and the wiki page at 49 in the Yocto Project Reference Manual and the wiki page at
57 <ulink url='&YOCTO_WIKI_URL;/wiki/Distribution_Support'>Distribution Support</ulink>.</para> 50 <ulink url='&YOCTO_WIKI_URL;/wiki/Distribution_Support'>Distribution Support</ulink>.
58 <para> 51 </para></listitem>
59 You should also have about 50 Gbytes of free disk space 52 <listitem><para>
53 <emphasis>Have Enough Free Memory:</emphasis>
54 You should have at least 50 Gbytes of free disk space
60 for building images. 55 for building images.
61 </para></listitem> 56 </para></listitem>
62 <listitem><para> 57 <listitem><para>
63 <emphasis>Packages:</emphasis> 58 <emphasis>Meet Minimal Version Requirements:</emphasis>
64 The OpenEmbedded build system requires that certain 59 The OpenEmbedded build system should be able to run on any
65 packages exist on your development system 60 modern distribution that has the following versions for
66 (e.g. Python 2.7). 61 Git, tar, and Python.
62 <itemizedlist>
63 <listitem><para>
64 Git 1.8.3.1 or greater
65 </para></listitem>
66 <listitem><para>
67 tar 1.27 or greater
68 </para></listitem>
69 <listitem><para>
70 Python 3.4.0 or greater.
71 </para></listitem>
72 </itemizedlist>
73 If your build host does not meet any of these three listed
74 version requirements, you can take steps to prepare the
75 system so that you can still use the Yocto Project.
67 See the 76 See the
68 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>Build Host Packages</ulink>" 77 "<ulink url='&YOCTO_DOCS_REF_URL;#required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</ulink>"
69 section in the Yocto Project Quick Start and the 78 section in the Yocto Project Reference Manual for
79 information.
80 </para></listitem>
81 <listitem><para>
82 <emphasis>Install Development Host Packages:</emphasis>
83 Required development host packages vary depending on your
84 build machine and what you want to do with the Yocto
85 Project.
86 Collectively, the number of required packages is large
87 if you want to be able to cover all cases.</para>
88
89 <para>For lists of required packages for all scenarios,
90 see the
70 "<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>" 91 "<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>"
71 section in the Yocto Project Reference Manual for the 92 section in the Yocto Project Reference Manual.
72 exact package requirements and the installation commands
73 to install them for the supported distributions.
74 </para></listitem> 93 </para></listitem>
75 </itemizedlist> 94 </orderedlist>
76 </para> 95 </para>
77 </section> 96 </section>
78 97