diff options
| -rw-r--r-- | doc/book-enea-edge-getting-started/doc/advanced_configurations.xml | 2 | ||||
| -rw-r--r-- | doc/book-enea-edge-getting-started/doc/installation_guide.xml | 80 | ||||
| -rw-r--r-- | doc/book-enea-edge-getting-started/doc/log_collector.xml | 4 | ||||
| -rw-r--r-- | doc/book-enea-edge-getting-started/doc/upgrade_ena.xml | 10 | ||||
| -rw-r--r-- | doc/book-enea-edge-release-info/doc/about_release.xml | 27 | ||||
| -rw-r--r-- | doc/eltf_params_template.xml | 151 | ||||
| -rw-r--r-- | doc/eltf_params_updated.xml | 173 | ||||
| -rw-r--r-- | doc/eltf_params_updated_template_how_to_use.txt | 320 |
8 files changed, 697 insertions, 70 deletions
diff --git a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml index 83641b1..c387e7f 100644 --- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml +++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml | |||
| @@ -437,7 +437,7 @@ node0.1048576kB = 3 </programlisting> | |||
| 437 | <listitem> | 437 | <listitem> |
| 438 | <para>Run the following command:</para> | 438 | <para>Run the following command:</para> |
| 439 | 439 | ||
| 440 | <programlisting>./createCertificate.sh ucpemanager <IP_or_domain> \ | 440 | <programlisting>./createCertificate.sh EneaEdgeManagement <IP_or_domain> \ |
| 441 | /opt/ems [<service_username>]</programlisting> | 441 | /opt/ems [<service_username>]</programlisting> |
| 442 | 442 | ||
| 443 | <para>Where the following need to be included:</para> | 443 | <para>Where the following need to be included:</para> |
diff --git a/doc/book-enea-edge-getting-started/doc/installation_guide.xml b/doc/book-enea-edge-getting-started/doc/installation_guide.xml index 1eab201..b4324de 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml | |||
| @@ -490,12 +490,12 @@ userdel postgres</programlisting> | |||
| 490 | <listitem> | 490 | <listitem> |
| 491 | <para>Choose the target installation folder, e.g. | 491 | <para>Choose the target installation folder, e.g. |
| 492 | <literal>/opt/ems</literal>. Everything will be installed under a | 492 | <literal>/opt/ems</literal>. Everything will be installed under a |
| 493 | folder called <literal>/ucpemanager</literal> within the target | 493 | folder called <literal>/ucpemanager</literal> within the |
| 494 | installation folder.</para> | 494 | target installation folder.</para> |
| 495 | 495 | ||
| 496 | <para>The application files will be installed in | 496 | <para>The application files will be installed in |
| 497 | <literal>/opt/ems/ucpemanager/application</literal>. The database | 497 | <literal>/opt/ems/ucpemanager/application</literal>. The |
| 498 | will be installed in | 498 | database will be installed in |
| 499 | <literal>/opt/ems/ucpemanager/database</literal>.</para> | 499 | <literal>/opt/ems/ucpemanager/database</literal>.</para> |
| 500 | </listitem> | 500 | </listitem> |
| 501 | 501 | ||
| @@ -503,7 +503,7 @@ userdel postgres</programlisting> | |||
| 503 | <para>Run the following interactive command:</para> | 503 | <para>Run the following interactive command:</para> |
| 504 | 504 | ||
| 505 | <programlisting>./install.sh /opt/ems \ | 505 | <programlisting>./install.sh /opt/ems \ |
| 506 | Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</programlisting> | 506 | Enea_Edge_Management_<version>-build<build_number>.tar.gz</programlisting> |
| 507 | 507 | ||
| 508 | <para>The default configuration values are specified in brackets. | 508 | <para>The default configuration values are specified in brackets. |
| 509 | If no other value is preferred and typed in, pressing | 509 | If no other value is preferred and typed in, pressing |
| @@ -565,12 +565,12 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 565 | <itemizedlist spacing="compact"> | 565 | <itemizedlist spacing="compact"> |
| 566 | <listitem> | 566 | <listitem> |
| 567 | <para>Specify a service username | 567 | <para>Specify a service username |
| 568 | <literal>[ucpemanager]:</literal></para> | 568 | <literal>[EneaEdgeManagement]</literal>:</para> |
| 569 | </listitem> | 569 | </listitem> |
| 570 | 570 | ||
| 571 | <listitem> | 571 | <listitem> |
| 572 | <para>Specify a service password | 572 | <para>Specify a service password |
| 573 | <literal>[ucpemanager]</literal>:</para> | 573 | <literal>[EneaEdgeManagement]</literal>:</para> |
| 574 | </listitem> | 574 | </listitem> |
| 575 | </itemizedlist> | 575 | </itemizedlist> |
| 576 | </listitem> | 576 | </listitem> |
| @@ -593,19 +593,21 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 593 | </listitem> | 593 | </listitem> |
| 594 | 594 | ||
| 595 | <listitem> | 595 | <listitem> |
| 596 | <para>Create the self-signed certificate: <literal>Specify IP or domain name</literal> | 596 | <para>Create the self-signed certificate: <literal>Specify IP |
| 597 | (or press <literal>Enter</literal> to skip):</para> | 597 | or domain name</literal> (or press <literal>Enter</literal> to |
| 598 | 598 | skip):</para> | |
| 599 | <para>The Tomcat self-signed certificate can be generated | 599 | |
| 600 | again by running the | 600 | <para>The Tomcat self-signed certificate can be generated |
| 601 | <filename>createCertificate.sh</filename>. For more details, please see <olink | 601 | again by running the |
| 602 | targetdoc="book_enea_edge_getting_started" | 602 | <filename>createCertificate.sh</filename>. For more details, |
| 603 | targetptr="create_certificate">Tomcat Certificate | 603 | please see <olink targetdoc="book_enea_edge_getting_started" |
| 604 | Generation in the <ns:include | 604 | targetptr="create_certificate">Tomcat Certificate Generation |
| 605 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 605 | in the <ns:include |
| 606 | xpointer="element(book_enea_edge_getting_started/1)" | 606 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
| 607 | xmlns:ns="http://www.w3.org/2001/XInclude" /></olink> Manual.</para> | 607 | xmlns:ns="http://www.w3.org/2001/XInclude" |
| 608 | 608 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> | |
| 609 | Manual.</para> | ||
| 610 | |||
| 609 | <note> | 611 | <note> |
| 610 | <para>The generation of the Tomcat self-signed cerificate | 612 | <para>The generation of the Tomcat self-signed cerificate |
| 611 | should be skipped only if another certifcate will be | 613 | should be skipped only if another certifcate will be |
| @@ -614,14 +616,13 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 614 | </listitem> | 616 | </listitem> |
| 615 | 617 | ||
| 616 | <listitem> | 618 | <listitem> |
| 617 | <para>Heap Configuration:</para> | 619 | <para>Heap Configuration:</para> |
| 618 | 620 | ||
| 619 | <itemizedlist spacing="compact"> | 621 | <itemizedlist spacing="compact"> |
| 620 | <listitem> | 622 | <listitem> |
| 621 | <para>Please enter the new Maximum Heap Size | 623 | <para>Please enter the new Maximum Heap Size [4g]:</para> |
| 622 | [4g]:</para> | 624 | </listitem> |
| 623 | </listitem> | 625 | </itemizedlist> |
| 624 | </itemizedlist> | ||
| 625 | </listitem> | 626 | </listitem> |
| 626 | </itemizedlist> | 627 | </itemizedlist> |
| 627 | 628 | ||
| @@ -639,11 +640,13 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 639 | 640 | ||
| 640 | <listitem> | 641 | <listitem> |
| 641 | <para>Install the Enea Edge Management application as a | 642 | <para>Install the Enea Edge Management application as a |
| 642 | service with the name <literal>ucpemanager</literal>.</para> | 643 | service with the name |
| 644 | <literal>ucpemanager</literal>.</para> | ||
| 643 | </listitem> | 645 | </listitem> |
| 644 | 646 | ||
| 645 | <listitem> | 647 | <listitem> |
| 646 | <para>Start the <literal>ucpemanager</literal> service.</para> | 648 | <para>Start the <literal>ucpemanager</literal> |
| 649 | service.</para> | ||
| 647 | </listitem> | 650 | </listitem> |
| 648 | </itemizedlist> | 651 | </itemizedlist> |
| 649 | </listitem> | 652 | </listitem> |
| @@ -657,8 +660,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 657 | </orderedlist> | 660 | </orderedlist> |
| 658 | 661 | ||
| 659 | <note> | 662 | <note> |
| 660 | <para>The IPv4 address of the CentOS 7 Server will be used as a configuration | 663 | <para>The IPv4 address of the CentOS 7 Server will be used as a |
| 661 | parameter when setting up the uCPE devices.</para> | 664 | configuration parameter when setting up the uCPE devices.</para> |
| 662 | 665 | ||
| 663 | <para>If the CentOS 7 Server is installed behind NAT, the IPv4 | 666 | <para>If the CentOS 7 Server is installed behind NAT, the IPv4 |
| 664 | address used will be the public IP of the NAT device and port | 667 | address used will be the public IP of the NAT device and port |
| @@ -680,8 +683,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 680 | role="bold">System</emphasis> menu, and clicking <emphasis | 683 | role="bold">System</emphasis> menu, and clicking <emphasis |
| 681 | role="bold">System Backup</emphasis>, from the Enea Edge Management | 684 | role="bold">System Backup</emphasis>, from the Enea Edge Management |
| 682 | GUI. The resulting zip archive will be located in the | 685 | GUI. The resulting zip archive will be located in the |
| 683 | <filename>/opt/ems/ucpemanager/application/backup</filename> folder | 686 | <filename>/opt/ems/ucpemanager/application/backup</filename> |
| 684 | and will be named | 687 | folder and will be named |
| 685 | <literal>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</literal> (e.g | 688 | <literal>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</literal> (e.g |
| 686 | System-Backup_Feb19_2013_2257_42.zip). Save the archive to another | 689 | System-Backup_Feb19_2013_2257_42.zip). Save the archive to another |
| 687 | location outside the Enea Edge Management installation folder for | 690 | location outside the Enea Edge Management installation folder for |
| @@ -708,7 +711,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 708 | installation:</para> | 711 | installation:</para> |
| 709 | 712 | ||
| 710 | <programlisting>./install.sh \ | 713 | <programlisting>./install.sh \ |
| 711 | /opt/ems Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz \ | 714 | /opt/ems Enea_Edge_Management_<version>-build<build_number>.tar.gz \ |
| 712 | SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting> | 715 | SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting> |
| 713 | </section> | 716 | </section> |
| 714 | </section> | 717 | </section> |
| @@ -757,9 +760,10 @@ sdb 8:0 0 111.8G 0 disk | |||
| 757 | <programlisting>sudo dd if=./enea-edge-runtime-<machine>.hddimg \ | 760 | <programlisting>sudo dd if=./enea-edge-runtime-<machine>.hddimg \ |
| 758 | of=/dev/sdb bs=4M conv=fsync</programlisting> | 761 | of=/dev/sdb bs=4M conv=fsync</programlisting> |
| 759 | 762 | ||
| 760 | <para>Where <filename>enea-edge-runtime-<machine>.hddimg</filename> is | 763 | <para>Where |
| 761 | the <filename>.hddimg</filename> file and <literal>sdb</literal> is | 764 | <filename>enea-edge-runtime-<machine>.hddimg</filename> is the |
| 762 | the assigned USB device name.</para> | 765 | <filename>.hddimg</filename> file and <literal>sdb</literal> is the |
| 766 | assigned USB device name.</para> | ||
| 763 | </listitem> | 767 | </listitem> |
| 764 | </orderedlist> | 768 | </orderedlist> |
| 765 | </section> | 769 | </section> |
| @@ -1252,4 +1256,4 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
| 1252 | </note> | 1256 | </note> |
| 1253 | </section> | 1257 | </section> |
| 1254 | </section> | 1258 | </section> |
| 1255 | </chapter> | 1259 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-edge-getting-started/doc/log_collector.xml b/doc/book-enea-edge-getting-started/doc/log_collector.xml index 1148dc2..d7d99dd 100644 --- a/doc/book-enea-edge-getting-started/doc/log_collector.xml +++ b/doc/book-enea-edge-getting-started/doc/log_collector.xml | |||
| @@ -341,7 +341,7 @@ | |||
| 341 | collected uCPE device logs to the support team provides important | 341 | collected uCPE device logs to the support team provides important |
| 342 | information for troubleshooting (especially in cases of connectivity | 342 | information for troubleshooting (especially in cases of connectivity |
| 343 | issues with the uCPE device and error popups).</para> | 343 | issues with the uCPE device and error popups).</para> |
| 344 | 344 | ||
| 345 | <para>Enea Edge Management log files are located in | 345 | <para>Enea Edge Management log files are located in |
| 346 | <filename>application/logs/</filename> in the Enea Edge Management | 346 | <filename>application/logs/</filename> in the Enea Edge Management |
| 347 | application's installation folder | 347 | application's installation folder |
| @@ -358,7 +358,7 @@ | |||
| 358 | 358 | ||
| 359 | <listitem> | 359 | <listitem> |
| 360 | <para>Select the desired log file | 360 | <para>Select the desired log file |
| 361 | (<filename>ucpemanager.log</filename> or | 361 | (<filename>EneaEdgeManagement.log</filename> or |
| 362 | <filename>watchdog.log</filename>) and press the <emphasis | 362 | <filename>watchdog.log</filename>) and press the <emphasis |
| 363 | role="bold">Download</emphasis> button.</para> | 363 | role="bold">Download</emphasis> button.</para> |
| 364 | </listitem> | 364 | </listitem> |
diff --git a/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml b/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml index ac2ebb6..e213a0f 100644 --- a/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml +++ b/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml | |||
| @@ -37,7 +37,7 @@ | |||
| 37 | Management installation:</para> | 37 | Management installation:</para> |
| 38 | 38 | ||
| 39 | <programlisting>./upgrade.sh /opt/ems \ | 39 | <programlisting>./upgrade.sh /opt/ems \ |
| 40 | Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</programlisting> | 40 | Enea_Edge_Management_<version>-build<build_number>.tar.gz</programlisting> |
| 41 | </listitem> | 41 | </listitem> |
| 42 | </orderedlist> | 42 | </orderedlist> |
| 43 | 43 | ||
| @@ -52,7 +52,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 52 | <listitem> | 52 | <listitem> |
| 53 | <para>Create a compressed file of the <literal>ucpemanager</literal> | 53 | <para>Create a compressed file of the <literal>ucpemanager</literal> |
| 54 | application folder | 54 | application folder |
| 55 | (<filename>ucpemanager-Back-up-YYYYddMMHHmm.tar.gz</filename>), which | 55 | (<filename>EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz</filename>), which |
| 56 | contains a snapshot of the existing installation in the | 56 | contains a snapshot of the existing installation in the |
| 57 | <literal><uCPEM-installerdir>/dist</literal> directory.</para> | 57 | <literal><uCPEM-installerdir>/dist</literal> directory.</para> |
| 58 | 58 | ||
| @@ -109,7 +109,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 109 | 109 | ||
| 110 | <listitem> | 110 | <listitem> |
| 111 | <para>Copy the snapshot file | 111 | <para>Copy the snapshot file |
| 112 | (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) | 112 | (<filename>EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz</filename>) |
| 113 | created during a previous Enea Edge Management Upgrade or Enea Edge | 113 | created during a previous Enea Edge Management Upgrade or Enea Edge |
| 114 | Management Uninstall Operation into the | 114 | Management Uninstall Operation into the |
| 115 | <literal><uCPEM-installerdir>/dist</literal> directory.</para> | 115 | <literal><uCPEM-installerdir>/dist</literal> directory.</para> |
| @@ -124,7 +124,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 124 | <literal>/opt/ems</literal> to the correct location of the Enea Edge | 124 | <literal>/opt/ems</literal> to the correct location of the Enea Edge |
| 125 | Management installation:</para> | 125 | Management installation:</para> |
| 126 | 126 | ||
| 127 | <programlisting>./restore.sh /opt/ems ucpemanager-Backup-YYYYddMMHHmm.tar.gz</programlisting> | 127 | <programlisting>./restore.sh /opt/ems EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz</programlisting> |
| 128 | </listitem> | 128 | </listitem> |
| 129 | </orderedlist> | 129 | </orderedlist> |
| 130 | 130 | ||
| @@ -186,7 +186,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 186 | <listitem> | 186 | <listitem> |
| 187 | <para>Create a compressed file of the <literal>ucpemanager</literal> | 187 | <para>Create a compressed file of the <literal>ucpemanager</literal> |
| 188 | application folder: | 188 | application folder: |
| 189 | <filename>ucpemanager-Back-up-YYYYddMMHHmm.tar.gz</filename>, which | 189 | <filename>EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz</filename>, which |
| 190 | contains a snapshot of the existing installation and functions as a | 190 | contains a snapshot of the existing installation and functions as a |
| 191 | restore point.</para> | 191 | restore point.</para> |
| 192 | 192 | ||
diff --git a/doc/book-enea-edge-release-info/doc/about_release.xml b/doc/book-enea-edge-release-info/doc/about_release.xml index 349c955..3cc854e 100644 --- a/doc/book-enea-edge-release-info/doc/about_release.xml +++ b/doc/book-enea-edge-release-info/doc/about_release.xml | |||
| @@ -12,9 +12,9 @@ | |||
| 12 | private or public cloud.</para> | 12 | private or public cloud.</para> |
| 13 | 13 | ||
| 14 | <para>The Enea Edge <xi:include | 14 | <para>The Enea Edge <xi:include |
| 15 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" | 15 | href="../../eltf_params_updated.xml" |
| 16 | xmlns:xi="http://www.w3.org/2001/XInclude" | 16 | xmlns:xi="http://www.w3.org/2001/XInclude" |
| 17 | xpointer="element(EneaLinux_REL_VER/1)" /> Release includes new features, | 17 | xpointer="element(EneaEdge_REL_VER/1)" /> Release includes new features, |
| 18 | optimizations, corrections, and updates to the user documentation.. | 18 | optimizations, corrections, and updates to the user documentation.. |
| 19 | A list of major new features and improvements can be found in | 19 | A list of major new features and improvements can be found in |
| 20 | <xref linkend="relinfo-changes-other">Section 2.1 New Features and Improvements</xref>.</para> | 20 | <xref linkend="relinfo-changes-other">Section 2.1 New Features and Improvements</xref>.</para> |
| @@ -103,7 +103,7 @@ | |||
| 103 | it is in the beginning. The subtitles shall have the directory name of the | 103 | it is in the beginning. The subtitles shall have the directory name of the |
| 104 | target in the manifest.</remark> | 104 | target in the manifest.</remark> |
| 105 | 105 | ||
| 106 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" | 106 | <xi:include href="../../eltf_params_updated.xml" |
| 107 | xmlns:xi="http://www.w3.org/2001/XInclude" | 107 | xmlns:xi="http://www.w3.org/2001/XInclude" |
| 108 | xpointer="element(eltf-target-tables-section)" /> | 108 | xpointer="element(eltf-target-tables-section)" /> |
| 109 | 109 | ||
| @@ -164,25 +164,4 @@ | |||
| 164 | </listitem> | 164 | </listitem> |
| 165 | </itemizedlist> | 165 | </itemizedlist> |
| 166 | </section> | 166 | </section> |
| 167 | |||
| 168 | <section id="release-browsers"> | ||
| 169 | <title>Supported Web Browsers</title> | ||
| 170 | |||
| 171 | <para>The current release supports using the following web | ||
| 172 | browsers:</para> | ||
| 173 | |||
| 174 | <itemizedlist> | ||
| 175 | <listitem> | ||
| 176 | <para>Google Chrome (tested with version 89).</para> | ||
| 177 | </listitem> | ||
| 178 | |||
| 179 | <listitem> | ||
| 180 | <para>Mozilla Firefox (tested with version 87).</para> | ||
| 181 | </listitem> | ||
| 182 | |||
| 183 | <listitem> | ||
| 184 | <para>Microsoft Edge (tested with version 89).</para> | ||
| 185 | </listitem> | ||
| 186 | </itemizedlist> | ||
| 187 | </section> | ||
| 188 | </chapter> \ No newline at end of file | 167 | </chapter> \ No newline at end of file |
diff --git a/doc/eltf_params_template.xml b/doc/eltf_params_template.xml new file mode 100644 index 0000000..8a05079 --- /dev/null +++ b/doc/eltf_params_template.xml | |||
| @@ -0,0 +1,151 @@ | |||
| 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>ELTF_PL_HOST_PREREQ</programlisting></para> | ||
| 26 | |||
| 27 | <bridgehead>A programlisting, ID | ||
| 28 | "eltf-getting-repo-install-command"</bridgehead> | ||
| 29 | |||
| 30 | <para id="eltf-getting-repo-install-command"><programlisting>ELTF_PL_GET_REPO</programlisting></para> | ||
| 31 | |||
| 32 | <bridgehead>Several phrase elements, various IDs. Ensure EL_REL_VER is | ||
| 33 | correct also compared to the "previous" REL VER in pardoc-distro.xml | ||
| 34 | "prev_baseline".</bridgehead> | ||
| 35 | |||
| 36 | <para id="EneaEdge_REL_VER"><phrase>ELTF_EL_REL_VER</phrase></para> | ||
| 37 | |||
| 38 | <para id="Yocto_VER"><phrase>ELTF_YOCTO_VER</phrase></para> | ||
| 39 | |||
| 40 | <para id="Yocto_NAME"><phrase>ELTF_YOCTO_NAME</phrase></para> | ||
| 41 | |||
| 42 | <para id="ULINK_YOCTO_PROJECT_DOWNLOAD"><ulink | ||
| 43 | url="ELTF_YOCTO_PROJ_DOWNLOAD_URL">ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL</ulink></para> | ||
| 44 | |||
| 45 | <para id="ULINK_ENEA_LINUX_URL"><ulink | ||
| 46 | url="ELTF_EL_DOWNLOAD_URL">ELTF_EL_DOWNLOAD_TXTURL</ulink></para> | ||
| 47 | |||
| 48 | <bridgehead>A programlisting, ID "eltf-repo-cloning-enea-linux". Use | ||
| 49 | $MACHINE/default.xml as parameter, where MACHINE is one of the target | ||
| 50 | directory names in the manifest.</bridgehead> | ||
| 51 | |||
| 52 | <para id="eltf-repo-cloning-enea-linux"><programlisting>ELTF_PL_CLONE_W_REPO</programlisting></para> | ||
| 53 | |||
| 54 | <bridgehead>A table with ONE row, only the row with ID | ||
| 55 | "eltf-eclipse-version-row" is included in the book. MANUALLY BOTH in the | ||
| 56 | template.xml and in the updated.xml, set condition hidden on the | ||
| 57 | <row>, if eclipse is not in the release.</bridgehead> | ||
| 58 | |||
| 59 | <informaltable> | ||
| 60 | <tgroup cols="1"> | ||
| 61 | <tbody> | ||
| 62 | <row id="eltf-eclipse-version-row"> | ||
| 63 | <entry>Eclipse version ELTF_ECLIPSE_VERSION plus command line | ||
| 64 | development tools are included in this Enea Linux release.</entry> | ||
| 65 | </row> | ||
| 66 | </tbody> | ||
| 67 | </tgroup> | ||
| 68 | </informaltable> | ||
| 69 | |||
| 70 | <bridgehead>Below is one big section with title "Supported Targets with | ||
| 71 | Parameters". The entire section is included completely in the book via ID | ||
| 72 | "eltf-target-tables-section" and shall be LAST in the template. The | ||
| 73 | template contains ONE target subsection. COPY/APPEND it, if multiple | ||
| 74 | targets exist in the release and optionally add rows with additional | ||
| 75 | target parameters in each target subsection table.</bridgehead> | ||
| 76 | </section> | ||
| 77 | |||
| 78 | <section id="eltf-target-tables-section"> | ||
| 79 | <title>Supported Targets with Parameters</title> | ||
| 80 | |||
| 81 | <para>The tables below describes the target(s) supported in this Enea | ||
| 82 | Linux release.</para> | ||
| 83 | |||
| 84 | <section id="eltf-target-table-ELTF_T_MANIFEST_DIR"> | ||
| 85 | <title>MACHINE ELTF_T_MANIFEST_DIR - Information</title> | ||
| 86 | |||
| 87 | <para><informaltable> | ||
| 88 | <tgroup cols="2"> | ||
| 89 | <colspec colwidth="6*" /> | ||
| 90 | |||
| 91 | <colspec colwidth="9*" /> | ||
| 92 | |||
| 93 | <tbody> | ||
| 94 | <row> | ||
| 95 | <entry>Target official name</entry> | ||
| 96 | |||
| 97 | <entry>ELTF_T_NAME</entry> | ||
| 98 | </row> | ||
| 99 | |||
| 100 | <row> | ||
| 101 | <entry>Architecture and Description</entry> | ||
| 102 | |||
| 103 | <entry>ELTF_T_ARC_DESC</entry> | ||
| 104 | </row> | ||
| 105 | |||
| 106 | <row> | ||
| 107 | <entry>Link to target datasheet</entry> | ||
| 108 | |||
| 109 | <entry>See <ulink | ||
| 110 | url="ELTF_T_DS_URL">ELTF_T_DS_TXTURL</ulink></entry> | ||
| 111 | </row> | ||
| 112 | |||
| 113 | <row> | ||
| 114 | <entry>Poky version</entry> | ||
| 115 | |||
| 116 | <entry>ELTF_T_POKY_VER</entry> | ||
| 117 | </row> | ||
| 118 | |||
| 119 | <row> | ||
| 120 | <entry>GCC version</entry> | ||
| 121 | |||
| 122 | <entry>ELTF_T_GCC_VER</entry> | ||
| 123 | </row> | ||
| 124 | |||
| 125 | <row> | ||
| 126 | <entry>Linux Kernel Version</entry> | ||
| 127 | |||
| 128 | <entry>ELTF_T_KERN_VER</entry> | ||
| 129 | </row> | ||
| 130 | |||
| 131 | <row> | ||
| 132 | <entry>Supported Drivers</entry> | ||
| 133 | |||
| 134 | <entry>ELTF_T_DRIVERS</entry> | ||
| 135 | </row> | ||
| 136 | |||
| 137 | <row> | ||
| 138 | <entry>Enea rpm folder for downloading RPM packages for this | ||
| 139 | target</entry> | ||
| 140 | |||
| 141 | <entry><ulink | ||
| 142 | url="ELTF_T_EL_RPM_URL">ELTF_T_EL_RPM_TXTURL</ulink></entry> | ||
| 143 | </row> | ||
| 144 | </tbody> | ||
| 145 | </tgroup> | ||
| 146 | </informaltable></para> | ||
| 147 | </section> | ||
| 148 | |||
| 149 | <!-- ELTFADD_MORE_TARGET_SECTIONS_BELOW_IF_NEEDED --> | ||
| 150 | </section> | ||
| 151 | </section> \ No newline at end of file | ||
diff --git a/doc/eltf_params_updated.xml b/doc/eltf_params_updated.xml new file mode 100644 index 0000000..f5f3f7d --- /dev/null +++ b/doc/eltf_params_updated.xml | |||
| @@ -0,0 +1,173 @@ | |||
| 1 | <?xml version="1.0" encoding="UTF-8"?> | ||
| 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 | <section id="host_prereq"> | ||
| 8 | <title>Common Parameters</title> | ||
| 9 | |||
| 10 | <bridgehead>Several phrase elements, various IDs. Ensure EL_REL_VER is | ||
| 11 | correct also compared to the "previous" REL VER in pardoc-distro.xml | ||
| 12 | "prev_baseline".</bridgehead> | ||
| 13 | |||
| 14 | <para id="EneaEdge_REL_VER"><phrase>2.5.0</phrase></para> | ||
| 15 | |||
| 16 | <para id="ENA_BUILD_VER"><phrase>1</phrase></para> | ||
| 17 | |||
| 18 | <bridgehead>Below is one big section with title "Supported Processor with | ||
| 19 | Parameters". The entire section is included completely in the book via ID | ||
| 20 | "eltf-target-tables-section" and shall be LAST in the template. The | ||
| 21 | template contains ONE target subsection. COPY/APPEND it, if multiple | ||
| 22 | targets exist in the release and optionally add rows with additional | ||
| 23 | target parameters in each target subsection table.</bridgehead> | ||
| 24 | </section> | ||
| 25 | |||
| 26 | <section id="eltf-target-tables-section"> | ||
| 27 | <title>Reference Processors with Parameters</title> | ||
| 28 | |||
| 29 | <para>The table(s) below describes the tested processors for this Enea | ||
| 30 | Edge release.</para> | ||
| 31 | |||
| 32 | <table> | ||
| 33 | <title>Processor Product Family Information - Intel Xeon D-1500</title> | ||
| 34 | |||
| 35 | <tgroup cols="2"> | ||
| 36 | <colspec align="left" /> | ||
| 37 | |||
| 38 | <thead> | ||
| 39 | <row> | ||
| 40 | <entry align="center">Component</entry> | ||
| 41 | |||
| 42 | <entry align="center">Description</entry> | ||
| 43 | </row> | ||
| 44 | </thead> | ||
| 45 | |||
| 46 | <tbody> | ||
| 47 | <row> | ||
| 48 | <entry>Processor official product family name</entry> | ||
| 49 | |||
| 50 | <entry>Intel Xeon D-1500 (Broadwell)</entry> | ||
| 51 | </row> | ||
| 52 | |||
| 53 | <row> | ||
| 54 | <entry>Architecture and Description</entry> | ||
| 55 | |||
| 56 | <entry>x86-64</entry> | ||
| 57 | </row> | ||
| 58 | |||
| 59 | <row> | ||
| 60 | <entry>Link to processor datasheet</entry> | ||
| 61 | |||
| 62 | <entry><ulink | ||
| 63 | url="https://www.intel.com/content/www/us/en/processors/xeon/xeon-d-1500-datasheet-vol-1.html">Intel's | ||
| 64 | datasheet</ulink></entry> | ||
| 65 | </row> | ||
| 66 | |||
| 67 | <row condition="hidden"> | ||
| 68 | <entry>Supported Drivers</entry> | ||
| 69 | |||
| 70 | <entry>Ethernet, RTC, UART</entry> | ||
| 71 | </row> | ||
| 72 | |||
| 73 | <row> | ||
| 74 | <entry>Tested Whiteboxes</entry> | ||
| 75 | |||
| 76 | <entrytbl cols="1"> | ||
| 77 | <tbody> | ||
| 78 | <row> | ||
| 79 | <entry>Supermicro X10SDV-4C-TLN2F (Intel Xeon | ||
| 80 | D-1521)</entry> | ||
| 81 | </row> | ||
| 82 | |||
| 83 | <row> | ||
| 84 | <entry>Kontron ME1100 (Intel Xeon D-1548).</entry> | ||
| 85 | </row> | ||
| 86 | </tbody> | ||
| 87 | </entrytbl> | ||
| 88 | </row> | ||
| 89 | </tbody> | ||
| 90 | </tgroup> | ||
| 91 | </table> | ||
| 92 | |||
| 93 | <table> | ||
| 94 | <title>Processor Product Family Information - Intel Atom C3000</title> | ||
| 95 | |||
| 96 | <tgroup cols="2"> | ||
| 97 | <colspec align="left" /> | ||
| 98 | |||
| 99 | <thead> | ||
| 100 | <row> | ||
| 101 | <entry align="center">Component</entry> | ||
| 102 | |||
| 103 | <entry align="center">Description</entry> | ||
| 104 | </row> | ||
| 105 | </thead> | ||
| 106 | |||
| 107 | <tbody> | ||
| 108 | <row> | ||
| 109 | <entry>Processor official product family name</entry> | ||
| 110 | |||
| 111 | <entry>Intel Atom C3000 (Denverton)</entry> | ||
| 112 | </row> | ||
| 113 | |||
| 114 | <row> | ||
| 115 | <entry>Architecture and Description</entry> | ||
| 116 | |||
| 117 | <entry>x86-64</entry> | ||
| 118 | </row> | ||
| 119 | |||
| 120 | <row> | ||
| 121 | <entry>Link to the processor datasheet</entry> | ||
| 122 | |||
| 123 | <entry><ulink | ||
| 124 | url="https://www.intel.com/content/www/us/en/products/docs/processors/atom/c-series/c3000-family-datasheet.html">Intel's | ||
| 125 | datasheet</ulink></entry> | ||
| 126 | </row> | ||
| 127 | |||
| 128 | <row condition="hidden"> | ||
| 129 | <entry>Supported Drivers</entry> | ||
| 130 | |||
| 131 | <entry>Ethernet, RTC, UART</entry> | ||
| 132 | </row> | ||
| 133 | |||
| 134 | <row> | ||
| 135 | <entry>Tested Whiteboxes</entry> | ||
| 136 | |||
| 137 | <entrytbl cols="1"> | ||
| 138 | <tbody> | ||
| 139 | <row> | ||
| 140 | <entry>Dell EMC Networking VEP1445 (Intel Atom | ||
| 141 | C3758)</entry> | ||
| 142 | </row> | ||
| 143 | |||
| 144 | <row> | ||
| 145 | <entry>Advantech FWA-1012VCR-4CA1S (Intel Atom | ||
| 146 | C3558)</entry> | ||
| 147 | </row> | ||
| 148 | |||
| 149 | <row> | ||
| 150 | <entry>Advantech FWA-1112VCL-2CA1S (Intel Atom | ||
| 151 | C3558-4C)</entry> | ||
| 152 | </row> | ||
| 153 | |||
| 154 | <row> | ||
| 155 | <entry>Supermicro A2SDi-TP8F (Intel Atom C3858)</entry> | ||
| 156 | </row> | ||
| 157 | |||
| 158 | <row> | ||
| 159 | <entry>Supermicro SuperServer 5019A-12TN4 (Intel Atom | ||
| 160 | C3850)</entry> | ||
| 161 | </row> | ||
| 162 | |||
| 163 | <row> | ||
| 164 | <entry>Silicom C3000 (Intel Atom 3558)</entry> | ||
| 165 | </row> | ||
| 166 | </tbody> | ||
| 167 | </entrytbl> | ||
| 168 | </row> | ||
| 169 | </tbody> | ||
| 170 | </tgroup> | ||
| 171 | </table> | ||
| 172 | </section> | ||
| 173 | </section> \ No newline at end of file | ||
diff --git a/doc/eltf_params_updated_template_how_to_use.txt b/doc/eltf_params_updated_template_how_to_use.txt new file mode 100644 index 0000000..97b07aa --- /dev/null +++ b/doc/eltf_params_updated_template_how_to_use.txt | |||
| @@ -0,0 +1,320 @@ | |||
| 1 | eltf_params_template_updated_howto_use.txt | ||
| 2 | |||
| 3 | This is a way to collect all parameters for an Enea Edge release | ||
| 4 | in one parameter file, easy to automatically update by ELTF regularly. | ||
| 5 | |||
| 6 | NOTE: Both the release info AND the open source books use parameters from | ||
| 7 | here, but the XML file is inside the release info book directory. | ||
| 8 | |||
| 9 | NOTE: The manifest_conf.mk, or overridden by the environment variable | ||
| 10 | MANIFESTHASH, contains the full tag (or hashvalue) for downloading | ||
| 11 | the manifest when the books are built. The list of target | ||
| 12 | directories are fetched from the manifest into the book. | ||
| 13 | The eltf_params_updates.xml can all the time contain | ||
| 14 | the final next complete tag e.g. refs/tags/EL6 or similar | ||
| 15 | in the ELTF_PL_CLONE_W_REPO parameter command lines. | ||
| 16 | |||
| 17 | The ordinary book XML files use xi:include statements to include elements | ||
| 18 | from this parameter file. The book XML files can thus be manually edited. | ||
| 19 | Before editing, you must run "make init". | ||
| 20 | Any other text in the template or updated.xml file, outside the parts that | ||
| 21 | are included in the book, are not used but still all must be correct | ||
| 22 | DocBook XML files. | ||
| 23 | |||
| 24 | ELTF work: | ||
| 25 | template => ELTF replaces ALL ELTF_xxx variables => updated XML file | ||
| 26 | => push to git only if changed | ||
| 27 | |||
| 28 | |||
| 29 | eltf_params_template.xml (in git) | ||
| 30 | File used by ELTF to autocreate/update the real parameter | ||
| 31 | file eltf_params_updated.xml. | ||
| 32 | |||
| 33 | eltf_params_updated.xml (in git) | ||
| 34 | Real parameter file where ELTF has replaced all ELTF_xx variables with | ||
| 35 | strings, in several cases with multiline strings. | ||
| 36 | No spaces or linefeed allowed in beginning or end of the variable values! | ||
| 37 | |||
| 38 | |||
| 39 | xi:include: Each parameter is xi:include'ed in various book files, using | ||
| 40 | the IDs existing in the parameter files. | ||
| 41 | In most cases the 1:st element inside an element with an ID is included | ||
| 42 | using a format like eltf-prereq-apt-get-commands-host/1. | ||
| 43 | In very few cases the element with the ID is included in the book, one | ||
| 44 | example is the target section which has an ID, but which contains | ||
| 45 | multiple subsections, one per target. | ||
| 46 | All IDs in a book must be unique. | ||
| 47 | |||
| 48 | DocBook XML: All XML files must be correct DocBook XML files. | ||
| 49 | |||
| 50 | Do NOT edit/save the real *updated.xml file with XMLmind to avoid changes | ||
| 51 | not done by ELTF. But it is OK to open the real file in XMLmind to | ||
| 52 | check that the format is correct. | ||
| 53 | |||
| 54 | ELTF should autocreate a temporary "real" file but only replace | ||
| 55 | and push the eltf_params_updated.xml if it is changed. | ||
| 56 | |||
| 57 | |||
| 58 | make eltf | ||
| 59 | This lists all ELTF_xxx variables and some rules how to treat them | ||
| 60 | |||
| 61 | DocBook Format: All elements - rules: | ||
| 62 | Several strict generic XML rules apply for all strings: | ||
| 63 | 1. No TABs allowed or any other control chr than "linefeed" | ||
| 64 | 2. Only 7-bit ASCII | ||
| 65 | 3. Any < > & must be converted to < > and & | ||
| 66 | Similar for any other non-7-bit-ASCII but avoid those! | ||
| 67 | 4. No leading spaces or linefeeds when replacing the ELTF_* variable | ||
| 68 | 5. No trailing spaces or linefeeds when replacing the ELTF_* variable | ||
| 69 | 6. Note: Keep existing spaces before/efter ELTF_* in a few cases. | ||
| 70 | |||
| 71 | DocBook Format: <programlisting> - rules: ELTF*PL* variables | ||
| 72 | Several strict rules apply for the multiline string in programlisting | ||
| 73 | in addition to the general XML rules above: | ||
| 74 | 7. Max line length < 80 char | ||
| 75 | 8. Use backslash (\) to break longer lines | ||
| 76 | 9. Use spaces (e.g. 4) to indent continuation lines in programlistings | ||
| 77 | 10. No trailing spaces on any line | ||
| 78 | 11. No spaces or linefeed immediately after leading <programlisting> | ||
| 79 | 12. No spaces or linefeed before trailing </programlisting> | ||
| 80 | |||
| 81 | DocBook Format: <ulink> - rules: ELTF_*URL* variables | ||
| 82 | 13. ELTF_*URL and corresponding ELTF_*TXTURL shall be identical strings | ||
| 83 | 14. Only if the URL is extremely long, the TXTURL can be a separate string | ||
| 84 | |||
| 85 | Each target has one section with target parameters: | ||
| 86 | <section id="eltf-target-table-ELTF_T_MANIFEST_DIR"> | ||
| 87 | <title>MACHINE ELTF_T_MANIFEST_DIR - Information</title> | ||
| 88 | ..... with many ELTF_ variables .... | ||
| 89 | </section> | ||
| 90 | |||
| 91 | 15. If there is only one target. ELTF just replaces ELTF parameters | ||
| 92 | |||
| 93 | 16. It there are multiple targets. ELTF copies the section and appends the | ||
| 94 | section the required number of times. | ||
| 95 | Each section ID will become unique: eltf-target-table-ELTF_T_MANIFEST_DIR | ||
| 96 | Each section title will become unique | ||
| 97 | |||
| 98 | Tables with target parameters in each target section: | ||
| 99 | 17. It is possible for ELTF to append more rows with one parameter each | ||
| 100 | to these tables, because the entire tables are included in the book | ||
| 101 | |||
| 102 | Special - NOT YET READY DEFINED how to handle the optionally included | ||
| 103 | Eclipse and its version, but this is a first suggestion: | ||
| 104 | 18. Just now ELTF can define ELFT_ECLIPSE_VERSION as a full string | ||
| 105 | with both version number and name, | ||
| 106 | 19. MANUALLY if Eclipse is NOT included in the release, | ||
| 107 | the release manager should manually set condition="hidden" on | ||
| 108 | the entire section in the book XML about Eclipse | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | BELOW WE TRY TO EXPLAIN EACH ELTF_* variable, but always check with make eltf | ||
| 113 | if there are more new variables, missing in this description file. | ||
| 114 | |||
| 115 | _____________________________________________________________________________ | ||
| 116 | ELTF_PL_HOST_PREREQ Multiline list of host prerequisites, e.g. commands | ||
| 117 | like sudo apt-get install xxxx or similar. | ||
| 118 | First line = comment with the complete host name! | ||
| 119 | It is possible to include multiple hosts by just | ||
| 120 | adding an empty line, comment with host name, etc. | ||
| 121 | xi:include eltf-prereq-apt-get-commands-host/1 | ||
| 122 | This is a <programlisting>...</programlisting> | ||
| 123 | Example: | ||
| 124 | # Host Ubuntu 14.04.5 LTS 64bit | ||
| 125 | sudo apt-get update | ||
| 126 | sudo apt-get install sed wget subversion git-core coreutils unzip texi2html \ | ||
| 127 | texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \ | ||
| 128 | make gcc build-essential xsltproc g++ desktop-file-utils chrpath \ | ||
| 129 | libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \ | ||
| 130 | libxml-parser-perl | ||
| 131 | |||
| 132 | _____________________________________________________________________________ | ||
| 133 | ELTF_PL_GET_REPO Multiline commands to download the repo tool | ||
| 134 | xi:include eltf-getting-repo-install-command/1 | ||
| 135 | This is a <programlisting>...</programlisting> | ||
| 136 | Example: | ||
| 137 | mkdir -p ~/bin | ||
| 138 | curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo | ||
| 139 | chmod a+x ~/bin/repo | ||
| 140 | export PATH=~/bin:$PATH | ||
| 141 | |||
| 142 | _____________________________________________________________________________ | ||
| 143 | ELTF_EL_REL_VER General parameter string: The version of this Enea | ||
| 144 | NFV Access release. Major version and optional .Minor | ||
| 145 | Typically created from MAJOR and MINOR in enea.conf | ||
| 146 | MINOR in enea.conf is empty or contains a dot+minor | ||
| 147 | xi_include EneaEdge_REL_VER/1 | ||
| 148 | This is a <phrase>X.x</phrase> used in many places. | ||
| 149 | Examples: | ||
| 150 | 6 | ||
| 151 | or | ||
| 152 | 6.1 | ||
| 153 | |||
| 154 | _____________________________________________________________________________ | ||
| 155 | ELTF_YOCTO_VER General parameter string: Yocto version, created | ||
| 156 | from DISTRO in poky.ent | ||
| 157 | xi:include Yocto_VER/1 | ||
| 158 | This is a <phrase>X.x</phrase> used in many places. | ||
| 159 | Example: | ||
| 160 | 2.1 | ||
| 161 | |||
| 162 | _____________________________________________________________________________ | ||
| 163 | ELTF_YOCTO_NAME General parameter string: Yocto name (branch), created | ||
| 164 | from DISTRO_NAME_NO_CAP in poky.ent | ||
| 165 | xi:include Yocto_NAME/1 | ||
| 166 | This is a <phrase>X.x</phrase> used in many places. | ||
| 167 | Example: | ||
| 168 | krogoth | ||
| 169 | |||
| 170 | _____________________________________________________________________________ | ||
| 171 | ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL | ||
| 172 | ELTF_YOCTO_PROJ_DOWNLOAD_URL strings with correct Yocto version string | ||
| 173 | at the end, typically without "dot". | ||
| 174 | xi:include ULINK_YOCTO_PROJECT_DOWNLOAD/1 | ||
| 175 | This is an <ulink url="...">...</ulink> | ||
| 176 | Example: | ||
| 177 | http://www.yoctoproject.org/downloads/core/krogoth/21 | ||
| 178 | |||
| 179 | _____________________________________________________________________________ | ||
| 180 | ELTF_EL_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL strings | ||
| 181 | ELTF_EL_DOWNLOAD_URL and shall be the http:/..... address where | ||
| 182 | Enea NFV Access can be downloaded | ||
| 183 | Often containing same version as in ELTF_EL_REL_VER | ||
| 184 | xi:include ULINK_ENEA_LINUX_URL/1 | ||
| 185 | This is an <ulink url="...">...</ulink> | ||
| 186 | Example: | ||
| 187 | http://linux.enea.com/6 | ||
| 188 | |||
| 189 | _____________________________________________________________________________ | ||
| 190 | ELTF_PL_CLONE_W_REPO Multiline commands to run repo to clone everything. | ||
| 191 | Use the variable $MACHINE/default.xml (the text in | ||
| 192 | the book will list the avaiable values of MACHINE, | ||
| 193 | taken from the manifest repository) | ||
| 194 | xi:include eltf-repo-cloning-enea-linux/1 | ||
| 195 | This is a <programlisting>...</programlisting> | ||
| 196 | Example: | ||
| 197 | mkdir enea-linux | ||
| 198 | cd enea-linux | ||
| 199 | repo init -u git@git.enea.com:linux/manifests/el_manifests-virtualization.git \ | ||
| 200 | -b refs/tags/EL6 -m $MACHINE/default.xml | ||
| 201 | repo sync | ||
| 202 | |||
| 203 | _____________________________________________________________________________ | ||
| 204 | ELTF_ECLIPSE_VERSION Optional general parameter string. | ||
| 205 | NOT YET READY DEFINED | ||
| 206 | Just now a release manage must manually set | ||
| 207 | condition="hidden" on the Eclipse section, | ||
| 208 | if Eclipse is not included in the release. | ||
| 209 | ELTF just replaces ELTF_ECLIPSE_VERSION with a full | ||
| 210 | string with "X.Y (name)" | ||
| 211 | It includes the ID and can only be ONCE in the book. | ||
| 212 | xi:include eltf-eclipse-version-row | ||
| 213 | Example. | ||
| 214 | 4.5 (Mars) | ||
| 215 | |||
| 216 | |||
| 217 | _____________________________________________________________________________ | ||
| 218 | ELTF_T_* All these are in each target (MACHINE) and ELTF | ||
| 219 | must separately replace them with strings for | ||
| 220 | each target | ||
| 221 | NOTE: All (except the MANIFEST_DIR) are in rows | ||
| 222 | in a table and ELTF can select to append | ||
| 223 | more parameters by adding more rows | ||
| 224 | |||
| 225 | _____________________________________________________________________________ | ||
| 226 | ELTF_T_MANIFEST_DIR This happens to be in two places. Must be exactly | ||
| 227 | ELTF_T_MANIFEST_DIR the directory name in the manifest, e.g. same | ||
| 228 | as the MACHINE names in $MACHINE/default.xml. | ||
| 229 | In book: a) Part of section ID | ||
| 230 | b) Part of section title | ||
| 231 | Examples: | ||
| 232 | p2041rgb | ||
| 233 | or | ||
| 234 | ls1021aiot | ||
| 235 | or | ||
| 236 | qemuarm | ||
| 237 | |||
| 238 | _____________________________________________________________________________ | ||
| 239 | ELTF_T_NAME Target specific: "Target Official Name" | ||
| 240 | NOT same as the target directory name in most cases. | ||
| 241 | In book: An <entry> element in a row | ||
| 242 | Examples: | ||
| 243 | P2041RGB | ||
| 244 | or | ||
| 245 | LS1021a-IoT | ||
| 246 | or | ||
| 247 | qemuarm | ||
| 248 | |||
| 249 | _____________________________________________________________________________ | ||
| 250 | ELTF_T_ARC_DESC Target specific: "Architecture and Description" | ||
| 251 | It can be a short identification string or | ||
| 252 | it can be a longer descriptive sentence. | ||
| 253 | In book: An <entry> element in a row | ||
| 254 | Examples: | ||
| 255 | Power, e500mc | ||
| 256 | or | ||
| 257 | ARM Cortex-A7 | ||
| 258 | |||
| 259 | _____________________________________________________________________________ | ||
| 260 | ELTF_T_DS_TXTURL Target specific: "Link to target datasheet. These | ||
| 261 | ELTF_T_DS_URL two usually are IDENTICAL strings with correct | ||
| 262 | hyperlink to the target's official datasheet. | ||
| 263 | In book: an <ulink url="...">...</ulink> | ||
| 264 | Only if the link is VERY LONG, the text part shall | ||
| 265 | instead be a descriptive string (see 2:nd example). | ||
| 266 | NOTE: Also here no spaces or line-feeds! | ||
| 267 | Examples: | ||
| 268 | url="http://wiki.qemu.org">http://wiki.qemu.org | ||
| 269 | or | ||
| 270 | url="http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors/qoriq-ls1021a-iot-gateway-reference-design:LS1021A-IoT">link to NXP's datasheet | ||
| 271 | |||
| 272 | _____________________________________________________________________________ | ||
| 273 | ELTF_T_POKY_VER Target specific: "Poky version" created either | ||
| 274 | from POKYVERSION in poky.ent | ||
| 275 | or using a hashvalue with a leading string, in | ||
| 276 | which case it may be different per target. | ||
| 277 | In book: An <entry> in a row | ||
| 278 | Examples: | ||
| 279 | 15.0.0 | ||
| 280 | or | ||
| 281 | Git commit id: 75ca53211488a3e268037a44ee2a7ac5c7181bd2 | ||
| 282 | |||
| 283 | _____________________________________________________________________________ | ||
| 284 | ELTF_T_GCC_VER Target specific: "GCC Version". Should be in poky | ||
| 285 | but not easy to find among various parameters. | ||
| 286 | ELTF would extract it from build logs building SDK | ||
| 287 | and it is possibly different per target. | ||
| 288 | In book: An <entry> in a row | ||
| 289 | Example: | ||
| 290 | 5.3 | ||
| 291 | |||
| 292 | _____________________________________________________________________________ | ||
| 293 | ELTF_T_KERN_VER Target specific: "Linux Kernel Version". Often | ||
| 294 | different per target. | ||
| 295 | In book: An <entry> in a row | ||
| 296 | Example: | ||
| 297 | 3.12 | ||
| 298 | |||
| 299 | _____________________________________________________________________________ | ||
| 300 | ELTF_T_DRIVERS Target specific: "Supported Drivers". This is a | ||
| 301 | comma-separated list of driver names. | ||
| 302 | ELTF should create the list in same order for each | ||
| 303 | target, e.g. alphabetic migth be OK. | ||
| 304 | In book: An <entry> in a row | ||
| 305 | Example: | ||
| 306 | Ethernet, I2C, SPI, PCI, USB, SD/SDHC/SDXC | ||
| 307 | |||
| 308 | |||
| 309 | _____________________________________________________________________________ | ||
| 310 | ELTF_T_EL_RPM_TXTURL Target specific: "Enea rpm folder for downloading | ||
| 311 | ELTF_T_EL_RPM_URL RPM packages for this target". These two are | ||
| 312 | INDENTICAL strings with hyperlink to the web site | ||
| 313 | at Enea where the customer can download RPMs | ||
| 314 | Note: Often the ELFT_EL_REL_VER value and | ||
| 315 | the ELTF_T_MANIFEST_DIR are used in the link. | ||
| 316 | In book: an <ulink url="...">...</ulink> | ||
| 317 | Example: | ||
| 318 | url="https://linux.enea.com/6/ls1021aiot/rpm">https://linux.enea.com/6/ls1021aiot/rpm | ||
| 319 | |||
| 320 | _____________________________________________________________________________ | ||
