summaryrefslogtreecommitdiffstats
path: root/doc/eltf_params_updated.xml
blob: df317aa2090d98a431164e260c4c10593eccdaef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<section id="eltf_created_params">
  <title>File with Parameters in the Book Auto-updated by ELFT</title>

  <note>
    <para>See the <emphasis
    role="bold">eltf_params_updated_template_howto_use.txt</emphasis> text
    file for description of how to create the final <emphasis
    role="bold">eltf_params_updated.xml</emphasis> from this template and for
    all <emphasis role="bold">REQUIREMENTS</emphasis>. Use the command
    "<emphasis role="bold">make eltf</emphasis>" to extract a full list of all
    ELTF variables, which always begins with ELTF_ and don't only rely on the
    howto text file list! The plan is that ELTF will auto-update this when
    needed.</para>
  </note>

  <section id="host_prereq">
    <title>Common Parameters</title>

    <bridgehead>A programlisting, ID
    "eltf-prereq-apt-get-commands-host"</bridgehead>

    <para id="eltf-prereq-apt-get-commands-host"><programlisting># Host Ubuntu 16.04 LTS 64bit
sudo apt-get -y update
sudo apt-get -y install sed wget subversion git-core coreutils unzip texi2html \
   texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \
   make gcc build-essential xsltproc g++ desktop-file-utils chrpath  \
   libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \
   libxml-parser-perl</programlisting></para>

    <bridgehead>A programlisting, ID
    "eltf-getting-repo-install-command"</bridgehead>

    <para id="eltf-getting-repo-install-command"><programlisting>mkdir -p ~/bin
curl https://storage.googleapis.com/git-repo-downloads/repo &gt; ~/bin/repo
chmod a+x ~/bin/repo
export PATH=~/bin:$PATH</programlisting></para>

    <bridgehead>Several phrase elements, various IDs. Ensure EL_REL_VER is
    correct also compared to the "previous" REL VER in pardoc-distro.xml
    "prev_baseline".</bridgehead>

    <para id="EneaLinux_REL_VER"><phrase>2.2.2</phrase></para>

    <para id="Yocto_VER"><phrase>2.4</phrase></para>

    <para id="Yocto_NAME"><phrase>rocko</phrase></para>

    <para id="ULINK_YOCTO_PROJECT_DOWNLOAD"><ulink
    url="http://www.yoctoproject.org/downloads">http://www.yoctoproject.org/downloads</ulink></para>

    <para id="ULINK_ENEA_LINUX_URL"><ulink
    url="https://linux.enea.com/6">https://linux.enea.com/6</ulink></para>

    <bridgehead>A programlisting, ID "eltf-repo-cloning-enea-linux". Use
    $MACHINE/default.xml as parameter, where MACHINE is one of the target
    directory names in the manifest.</bridgehead>

    <para id="eltf-repo-cloning-enea-linux"><programlisting>mkdir enea-linux
cd enea-linux
repo init -u git@git.enea.com:linux/manifests/el_manifests-virtualization.git \
    -b refs/tags/EL6 -m $MACHINE/default.xml
repo sync</programlisting></para>

    <bridgehead>A table with ONE row, only the row with ID
    "eltf-eclipse-version-row" is included in the book. MANUALLY in book, set
    condition hidden if eclipse is not in the release. Do this both in
    template.xml and updated.xml.</bridgehead>

    <informaltable>
      <tgroup cols="1">
        <tbody>
          <row condition="hidden" id="eltf-eclipse-version-row">
            <entry>Eclipse version 4.3 (Mars) plus command line development
            tools are included in this Enea NFV Access release.</entry>
          </row>
        </tbody>
      </tgroup>
    </informaltable>

    <bridgehead>Below is one big section with title "Supported Processor with
    Parameters". The entire section is included completely in the book via ID
    "eltf-target-tables-section" and shall be LAST in the template. The
    template contains ONE target subsection. COPY/APPEND it, if multiple
    targets exist in the release and optionally add rows with additional
    target parameters in each target subsection table.</bridgehead>
  </section>

  <section id="eltf-target-tables-section">
    <title>Supported Reference Processor with Parameters</title>

    <para>The table(s) below describes the processors supported in this Enea
    NFV Access release.</para>

    <table>
      <title>Processor Information Intel Xeon D-1500</title>

      <tgroup cols="2">
        <colspec align="center" />

        <thead>
          <row>
            <entry align="center">Component</entry>

            <entry align="center">Description</entry>
          </row>
        </thead>

        <tbody>
          <row>
            <entry align="left">Processor official name</entry>

            <entry>Intel Xeon D-1500</entry>
          </row>

          <row>
            <entry align="left">Architecture and Description</entry>

            <entry>x86-64</entry>
          </row>

          <row>
            <entry align="left">Link to processor datasheet</entry>

            <entry><ulink
            url="https://www.intel.com/content/www/us/en/processors/xeon/xeon-d-1500-datasheet-vol-1.html">Intel's
            datasheet</ulink></entry>
          </row>

          <row>
            <entry align="left">GCC version</entry>

            <entry>7.3</entry>
          </row>

          <row>
            <entry align="left">Linux Kernel Version</entry>

            <entry>4.14</entry>
          </row>

          <row condition="hidden">
            <entry align="left">Supported Drivers</entry>

            <entry>Ethernet, RTC, UART</entry>
          </row>
        </tbody>
      </tgroup>
    </table>

    <table>
      <title>Processor Information Intel Atom C3000</title>

      <tgroup cols="2">
        <colspec align="center" />

        <thead>
          <row>
            <entry align="center">Component</entry>

            <entry align="center">Description</entry>
          </row>
        </thead>

        <tbody>
          <row>
            <entry align="left">Processor official name</entry>

            <entry>Intel Atom C3000</entry>
          </row>

          <row>
            <entry align="left">Architecture and Description</entry>

            <entry>x86-64</entry>
          </row>

          <row>
            <entry align="left">Link to the processor datasheet</entry>

            <entry><ulink
            url="https://www.intel.com/content/www/us/en/products/docs/processors/atom/c-series/c3000-family-datasheet.html">Intel's
            datasheet</ulink></entry>
          </row>

          <row>
            <entry align="left">GCC version</entry>

            <entry>7.3</entry>
          </row>

          <row>
            <entry align="left">Linux Kernel Version</entry>

            <entry>4.14</entry>
          </row>

          <row condition="hidden">
            <entry align="left">Supported Drivers</entry>

            <entry>Ethernet, RTC, UART</entry>
          </row>
        </tbody>
      </tgroup>
    </table>
  </section>
</section>