diff options
-rw-r--r-- | doc/book-enea-linux-release-info/doc/prerequisites.xml | 26 | ||||
-rw-r--r-- | doc/book-enea-linux-release-info/doc/system_requirements.xml | 162 |
2 files changed, 175 insertions, 13 deletions
diff --git a/doc/book-enea-linux-release-info/doc/prerequisites.xml b/doc/book-enea-linux-release-info/doc/prerequisites.xml index 1d883b1..197a48a 100644 --- a/doc/book-enea-linux-release-info/doc/prerequisites.xml +++ b/doc/book-enea-linux-release-info/doc/prerequisites.xml | |||
@@ -4,9 +4,12 @@ | |||
4 | <chapter id="prerequisites"> | 4 | <chapter id="prerequisites"> |
5 | <title>Prerequisites</title> | 5 | <title>Prerequisites</title> |
6 | 6 | ||
7 | <xi:include href="system_requirements.xml" | ||
8 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
9 | |||
7 | <para>Building Enea Linux or compiling applications requires that your git | 10 | <para>Building Enea Linux or compiling applications requires that your git |
8 | environment be setup properly, and for certain packages to be installed on | 11 | environment be setup properly, and for certain packages to be installed on |
9 | your Linux development host. </para> | 12 | your Linux development host.</para> |
10 | 13 | ||
11 | <para>Please refer to <ulink | 14 | <para>Please refer to <ulink |
12 | url="https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup">Getting | 15 | url="https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup">Getting |
@@ -20,18 +23,15 @@ $ git config --global user.email johndoe@example.com</programlisting> | |||
20 | <section id="inst-host-packages-ubuntu-debian"> | 23 | <section id="inst-host-packages-ubuntu-debian"> |
21 | <title>Ubuntu 14.04 LTS, 64-bit</title> | 24 | <title>Ubuntu 14.04 LTS, 64-bit</title> |
22 | 25 | ||
23 | <para>Ensure the system is up-to-date:</para> | 26 | <para>For the supported distribution(s) you need the following packages: |
24 | 27 | <remark>INFO: The programlisting below is a parameter in | |
25 | <programlisting>$ sudo apt-get update</programlisting> | 28 | eltf_params_updated.xml with ID: "eltf-prereq-apt-get-command-host". If |
26 | 29 | multiple hosts are supported, store the commands for each host in the same | |
27 | <para>For a supported <emphasis role="bold">Ubuntu</emphasis><indexterm> | 30 | programlisting with empty lines between each - the comment with the FULL |
28 | <primary>Ubuntu</primary> | 31 | HOST name and version is essential.</remark></para> |
29 | </indexterm> distribution you need the following packages:</para> | ||
30 | 32 | ||
31 | <programlisting>$ sudo apt-get install sed wget subversion git-core | 33 | <!-- <xi:include href="eltf_params_updated.xml" |
32 | coreutils unzip texi2html texinfo libsdl1.2-dev docbook-utils fop gawk | 34 | xmlns:xi="http://www.w3.org/2001/XInclude" |
33 | python-pysqlite2 diffstat make gcc build-essential xsltproc g++ | 35 | xpointer="element(eltf-prereq-apt-get-commands-host/1)" /> --> |
34 | desktop-file-utils chrpath libgl1-mesa-dev libglu1-mesa-dev autoconf automake | ||
35 | groff libtool xterm libxml-parser-perl</programlisting> | ||
36 | </section> | 36 | </section> |
37 | </chapter> \ No newline at end of file | 37 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-linux-release-info/doc/system_requirements.xml b/doc/book-enea-linux-release-info/doc/system_requirements.xml new file mode 100644 index 0000000..2c14761 --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/system_requirements.xml | |||
@@ -0,0 +1,162 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | ||
4 | <section id="enea-linux-sysreq"> | ||
5 | <title>System Requirements</title> | ||
6 | |||
7 | <para>The host requirements listed below are extensive to allow for the | ||
8 | building of Linux images via the Yocto system and not just | ||
9 | applications.</para> | ||
10 | |||
11 | <para>Please also see the system requirements in the Yocto 2.1 documents: | ||
12 | Yocto Project Start <ulink | ||
13 | url="http://www.yoctoproject.org/docs/2.1/yocto-project-qs/yocto-project-qs.html#yp-resources"> | ||
14 | http://www.yoctoproject.org/docs/2.1/yocto-project-qs/yocto-project-qs.html#yp-resources</ulink> | ||
15 | and the Yocto Project Reference Manual <ulink | ||
16 | url="http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements"> | ||
17 | http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements</ulink>. | ||
18 | If needed, replace the Yocto version in the links provided with a more | ||
19 | recent version.</para> | ||
20 | |||
21 | <informaltable> | ||
22 | <tgroup cols="2"> | ||
23 | <colspec align="left" colname="1" colwidth="1*" /> | ||
24 | |||
25 | <colspec align="left" colname="2" colwidth="3*" /> | ||
26 | |||
27 | <spanspec nameend="2" namest="1" spanname="onetwo" /> | ||
28 | |||
29 | <tbody> | ||
30 | <row> | ||
31 | <entry spanname="onetwo"><emphasis role="bold"> Build host | ||
32 | requirements<indexterm> | ||
33 | <primary>system requirements</primary> | ||
34 | </indexterm></emphasis></entry> | ||
35 | </row> | ||
36 | |||
37 | <row> | ||
38 | <entry>Linux distribution</entry> | ||
39 | |||
40 | <entry>The downloaded code shall be built on a Linux host to | ||
41 | generate images for your target or for emulation in QEMU. For | ||
42 | information about the supported hosts and targets, see the <emphasis | ||
43 | role="bold">Enea Linux Release Information</emphasis> in your Enea | ||
44 | Linux distribution.</entry> | ||
45 | </row> | ||
46 | |||
47 | <row> | ||
48 | <entry>Internet access</entry> | ||
49 | |||
50 | <entry>Internet access must be available when building an image, | ||
51 | since bitbake downloads source files from various servers during the | ||
52 | build.</entry> | ||
53 | </row> | ||
54 | |||
55 | <row> | ||
56 | <entry>Packages</entry> | ||
57 | |||
58 | <entry>Depending on the Linux distribution and version on host, some | ||
59 | packages may be required, by bitbake for example. You will install | ||
60 | any required packages while following the installation | ||
61 | instructions.</entry> | ||
62 | </row> | ||
63 | |||
64 | <row> | ||
65 | <entry>Targets</entry> | ||
66 | |||
67 | <entry>Images can be built or downloaded for any of the targets | ||
68 | supported in this release, as specified in the <emphasis | ||
69 | role="bold">Enea Linux Release Information</emphasis>.</entry> | ||
70 | </row> | ||
71 | |||
72 | <row> | ||
73 | <entry>Disk space</entry> | ||
74 | |||
75 | <entry><para>Your system should have at least 50 GB of free disk | ||
76 | space when bitbaking the basic enea-image-name kernel image.</para> | ||
77 | <para>For larger images and to allow for future package extensions | ||
78 | and variations in the build process, a minimum of 100 GB free disk | ||
79 | space is recommended.</para></entry> | ||
80 | </row> | ||
81 | |||
82 | <row> | ||
83 | <entry>Recommended RAM</entry> | ||
84 | |||
85 | <entry><para>Your system must have at least 4 GB available | ||
86 | RAM.</para> <para>It is recommended to have 8 GB RAM available for | ||
87 | parallel build jobs.</para></entry> | ||
88 | </row> | ||
89 | |||
90 | <row> | ||
91 | <entry>Java</entry> | ||
92 | |||
93 | <entry>Java <indexterm> | ||
94 | <primary>java</primary> | ||
95 | </indexterm>is required to run Eclipse. Currenly, Eclipse | ||
96 | generally recommends at least Java 6 JRE/JDK. More information | ||
97 | regarding operating environments for Eclipse, is provided in the | ||
98 | <emphasis>Eclipse Project Release Notes</emphasis> for the version | ||
99 | used. This can usually be found via | ||
100 | http://www.eclipse.org/eclipse/development/readme_eclipse_version. | ||
101 | See the <emphasis role="bold">Enea Linux Release Information | ||
102 | </emphasis>for the Eclipse Version.</entry> | ||
103 | </row> | ||
104 | </tbody> | ||
105 | </tgroup> | ||
106 | </informaltable> | ||
107 | |||
108 | <para>The build time depends on the capacity of the processor and other | ||
109 | hardware, available resources, speed of internet connection, load situation, | ||
110 | etc. E.g: on a fast 16 core machine with 16 GB RAM and SSD disks, a complete | ||
111 | build from source could take about two hours.</para> | ||
112 | |||
113 | <informaltable> | ||
114 | <tgroup cols="2"> | ||
115 | <colspec align="left" colname="1" colwidth="1*" /> | ||
116 | |||
117 | <colspec align="left" colname="2" colwidth="3*" /> | ||
118 | |||
119 | <spanspec nameend="2" namest="1" spanname="onetwo" /> | ||
120 | |||
121 | <tbody> | ||
122 | <row> | ||
123 | <entry spanname="onetwo"><emphasis role="bold">Target | ||
124 | Requirements</emphasis></entry> | ||
125 | </row> | ||
126 | |||
127 | <row> | ||
128 | <entry>External memory</entry> | ||
129 | |||
130 | <entry>To boot a CGL<indexterm> | ||
131 | <primary>CGL</primary> | ||
132 | </indexterm> image, you need at least 16 GB on a hard-disk | ||
133 | drive<indexterm> | ||
134 | <primary>HDD</primary> | ||
135 | </indexterm> on eSATA, USB drive, or SD card.<remark>INFO: (packed | ||
136 | rootfs 4.5 GB + unpacked rootfs 1.5 GB + good | ||
137 | margins)</remark><remark>INFO: NFS does not support SELinux. In | ||
138 | order to have a security-enhanced Linux, one must take off from an | ||
139 | NFS-booted system and proceed with boot from external | ||
140 | memory.</remark></entry> | ||
141 | </row> | ||
142 | </tbody> | ||
143 | </tgroup> | ||
144 | </informaltable> | ||
145 | |||
146 | <section id="ensure-bash"> | ||
147 | <title>System Shell Configuration</title> | ||
148 | |||
149 | <para>Before installing Enea Linux, ensure that bash is the default | ||
150 | shell.</para> | ||
151 | |||
152 | <para>If your system runs Ubuntu, you can use ls -l to ensure | ||
153 | <filename>/usr/bin</filename> is a symbolic link to bash. In case the link | ||
154 | points to dash, which is default in some Ubuntu versions, change it to | ||
155 | bash by running <emphasis role="bold">sudo dpkg-reconfigure | ||
156 | dash</emphasis> and answer <emphasis role="bold">No</emphasis> to the | ||
157 | question "Use dash as the default system shell (/bin/sh)?":</para> | ||
158 | |||
159 | <programlisting># ls -l /bin/sh | ||
160 | lrwxrwxrwx 1 root root 4 2012-03-02 11:53 /bin/sh -> bash</programlisting> | ||
161 | </section> | ||
162 | </section> \ No newline at end of file | ||