summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiruna Paun <Miruna.Paun@enea.com>2017-08-09 10:47:36 +0200
committerMiruna Paun <Miruna.Paun@enea.com>2017-08-09 10:47:36 +0200
commit82f54ce422e3ae18748cf36c7ee5fc42ba0e915e (patch)
tree5860892ebf2b1d23a4bf25e5525750a71a566124
parent39d58a839782dc8d1f50f5904a5ba982edf2646f (diff)
downloadel_releases-common-82f54ce422e3ae18748cf36c7ee5fc42ba0e915e.tar.gz
Removed parts that don't work/over complicate, relating to nfv access
USERDOCAP-224 Signed-off-by: Miruna Paun <Miruna.Paun@enea.com>
-rw-r--r--doc/book-enea-nfv-access-release-info-eltf/eltf_params_updated.xml165
-rw-r--r--doc/eltf_params_template.xml (renamed from doc/book-enea-nfv-access-release-info-eltf/eltf_params_template.xml)4
-rw-r--r--doc/eltf_params_updated_template_how_to_use.txt (renamed from doc/book-enea-nfv-access-release-info-eltf/eltf_params_updated_template_how_to_use.txt)0
-rw-r--r--doc/system_requirements_prerequisites.xml34
4 files changed, 2 insertions, 201 deletions
diff --git a/doc/book-enea-nfv-access-release-info-eltf/eltf_params_updated.xml b/doc/book-enea-nfv-access-release-info-eltf/eltf_params_updated.xml
deleted file mode 100644
index f6bd068..0000000
--- a/doc/book-enea-nfv-access-release-info-eltf/eltf_params_updated.xml
+++ /dev/null
@@ -1,165 +0,0 @@
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="eltf_created_params">
5 <title>File with Parameters in the Book Auto-updated by ELFT</title>
6
7 <note>
8 <para>See the <emphasis
9 role="bold">eltf_params_updated_template_howto_use.txt</emphasis> text
10 file for description of how to create the final <emphasis
11 role="bold">eltf_params_updated.xml</emphasis> from this template and for
12 all <emphasis role="bold">REQUIREMENTS</emphasis>. Use the command
13 "<emphasis role="bold">make eltf</emphasis>" to extract a full list of all
14 ELTF variables, which always begins with ELTF_ and don't only rely on the
15 howto text file list! The plan is that ELTF will auto-update this when
16 needed.</para>
17 </note>
18
19 <section id="host_prereq">
20 <title>Common Parameters</title>
21
22 <bridgehead>A programlisting, ID
23 "eltf-prereq-apt-get-commands-host"</bridgehead>
24
25 <para id="eltf-prereq-apt-get-commands-host"><programlisting># Host Ubuntu 14.04.5 LTS 64bit
26sudo apt-get -y update
27sudo apt-get -y install sed wget subversion git-core coreutils unzip texi2html \
28 texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \
29 make gcc build-essential xsltproc g++ desktop-file-utils chrpath \
30 libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \
31 libxml-parser-perl</programlisting></para>
32
33 <bridgehead>A programlisting, ID
34 "eltf-getting-repo-install-command"</bridgehead>
35
36 <para id="eltf-getting-repo-install-command"><programlisting>mkdir -p ~/bin
37curl https://storage.googleapis.com/git-repo-downloads/repo &gt; ~/bin/repo
38chmod a+x ~/bin/repo
39export PATH=~/bin:$PATH</programlisting></para>
40
41 <bridgehead>Several phrase elements, various IDs. Ensure EL_REL_VER is
42 correct also compared to the "previous" REL VER in pardoc-distro.xml
43 "prev_baseline".</bridgehead>
44
45 <para id="EneaLinux_REL_VER"><phrase>1.0</phrase></para>
46
47 <para id="Yocto_VER"><phrase>2.1</phrase></para>
48
49 <para id="Yocto_NAME"><phrase>krogoth</phrase></para>
50
51 <para id="ULINK_YOCTO_PROJECT_DOWNLOAD"><ulink
52 url="http://www.yoctoproject.org/downloads/core/krogoth/21">http://www.yoctoproject.org/downloads/core/krogoth/21</ulink></para>
53
54 <para id="ULINK_ENEA_LINUX_URL"><ulink
55 url="https://linux.enea.com/6">https://linux.enea.com/6</ulink></para>
56
57 <bridgehead>A programlisting, ID "eltf-repo-cloning-enea-linux". Use
58 $MACHINE/default.xml as parameter, where MACHINE is one of the target
59 directory names in the manifest.</bridgehead>
60
61 <para id="eltf-repo-cloning-enea-linux"><programlisting>mkdir enea-linux
62cd enea-linux
63repo init -u git@git.enea.com:linux/manifests/el_manifests-virtualization.git \
64 -b refs/tags/EL6 -m $MACHINE/default.xml
65repo sync</programlisting></para>
66
67 <bridgehead>A table with ONE row, only the row with ID
68 "eltf-eclipse-version-row" is included in the book. MANUALLY in book, set
69 condition hidden if eclipse is not in the release. Do this both in
70 template.xml and updated.xml.</bridgehead>
71
72 <informaltable>
73 <tgroup cols="1">
74 <tbody>
75 <row condition="hidden" id="eltf-eclipse-version-row">
76 <entry>Eclipse version 4.3 (Mars) plus command line development
77 tools are included in this Enea NFV Access release.</entry>
78 </row>
79 </tbody>
80 </tgroup>
81 </informaltable>
82
83 <bridgehead>Below is one big section with title "Supported Targets with
84 Parameters". The entire section is included completely in the book via ID
85 "eltf-target-tables-section" and shall be LAST in the template. The
86 template contains ONE target subsection. COPY/APPEND it, if multiple
87 targets exist in the release and optionally add rows with additional
88 target parameters in each target subsection table.</bridgehead>
89 </section>
90
91 <section id="eltf-target-tables-section">
92 <title>Supported Reference Boards with Parameters</title>
93
94 <para>The tables below describes the target(s) supported in this Enea NFV
95 Access release.</para>
96
97 <section id="eltf-target-table-p2041rdb">
98 <title>MACHINE p2041rdb - Information</title>
99
100 <para><informaltable>
101 <tgroup cols="2">
102 <colspec colwidth="6*" />
103
104 <colspec colwidth="9*" />
105
106 <tbody>
107 <row>
108 <entry>Target official name</entry>
109
110 <entry>P2041RDB</entry>
111 </row>
112
113 <row>
114 <entry>Architecture and Description</entry>
115
116 <entry>Power, e500mc</entry>
117 </row>
118
119 <row>
120 <entry>Link to target datasheet</entry>
121
122 <entry>See <ulink
123 url="http://www.nxp.com/products/microcontrollers-and-processors/power-architecture-processors/qoriq-power-architecture-processors/p2041-qoriq-reference-design-board:RDP2041BOARD">link
124 to NXP's datasheet</ulink></entry>
125 </row>
126
127 <row>
128 <entry>Poky version</entry>
129
130 <entry>Git-commit-id:
131 75ca53211488a3e268037a44ee2a7ac5c7181bd2</entry>
132 </row>
133
134 <row>
135 <entry>GCC version</entry>
136
137 <entry>5.3</entry>
138 </row>
139
140 <row>
141 <entry>Linux Kernel Version</entry>
142
143 <entry>3.12</entry>
144 </row>
145
146 <row>
147 <entry>Supported Drivers</entry>
148
149 <entry>Ethernet, I2C, SPI, PCI Express, USB, Flash,
150 SD/SDHC/SDXC, RTC</entry>
151 </row>
152
153 <row>
154 <entry>Enea rpm folder for downloading RPM packages for this
155 target</entry>
156
157 <entry><ulink
158 url="https://linux.enea.com/6/p2041rgb/rpm">https://linux.enea.com/6/p2041rgb/rpm</ulink></entry>
159 </row>
160 </tbody>
161 </tgroup>
162 </informaltable></para>
163 </section>
164 </section>
165</section> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-release-info-eltf/eltf_params_template.xml b/doc/eltf_params_template.xml
index eaa7ebd..278ad71 100644
--- a/doc/book-enea-nfv-access-release-info-eltf/eltf_params_template.xml
+++ b/doc/eltf_params_template.xml
@@ -61,7 +61,7 @@
61 <tbody> 61 <tbody>
62 <row id="eltf-eclipse-version-row"> 62 <row id="eltf-eclipse-version-row">
63 <entry>Eclipse version ELTF_ECLIPSE_VERSION plus command line 63 <entry>Eclipse version ELTF_ECLIPSE_VERSION plus command line
64 development tools are included in this Enea NFV Access release.</entry> 64 development tools are included in this Enea Linux release.</entry>
65 </row> 65 </row>
66 </tbody> 66 </tbody>
67 </tgroup> 67 </tgroup>
@@ -79,7 +79,7 @@
79 <title>Supported Targets with Parameters</title> 79 <title>Supported Targets with Parameters</title>
80 80
81 <para>The tables below describes the target(s) supported in this Enea 81 <para>The tables below describes the target(s) supported in this Enea
82 NFV Access release.</para> 82 Linux release.</para>
83 83
84 <section id="eltf-target-table-ELTF_T_MANIFEST_DIR"> 84 <section id="eltf-target-table-ELTF_T_MANIFEST_DIR">
85 <title>MACHINE ELTF_T_MANIFEST_DIR - Information</title> 85 <title>MACHINE ELTF_T_MANIFEST_DIR - Information</title>
diff --git a/doc/book-enea-nfv-access-release-info-eltf/eltf_params_updated_template_how_to_use.txt b/doc/eltf_params_updated_template_how_to_use.txt
index 62e5d02..62e5d02 100644
--- a/doc/book-enea-nfv-access-release-info-eltf/eltf_params_updated_template_how_to_use.txt
+++ b/doc/eltf_params_updated_template_how_to_use.txt
diff --git a/doc/system_requirements_prerequisites.xml b/doc/system_requirements_prerequisites.xml
deleted file mode 100644
index b9e15fa..0000000
--- a/doc/system_requirements_prerequisites.xml
+++ /dev/null
@@ -1,34 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<chapter id="sys-req-prerequisites">
5 <title>System Requirements and Prerequisites</title>
6
7 <para>Using Enea NFV Access or compiling applications requires that your git
8 environment be setup properly and for certain packages to be installed on
9 your NFV Access development host.</para>
10
11 <para>Please refer to <ulink
12 url="https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup">Getting
13 Started - First-Time Git Setup</ulink>, for more details on how to set up
14 your git environment correctly, including how to set your identity using the
15 following commands:</para>
16
17 <programlisting>$ git config --global user.name "John Doe"
18$ git config --global user.email johndoe@example.com</programlisting>
19
20 <para>First ensure the system is up-to-date, then for the supported
21 distribution(s), you need the following packages:<remark>INFO: The
22 programlisting below is a parameters in eltf_params_updated.xml with ID:
23 "eltf-prereq-apt-get-command-host". If multiple hosts are supported, store
24 the commands for each host in the same programlisting with empty lines
25 between each - the comment with the FULL HOST name and version is
26 essential.</remark></para>
27
28 <xi:include href="../../s_doceneacommon/doc/book-enea-nfv-access-release-info-eltf/eltf_params_updated.xml"
29 xmlns:xi="http://www.w3.org/2001/XInclude"
30 xpointer="element(eltf-prereq-apt-get-commands-host/1)" />
31
32 <xi:include href="system_requirements.xml"
33 xmlns:xi="http://www.w3.org/2001/XInclude" />
34</chapter> \ No newline at end of file