summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-release-info-eltf/eltf_params_template.xml
blob: eaa7ebd5faa0afeda141abd59e6a29ba3cba39d1 (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
<?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>ELTF_PL_HOST_PREREQ</programlisting></para>

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

    <para id="eltf-getting-repo-install-command"><programlisting>ELTF_PL_GET_REPO</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>ELTF_EL_REL_VER</phrase></para>

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

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

    <para id="ULINK_YOCTO_PROJECT_DOWNLOAD"><ulink
    url="ELTF_YOCTO_PROJ_DOWNLOAD_URL">ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL</ulink></para>

    <para id="ULINK_ENEA_LINUX_URL"><ulink
    url="ELTF_EL_DOWNLOAD_URL">ELTF_EL_DOWNLOAD_TXTURL</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>ELTF_PL_CLONE_W_REPO</programlisting></para>

    <bridgehead>A table with ONE row, only the row with ID
    "eltf-eclipse-version-row" is included in the book. MANUALLY BOTH in the
    template.xml and in the updated.xml, set condition hidden on the
    &lt;row&gt;, if eclipse is not in the release.</bridgehead>

    <informaltable>
      <tgroup cols="1">
        <tbody>
          <row id="eltf-eclipse-version-row">
            <entry>Eclipse version ELTF_ECLIPSE_VERSION 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 Targets 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 Targets with Parameters</title>

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

    <section id="eltf-target-table-ELTF_T_MANIFEST_DIR">
      <title>MACHINE ELTF_T_MANIFEST_DIR - Information</title>

      <para><informaltable>
          <tgroup cols="2">
            <colspec colwidth="6*" />

            <colspec colwidth="9*" />

            <tbody>
              <row>
                <entry>Target official name</entry>

                <entry>ELTF_T_NAME</entry>
              </row>

              <row>
                <entry>Architecture and Description</entry>

                <entry>ELTF_T_ARC_DESC</entry>
              </row>

              <row>
                <entry>Link to target datasheet</entry>

                <entry>See <ulink
                url="ELTF_T_DS_URL">ELTF_T_DS_TXTURL</ulink></entry>
              </row>

              <row>
                <entry>Poky version</entry>

                <entry>ELTF_T_POKY_VER</entry>
              </row>

              <row>
                <entry>GCC version</entry>

                <entry>ELTF_T_GCC_VER</entry>
              </row>

              <row>
                <entry>Linux Kernel Version</entry>

                <entry>ELTF_T_KERN_VER</entry>
              </row>

              <row>
                <entry>Supported Drivers</entry>

                <entry>ELTF_T_DRIVERS</entry>
              </row>

              <row>
                <entry>Enea rpm folder for downloading RPM packages for this
                target</entry>

                <entry><ulink
                url="ELTF_T_EL_RPM_URL">ELTF_T_EL_RPM_TXTURL</ulink></entry>
              </row>
            </tbody>
          </tgroup>
        </informaltable></para>
    </section>

    <!-- ELTFADD_MORE_TARGET_SECTIONS_BELOW_IF_NEEDED -->
  </section>
</section>