From 9544fb3595a9a47376b04070a3e0f99eb87e49ae Mon Sep 17 00:00:00 2001 From: Miruna Paun Date: Wed, 9 Aug 2017 11:10:23 +0200 Subject: Fixing issues caused by moving certain xml files to el-common INTCR-0 Signed-off-by: Miruna Paun --- doc/Makefile | 2 +- doc/book-enea-nfv-access-guide/doc/book.xml | 2 - .../doc/eltf_params_template.xml | 2 +- .../doc/eltf_params_updated.xml | 8 +- .../eltf_params_updated_template_how_to_use.txt | 320 ------------------- .../doc/getting_started.xml | 45 +-- .../doc/about_release.xml | 341 +++++++-------------- doc/book-enea-nfv-access-release-info/doc/book.xml | 47 ++- .../doc/eltf_params_updated.xml | 6 +- .../doc/getting_enea_nfv_access.xml | 59 ++-- .../doc/known_bugs_and_limitations.xml | 240 +-------------- .../doc/main_changes.xml | 22 +- .../doc/prerequisites.xml | 34 -- .../doc/system_requirements_prerequisites.xml | 34 ++ doc/init.mk | 2 +- 15 files changed, 239 insertions(+), 925 deletions(-) delete mode 100644 doc/book-enea-nfv-access-guide/doc/eltf_params_updated_template_how_to_use.txt delete mode 100644 doc/book-enea-nfv-access-release-info/doc/prerequisites.xml create mode 100644 doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml diff --git a/doc/Makefile b/doc/Makefile index 70135de..469bd65 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -48,7 +48,7 @@ DOCBOOK_TO_BOOKDIR ?= yes DOCBOOK_CLEANTMP ?= yes #Components (books) in this subsystem. Now use all books found here -# COMPONENTS := book-enea-nfv-access-release-info book-enea-linux-open-source +COMPONENTS := book-enea-nfv-access-release-info book-enea-linux-open-source # COMPONENTS += book-enea-linux-eclipse-open-source (as of 13.04.2017 this is not needed) COMPONENTS := $(shell ls -d book-enea* ) diff --git a/doc/book-enea-nfv-access-guide/doc/book.xml b/doc/book-enea-nfv-access-guide/doc/book.xml index f23213c..368f9ba 100644 --- a/doc/book-enea-nfv-access-guide/doc/book.xml +++ b/doc/book-enea-nfv-access-guide/doc/book.xml @@ -25,6 +25,4 @@ xmlns:xi="http://www.w3.org/2001/XInclude" /> - diff --git a/doc/book-enea-nfv-access-guide/doc/eltf_params_template.xml b/doc/book-enea-nfv-access-guide/doc/eltf_params_template.xml index 862eb23..eaa7ebd 100644 --- a/doc/book-enea-nfv-access-guide/doc/eltf_params_template.xml +++ b/doc/book-enea-nfv-access-guide/doc/eltf_params_template.xml @@ -79,7 +79,7 @@ Supported Targets with Parameters The tables below describes the target(s) supported in this Enea - Linux release. + NFV Access release.
MACHINE ELTF_T_MANIFEST_DIR - Information diff --git a/doc/book-enea-nfv-access-guide/doc/eltf_params_updated.xml b/doc/book-enea-nfv-access-guide/doc/eltf_params_updated.xml index 424751e..f6bd068 100644 --- a/doc/book-enea-nfv-access-guide/doc/eltf_params_updated.xml +++ b/doc/book-enea-nfv-access-guide/doc/eltf_params_updated.xml @@ -60,7 +60,7 @@ export PATH=~/bin:$PATH mkdir enea-linux cd enea-linux -repo init -u git://git.enea.com/linux/el_manifests-networking.git \ +repo init -u git@git.enea.com:linux/manifests/el_manifests-virtualization.git \ -b refs/tags/EL6 -m $MACHINE/default.xml repo sync @@ -89,10 +89,10 @@ repo sync
- Supported Targets with Parameters + Supported Reference Boards with Parameters - The tables below describes the target(s) supported in this Enea - Linux release. + The tables below describes the target(s) supported in this Enea NFV + Access release.
MACHINE p2041rdb - Information diff --git a/doc/book-enea-nfv-access-guide/doc/eltf_params_updated_template_how_to_use.txt b/doc/book-enea-nfv-access-guide/doc/eltf_params_updated_template_how_to_use.txt deleted file mode 100644 index 87a6445..0000000 --- a/doc/book-enea-nfv-access-guide/doc/eltf_params_updated_template_how_to_use.txt +++ /dev/null @@ -1,320 +0,0 @@ -eltf_params_template_updated_howto_use.txt - -This is a way to collect all parameters for an Enea NFV Access release -in one parameter file, easy to automatically update by ELTF regularly. - -NOTE: Both the release info AND the open source books use parameters from - here, but the XML file is inside the release info book directory. - -NOTE: The manifest_conf.mk, or overridden by the environment variable - MANIFESTHASH, contains the full tag (or hashvalue) for downloading - the manifest when the books are built. The list of target - directories are fetched from the manifest into the book. - The eltf_params_updates.xml can all the time contain - the final next complete tag e.g. refs/tags/EL6 or similar - in the ELTF_PL_CLONE_W_REPO parameter command lines. - -The ordinary book XML files use xi:include statements to include elements -from this parameter file. The book XML files can thus be manually edited. -Before editing, you must run "make init". -Any other text in the template or updated.xml file, outside the parts that -are included in the book, are not used but still all must be correct -DocBook XML files. - -ELTF work: - template => ELTF replaces ALL ELTF_xxx variables => updated XML file - => push to git only if changed - - -eltf_params_template.xml (in git) - File used by ELTF to autocreate/update the real parameter - file eltf_params_updated.xml. - -eltf_params_updated.xml (in git) - Real parameter file where ELTF has replaced all ELTF_xx variables with - strings, in several cases with multiline strings. - No spaces or linefeed allowed in beginning or end of the variable values! - - -xi:include: Each parameter is xi:include'ed in various book files, using - the IDs existing in the parameter files. - In most cases the 1:st element inside an element with an ID is included - using a format like eltf-prereq-apt-get-commands-host/1. - In very few cases the element with the ID is included in the book, one - example is the target section which has an ID, but which contains - multiple subsections, one per target. - All IDs in a book must be unique. - -DocBook XML: All XML files must be correct DocBook XML files. - -Do NOT edit/save the real *updated.xml file with XMLmind to avoid changes - not done by ELTF. But it is OK to open the real file in XMLmind to - check that the format is correct. - -ELTF should autocreate a temporary "real" file but only replace - and push the eltf_params_updated.xml if it is changed. - - -make eltf - This lists all ELTF_xxx variables and some rules how to treat them - -DocBook Format: All elements - rules: - Several strict generic XML rules apply for all strings: - 1. No TABs allowed or any other control chr than "linefeed" - 2. Only 7-bit ASCII - 3. Any < > & must be converted to < > and & - Similar for any other non-7-bit-ASCII but avoid those! - 4. No leading spaces or linefeeds when replacing the ELTF_* variable - 5. No trailing spaces or linefeeds when replacing the ELTF_* variable - 6. Note: Keep existing spaces before/efter ELTF_* in a few cases. - -DocBook Format: - rules: ELTF*PL* variables - Several strict rules apply for the multiline string in programlisting - in addition to the general XML rules above: - 7. Max line length < 80 char - 8. Use backslash (\) to break longer lines - 9. Use spaces (e.g. 4) to indent continuation lines in programlistings - 10. No trailing spaces on any line - 11. No spaces or linefeed immediately after leading - 12. No spaces or linefeed before trailing - -DocBook Format: - rules: ELTF_*URL* variables - 13. ELTF_*URL and corresponding ELTF_*TXTURL shall be identical strings - 14. Only if the URL is extremely long, the TXTURL can be a separate string - -Each target has one section with target parameters: -
- MACHINE ELTF_T_MANIFEST_DIR - Information - ..... with many ELTF_ variables .... -
- - 15. If there is only one target. ELTF just replaces ELTF parameters - - 16. It there are multiple targets. ELTF copies the section and appends the - section the required number of times. - Each section ID will become unique: eltf-target-table-ELTF_T_MANIFEST_DIR - Each section title will become unique - -Tables with target parameters in each target section: - 17. It is possible for ELTF to append more rows with one parameter each - to these tables, because the entire tables are included in the book - -Special - NOT YET READY DEFINED how to handle the optionally included - Eclipse and its version, but this is a first suggestion: - 18. Just now ELTF can define ELFT_ECLIPSE_VERSION as a full string - with both version number and name, - 19. MANUALLY if Eclipse is NOT included in the release, - the release manager should manually set condition="hidden" on - the entire section in the book XML about Eclipse - - - -BELOW WE TRY TO EXPLAIN EACH ELTF_* variable, but always check with make eltf -if there are more new variables, missing in this description file. - -_____________________________________________________________________________ -ELTF_PL_HOST_PREREQ Multiline list of host prerequisites, e.g. commands - like sudo apt-get install xxxx or similar. - First line = comment with the complete host name! - It is possible to include multiple hosts by just - adding an empty line, comment with host name, etc. - xi:include eltf-prereq-apt-get-commands-host/1 - This is a ... - Example: -# Host Ubuntu 14.04.5 LTS 64bit -sudo apt-get update -sudo apt-get 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 - -_____________________________________________________________________________ -ELTF_PL_GET_REPO Multiline commands to download the repo tool - xi:include eltf-getting-repo-install-command/1 - This is a ... - Example: -mkdir -p ~/bin -curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo -chmod a+x ~/bin/repo -export PATH=~/bin:$PATH - -_____________________________________________________________________________ -ELTF_EL_REL_VER General parameter string: The version of this Enea - Linux release. Major version and optional .Minor - Typically created from MAJOR and MINOR in enea.conf - MINOR in enea.conf is empty or contains a dot+minor - xi_include EneaLinux_REL_VER/1 - This is a X.x used in many places. - Examples: -6 - or -6.1 - -_____________________________________________________________________________ -ELTF_YOCTO_VER General parameter string: Yocto version, created - from DISTRO in poky.ent - xi:include Yocto_VER/1 - This is a X.x used in many places. - Example: -2.1 - -_____________________________________________________________________________ -ELTF_YOCTO_NAME General parameter string: Yocto name (branch), created - from DISTRO_NAME_NO_CAP in poky.ent - xi:include Yocto_NAME/1 - This is a X.x used in many places. - Example: -krogoth - -_____________________________________________________________________________ -ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL -ELTF_YOCTO_PROJ_DOWNLOAD_URL strings with correct Yocto version string - at the end, typically without "dot". - xi:include ULINK_YOCTO_PROJECT_DOWNLOAD/1 - This is an ... - Example: -http://www.yoctoproject.org/downloads/core/krogoth/21 - -_____________________________________________________________________________ -ELTF_EL_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL strings -ELTF_EL_DOWNLOAD_URL and shall be the http:/..... address where - Enea NFV Access can be downloaded - Often containing same version as in ELTF_EL_REL_VER - xi:include ULINK_ENEA_LINUX_URL/1 - This is an ... - Example: -http://linux.enea.com/6 - -_____________________________________________________________________________ -ELTF_PL_CLONE_W_REPO Multiline commands to run repo to clone everything. - Use the variable $MACHINE/default.xml (the text in - the book will list the avaiable values of MACHINE, - taken from the manifest repository) - xi:include eltf-repo-cloning-enea-linux/1 - This is a ... - Example: -mkdir enea-linux -cd enea-linux -repo init -u git://git.enea.com/linux/el_manifests-standard.git \ - -b refs/tags/EL6 -m $MACHINE/default.xml -repo sync - -_____________________________________________________________________________ -ELTF_ECLIPSE_VERSION Optional general parameter string. - NOT YET READY DEFINED - Just now a release manage must manually set - condition="hidden" on the Eclipse section, - if Eclipse is not included in the release. - ELTF just replaces ELTF_ECLIPSE_VERSION with a full - string with "X.Y (name)" - It includes the ID and can only be ONCE in the book. - xi:include eltf-eclipse-version-row - Example. -4.5 (Mars) - - -_____________________________________________________________________________ -ELTF_T_* All these are in each target (MACHINE) and ELTF - must separately replace them with strings for - each target - NOTE: All (except the MANIFEST_DIR) are in rows - in a table and ELTF can select to append - more parameters by adding more rows - -_____________________________________________________________________________ -ELTF_T_MANIFEST_DIR This happens to be in two places. Must be exactly -ELTF_T_MANIFEST_DIR the directory name in the manifest, e.g. same - as the MACHINE names in $MACHINE/default.xml. - In book: a) Part of section ID - b) Part of section title - Examples: -p2041rgb - or -ls1021aiot - or -qemuarm - -_____________________________________________________________________________ -ELTF_T_NAME Target specific: "Target Official Name" - NOT same as the target directory name in most cases. - In book: An element in a row - Examples: -P2041RGB - or -LS1021a-IoT - or -qemuarm - -_____________________________________________________________________________ -ELTF_T_ARC_DESC Target specific: "Architecture and Description" - It can be a short identification string or - it can be a longer descriptive sentence. - In book: An element in a row - Examples: -Power, e500mc - or -ARM Cortex-A7 - -_____________________________________________________________________________ -ELTF_T_DS_TXTURL Target specific: "Link to target datasheet. These -ELTF_T_DS_URL two usually are IDENTICAL strings with correct - hyperlink to the target's official datasheet. - In book: an ... - Only if the link is VERY LONG, the text part shall - instead be a descriptive string (see 2:nd example). - NOTE: Also here no spaces or line-feeds! - Examples: -url="http://wiki.qemu.org">http://wiki.qemu.org -or -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 - -_____________________________________________________________________________ -ELTF_T_POKY_VER Target specific: "Poky version" created either - from POKYVERSION in poky.ent - or using a hashvalue with a leading string, in - which case it may be different per target. - In book: An in a row - Examples: -15.0.0 -or -Git commit id: 75ca53211488a3e268037a44ee2a7ac5c7181bd2 - -_____________________________________________________________________________ -ELTF_T_GCC_VER Target specific: "GCC Version". Should be in poky - but not easy to find among various parameters. - ELTF would extract it from build logs building SDK - and it is possibly different per target. - In book: An in a row - Example: -5.3 - -_____________________________________________________________________________ -ELTF_T_KERN_VER Target specific: "Linux Kernel Version". Often - different per target. - In book: An in a row - Example: -3.12 - -_____________________________________________________________________________ -ELTF_T_DRIVERS Target specific: "Supported Drivers". This is a - comma-separated list of driver names. - ELTF should create the list in same order for each - target, e.g. alphabetic migth be OK. - In book: An in a row - Example: -Ethernet, I2C, SPI, PCI, USB, SD/SDHC/SDXC - - -_____________________________________________________________________________ -ELTF_T_EL_RPM_TXTURL Target specific: "Enea rpm folder for downloading -ELTF_T_EL_RPM_URL RPM packages for this target". These two are - INDENTICAL strings with hyperlink to the web site - at Enea where the customer can download RPMs - Note: Often the ELFT_EL_REL_VER value and - the ELTF_T_MANIFEST_DIR are used in the link. - In book: an ... - Example: -url="https://linux.enea.com/6/ls1021aiot/rpm">https://linux.enea.com/6/ls1021aiot/rpm - -_____________________________________________________________________________ diff --git a/doc/book-enea-nfv-access-guide/doc/getting_started.xml b/doc/book-enea-nfv-access-guide/doc/getting_started.xml index fff4bd3..6c20d5e 100644 --- a/doc/book-enea-nfv-access-guide/doc/getting_started.xml +++ b/doc/book-enea-nfv-access-guide/doc/getting_started.xml @@ -90,37 +90,6 @@ /* GRUB EFI file */
-
- Included Documention - - Enea NFV Access is provided with the following set of - documents: - - - - Enea NFV Access Guide – A document describing the Enea NFV - Access release content and how to use it, as well as benchmark - results. - - - - Enea NFV Access Open Source Report – A document containing - the open source and license information pertaining to packages - provided with Enea NFV Access 1.0. - - - - Enea NFV Access Test Report – The document that summarizes - the test results for the Enea NFV Access release. - - - - Enea NFV Access Security Report – The document that lists - all security fixes included in the Enea NFV Access 1.0 release. - - -
-
How to use the Prebuilt Artifacts @@ -171,9 +140,9 @@ label el_ramfs Restart the target. Then enter (F11) in the Boot Menu and select the Ethernet interface used for PXE boot. From the PXE Boot Menu select - Enea NFV Access_RAMfs. Once the Enea NFV - Access is started you can partition the HDD/SDD and install - GRUB as described in in the following section. + Enea NFV Access_RAMfs. Once the Enea + NFV Access is started you can partition the HDD/SDD and install GRUB as + described in in the following section.
@@ -289,12 +258,10 @@ menuentry "Linux sda7" {
- Installing and booting Enea NFV Access on the - harddisk + Installing and booting Enea NFV Access on the harddisk - After partitioning the harddisk, boot Enea NFV Access - from RAMFS or from a reference image installed on one of the - partitions. + After partitioning the harddisk, boot Enea NFV Access from RAMFS + or from a reference image installed on one of the partitions. To install Enea NFV Access image on a partition follow these steps: diff --git a/doc/book-enea-nfv-access-release-info/doc/about_release.xml b/doc/book-enea-nfv-access-release-info/doc/about_release.xml index 203637c..a470845 100644 --- a/doc/book-enea-nfv-access-release-info/doc/about_release.xml +++ b/doc/book-enea-nfv-access-release-info/doc/about_release.xml @@ -4,8 +4,8 @@ About This Release - This release of Enea NFV Access This release of Enea NFV Access provides a publicly available Enea NFV Access distribution for a selected set of targets. This release is generated from the yocto -
- Provided Contents - - - - - - Item - - - - - - Source code, recipes and scripts for building the - distribution and SDKs. See . - - - - Documentation. See . - - - - Pre-built binaries (kernel image, dtb & rootfs) - - - - Pre-built packages (RPM). See links for each - target.INFO Below is an Eclipse row from - eltf_params_updated.xml. MANUALLY if eclipse is not included, set - condition hidden on the row element BOTH in template.xml and in - updated.xml. - - - - - - -
- -
- Supported Targets - - - - - - - - - - - - Target - - Architecture - - Specification - - - - - - P2041RDB - - Power, e500mc - - See link - to NXP's datasheet - - - - - - FIXME should autocreate a list of targets, hopefully from - the generated README file, by using MAKEFILE to update pardoc-distro - AND/OR also auto-create an XML file to include here with description text - for each target etc.. +
+ NFV Access Release content + + The NFV Access 1.0 Release contains along with other items, + documentation, pre-built kernels and images, a bootloader and a + SDK. + + The directories structure is detailed below: + + -- documentation/ + /* NFV Access documentation */ +-- inteld1521/ + /* artifacts for the host side */ + -- deb/ + /* deb packages */ + -- images/ + -- enea-image-virtualization-host + /* precompiled artifacts for the Host release image */ + -- various artifacts + -- enea-image-virtualization-host-sdk + /* precompiled artifacts for the Host SDK image. + The SDK image contains userspace tools and kernel + configurations necessary for developing, debugging + and profiling applications and kernel modules */ + -- various artifacts + -- sdk + /* NFV Access SDK for the host */ + -- enea-glibc-x86_64-enea-image-virtualization-host-sdk / + -corei7-64-toolchain-7.0.sh + /* self-extracting archive installing + cross-compilation toolchain for the host */ +-- qemux86-64 + /* artifacts for the guest side */ + -- deb/ + /* deb packages */ + -- images/ + -- enea-image-virtualization-guest + /* precompiled artifacts for the Guest image */ + -- various artifacts + -- sdk + /* NFV Access SDK for the guest */ + -- enea-glibc-x86_64-enea-image-virtualization-guest-sdk / + -core2-64-toolchain-7.0.sh + /* self-extracting archive installing cross-compilation + toolchain for the guest (QEMU x86-64) */ + + + For each combination of image and target, the following set of + artifacts is available: + + -- bzImage + /* kernel image */ +-- bzImage-<target>.bin + /* kernel image, same as above */ +-- config-<target>.config + /* kernel configuration file */ +-- core-image-minimal-initramfs-<target>.cpio.gz + /* cpio archive of the initramfs */ +-- core-image-minimal-initramfs-<target>.qemuboot.conf + /* qemu config file for the initramfs image */ +-- <image-name>-<target>.ext4 + /* EXT4 image of the rootfs */ +-- <image-name>-<target>.hddimg + /* msdos filesystem containing syslinux, kernel, initrd and rootfs image */ +-- <image-name>-<target>.iso + /* CD .iso image */ +-- <image-name>-<target>.qemuboot.conf + /* qemu config file for the image */ +-- <image-name>-<target>.tar.gz + /* tar archive of the image */ +-- <image-name>-<target>.wic + /* Wic image */ +-- microcode.cpio + /* kernel microcode data */ +-- modules-<target>.tgz + /* external kernel modules */ +-- ovmf.*.qcow2 + /* ovmf firmware for uefi support in qemu */ +-- rmc.db + /* Central RMC Database */ +-- systemd-bootx64.efi + /* systemd-boot EFI file */ +-- grub-efi-bootx64.efi + /* GRUB EFI file */
-
- Supported Host Environment - - - - Ubuntu 14.04 LTS, 64-bitHardcoded now in this XML file. - Might be moved to the parameter file later.INFO Below - is a complete section with ID "eltf-target-tables-section" included - from elft_params_updated.xml. It contains a variable number of target - tables and the section title should be "Supported Targets with - Parameters". It has have a short sentence about what it is in the - beginning. The subtitles shall have the directory name of the target - in the manifest. - - -
+ -
- Provided Packages - - - - - - - - - - Type of Packages - - Reference - - - - - - Packages in Enea NFV Access - - See the Enea NFV Access Open Source - Report - - - - - -
- -
- Provided Toolchain/s (SDK) +
+ Provided Toolchain(s) (SDK) The SDK contains toolchains supporting cross-compilation of applications for the targets on an x86_64 host. See the Provided Documentation - The following Enea NFV Access manuals are available: + Enea NFV Access is provided with the following set of + documents: - Enea NFV Access Release - Information (this document) - - - - Enea NFV Access Development - Guide - - - - Enea NFV Access Application Development - Guide + Enea NFV Access Guide + – A document describing how to use ENFV Access, as well as use + cases and benchmark results. - Enea NFV Access Networking - Profile Guide + Enea NFV Access Release Information – This document, + describing the Enea NFV Access release content - Enea NFV Access Open Source - Report + Enea NFV Access Open + Source Report – A document containing the open source + and license information pertaining to packages provided with Enea NFV + Access 1.0. - Enea NFV Access Eclipse Open Source - Report + Enea NFV Access Test Report – The document that summarizes + the test results for the Enea NFV Access release. - Enea NFV Access Test - Report - - - - Enea NFV Access Real-Time - Guide can be read at http://linuxrealtime.org. + Enea NFV Access Security Report – The document that lists + all security fixes included in the Enea NFV Access 1.0 release.
-
- Other Provided Functionality - - The functionality in a distribution depends on included packages in - the default image. In addition to the supported features, the following - functionality is also available, among other:INFO: This section - might be hidden by setting condition hidden on the section, MANUALLY in - this file. - - - - On target T4240RDB: - - - - SRIO support in user space (NWRITE, NREAD, msg, - doorbell) - - - - USDPAA - - - - - - Smart Package Management - - -
- -
- Security Fixes - - See List of - CVEs addressed in Enea NFV Access and How - to Get Security Updates. -
- -
- Intentional Limitations - - The following functionality supported in other Enea NFV Access releases - has been excluded in this release:INFO: This section might be - hidden by setting condition hidden on the section, MANUALLY in this - file. - - Networking features: DPDK vSwitch, DPDK - - - - Real-time features: Fully Preemptible Kernel (FPK) from the - PREEMPT_RT patch - - - - Memory features: NUMA - - -
+ \ No newline at end of file diff --git a/doc/book-enea-nfv-access-release-info/doc/book.xml b/doc/book-enea-nfv-access-release-info/doc/book.xml index 9c96184..ea37252 100644 --- a/doc/book-enea-nfv-access-release-info/doc/book.xml +++ b/doc/book-enea-nfv-access-release-info/doc/book.xml @@ -1,18 +1,35 @@ +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> - <trademark class="registered">Enea</trademark> NFV Access Release Information - Release Version - - - - - - - - - - + <trademark class="registered">Enea</trademark> NFV Access Release + Information + + Release Version + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/doc/book-enea-nfv-access-release-info/doc/eltf_params_updated.xml b/doc/book-enea-nfv-access-release-info/doc/eltf_params_updated.xml index 627e923..f6bd068 100644 --- a/doc/book-enea-nfv-access-release-info/doc/eltf_params_updated.xml +++ b/doc/book-enea-nfv-access-release-info/doc/eltf_params_updated.xml @@ -89,10 +89,10 @@ repo sync
- Supported Targets with Parameters + Supported Reference Boards with Parameters - The tables below describes the target(s) supported in this Enea - NFV Access release. + The tables below describes the target(s) supported in this Enea NFV + Access release.
MACHINE p2041rdb - Information diff --git a/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml b/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml index 9436fab..664766d 100644 --- a/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml +++ b/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml @@ -4,16 +4,17 @@ Getting Enea NFV Access - Enea NFV Access is available as both pre-built binary images and source - code. Both serve a specific purpose and each have their advantages. However, - using the pre-built binary images allows for getting up and running faster. - Please refer to the sections below for details on how to get Enea NFV Access as - pre-built binary images or source code. + Enea NFV Access is available as both pre-built binary images and + source code. Both serve a specific purpose and each have their advantages. + However, using the pre-built binary images allows for getting up and running + faster. Please refer to the sections below for details on how to get Enea + NFV Access as pre-built binary images or source code.
Getting Pre-built Binaries - Enea NFV Access pre-built binaries are available for download on Enea NFV Access pre-built binaries are available for download on + Enea Download Portal. Log in using the credentials provided. Using the menu, browse to the Linux section. You @@ -21,19 +22,19 @@ and the Online Documentation section. - The Files section lists each Enea NFV Access distribution, one for each - version and profile, as a separate download package. Clicking on the name - of the distribution will open a new page, which presents further details - about the content of the release and a list of downloadable archives, one - for each hardware target included in the release. Each archive provides - the following content: + The Files section lists each Enea NFV Access distribution, one for + each version and profile, as a separate download package. Clicking on the + name of the distribution will open a new page, which presents further + details about the content of the release and a list of downloadable + archives, one for each hardware target included in the release. Each + archive provides the following content: images directory – this directory includes the binary image files needed to boot the target with Enea - NFV Access. This includes the kernel, the root file system, device tree, - etc. + NFV Access. This includes the kernel, the root file system, device + tree, etc. @@ -57,28 +58,28 @@ Enea NFV Access Developer’s - Guide -intended for Enea NFV Access developers, who - want to configure and build customized NFV Access kernel images for - embedded system targets, using the Yocto configuration and build - system. + Guide -intended for Enea NFV Access developers, who want to + configure and build customized NFV Access kernel images for embedded + system targets, using the Yocto configuration and build system. Enea NFV Access Application Developer's - Guide - dedicated to Enea NFV Access application developers, who - want to build and run applications. + Guide - dedicated to Enea NFV Access application + developers, who want to build and run applications. - Enea NFV Access Guide - - provides further information meant to get the most out of the + Enea NFV Access Guide - + provides further information meant to get the most out of the virtualization features. - Enea NFV Access Open Source Report - - contains the open source and license information pertaining to - packages provided with this release of Enea NFV Access. + Enea NFV Access Open Source + Report - contains the open source and license information + pertaining to packages provided with this release of Enea NFV + Access. @@ -102,8 +103,8 @@ Enea NFV Access sources are available for cloning from a set of Git repositories on git.enea.com. - Since Enea NFV Access requires multiple repositories, Google Repo tool is used - in order to manage configurations and make the cloning step simpler. + Since Enea NFV Access requires multiple repositories, Google Repo tool is + used in order to manage configurations and make the cloning step simpler. Google Repo tool uses files, known as manifests, which store a list of tuples (repository URL, version). The Repo tool is then used to traverse the list of tuples in the manifest file and clone the specified versions @@ -147,8 +148,8 @@ id_rsa.pub
Get Sources - To use the Repo tool to download the sources for Enea NFV Access, do - the following: + To use the Repo tool to download the sources for Enea NFV Access, + do the following: diff --git a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml index 44c76e1..e3f068a 100644 --- a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml +++ b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml @@ -6,221 +6,16 @@ The open source projects are continuously working on correcting reported problems. Corrections to bugs detected by Enea are submitted - upstream, and the corrections are included in Enea NFV Access regardless of when - they will be included by the open source project. Remaining issues are + upstream, and the corrections are included in Enea NFV Access regardless of + when they will be included by the open source project. Remaining issues are listed below.INFO: The Release-Specific Problems section further down is generated from JIRA with gen_known_issues.py, but that script is HARDCODED with affectedversion "Enea - NFV Access 1.0" and needs to be adapted when a release info for another ENFV Access version - changes. + NFV Access 1.0" and needs to be adapted when a release info for another ENFV + Access version changes. -
- Yocto - - The Yocto Project community uses a Bugzilla database to track - information on reported bugs and other issues: - https://bugzilla.yoctoproject.org. -
- -
- Toolchain / SDK - - - - Building the kernel might fail if GNU Make of version 3.82 has - been installed on the host. The mandatory recovery action is to revert - to version 3.81.INFO It is possible to hide this entire - subsection by setting condition hidden on the section - element - - - - Installing a second toolchain in the same directory as a - previous one will break the $PATH variable of the first - one.LXCR-3624 - - -
- -
- Smart Package Manager - - Installation of some packages might currently fail when installing - using the Smart Package Manager. An example is the qemu package. Errors - can e.g. be reported by smart about conflicts with files from other - packages.INFO It is possible to hide this setting condition hidden - on the section element - - The recommended solution to this problem is to install the failing - package using rpm, already available in enea-image-base. In order to - install it using rpm, first install rpm using the command smart - install rpm, then download the package to the target, and - finally on the target use rpm -i - <packagename>.rpm. If not installed, several dependencies - can be reported as "Failed dependencies" with lines "x is needed by y". In - that case, install the required packages "x" found by dependencies by - using the smart package manager. Add a channel to an accessible directory - containing all missing rpm packages. Add packages detected to be missing, - until all dependencies are resolved.FIXME It would be nice to add - also a PowerPC example with qemu failing, the example below is for - ARM. - -
- Example with Failing QEMU Package - - As an example, the qemu installation can show the following - error.INFO It is possible to hide this setting condition hidden - on the section element - - - The example below is for ARM, including the RPM names. For - PowerPC similar errors can occur and other packages are needed. - - - error: file /var/run from install of - qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 conflicts with file from package - base-files-3.0.14-r89.0.hierofalcon - - A solution to this problem is to install the above qemu package - using rpm, already available in enea-image-base. In order to install it - using rpm, first install rpm using the command smart install - rpm, then download the above package from - <build_dir>/tmp/deploy/rpm/aarch64. On target, use rpm -i - qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64.rpm. If not installed, - several dependencies can be seen, e.g.: - - error: Failed dependencies: - libpixman-1-0 >= 0.32.6 is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 - libpixman-1.so.0()(64bit) is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 - libglib-2.0.so.0()(64bit) is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 - libcap2 >= 2.22 is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 - libglib-2.0-0 >= 2.40.0 is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 - bluez4 >= 4.101 is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 - libbluetooth.so.3()(64bit) is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 - libcap.so.2()(64bit) is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 - - Install the required packages found by dependencies by using the - smart package manager, as specified in the User's Guide, by adding a - channel to an accessible directory containing all of the above rpm - packages. Suggestion for installing required packages, as in the - following example for qemu and ARM: - - smart install bash - smart install libcap - smart install bluez4 - smart install libpixman-1-0 - rpm -i qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64.rpm - - Add packages detected to be missing until all dependencies are - resolved. -
-
- -
- Target-Side Tools - - - - The perf report does not show - any output for the PandaBoard target.LXCR-2710 - - - - perf top displays for a few - seconds the error message Failed to open - /tmp/perf-388.map. Any attempt to exit the subsequent window - causes the system to hang.LXCR-3113 - - - - When running the perf top command on the i.MX - 6Quad SABRE Lite target, the console text may become red after running - for some time (~ 1 minute).LXCR-3631 - - - - The powertop --calibrate - command does not work on the Keystone k2hk-evm - target.LXCR-2660 - - - - The powertop command run with - --calibrate or --time arguments may show some warnings on - PowerPC targets. - - - - If you get an error message like Cannot load from file - /var/cache/powertop/saved_results.powertop when running - powertop, there is most likely not - enough measurement data collected yet. All you have to do is to keep - powertop running for a certain time.LXCR-2176, LXCR-2660, - LXCR-3106 - - - - The message Model-specific registers (MSR) not found - (try enabling CONFIG_X86_MSR) appears when you run powertop on non-x86 targets. powertop is mainly an x86n - tool, so it expects X*^_MSR config to be enabled in the kernel. For - non-x86 targets this config is not available in the kernel, hence, - powertop warns about it, but the message can be ignored on those - targets. LXCR-2176, LXCR-2660, LXCR-3106 - - - - powertop issues a message - sh: /usr/bin/xset: No such file or directory when - it tries to use xset to configure X display preferences but cannot - find the binary since the image by default contains no X system. The - message can simply be ignored.LXCR-2176 - - -
- -
- Virtualization - - - - virtualization: CONFIG_BRIDGE - is not included in the default p2020rdb - kernel.LXVTCR-273 - - - - lxc: - - - - User namespace is not available on PowerPC targets as it is - an experimental feature in the 3.8 kernel. - - - - If multiple Linux containers are started from the same - process and share resources, destroying the containers might - result in a race condition with error message "Error in - `./lxc-test-concurrent': double free or corruption (fasttop)" - followed by an application - crash."LXVTCR-365 - - - - - - libvirt: Default network does - not start.LXVTCR-240 - - -
- -
- Documentation +
+ Release-Specific Limitations @@ -234,28 +29,7 @@ - Internet Explorer (IE) cannot display some - web pages: It is recommended to use Firefox or another - non-IE browser for opening external links. If you prefer reading the - documentation in PDF format in Adobe Reader (not in an Adobe plug-in - in a browser), remember to configure a non-IE browser as default - browser to be able to follow all links from within Adobe Reader. - Example of a link that does not work in IE: https://rt.wiki.kernel.org/. - LXCR-3281 - - -
- -
- Miscellaneous - - - - menuconfig requires Ncurses. If the terminal that pops up - immediately closes instead of showing the menuconfig interface, check - that the Ncurses development library is installed. +
diff --git a/doc/book-enea-nfv-access-release-info/doc/main_changes.xml b/doc/book-enea-nfv-access-release-info/doc/main_changes.xml index 18bb93f..ebe69c6 100644 --- a/doc/book-enea-nfv-access-release-info/doc/main_changes.xml +++ b/doc/book-enea-nfv-access-release-info/doc/main_changes.xml @@ -6,18 +6,18 @@ N/A. - This is the first release of Enea NFV Access, Networking profile. + This is the first release of Enea NFV Access, Networking + profile.
- New Functionality/Enhancements + New Features Based in the Jira query: 'project = CPDX and fixVersion = "Enea NFV Access 1.0"' - New Yocto version (New Yocto version (). See https://www.yoctoproject.org/downloads/core/krogoth21. @@ -34,20 +34,20 @@ on repos and the manifest.
-
- Problems Fixed in this Release +
+ Provided Packages - TBD FIXME or set condition hidden +
-
- Added Drivers +
+ Compatibility - TBD FIXME or set condition hidden +
- + \ No newline at end of file diff --git a/doc/book-enea-nfv-access-release-info/doc/prerequisites.xml b/doc/book-enea-nfv-access-release-info/doc/prerequisites.xml deleted file mode 100644 index 7ae2eb6..0000000 --- a/doc/book-enea-nfv-access-release-info/doc/prerequisites.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - Prerequisites - - Building Enea NFV Access or compiling applications requires that your git - environment be setup properly and for certain packages to be installed on - your NFV Access development host. - - Please refer to Getting - Started - First-Time Git Setup, for more details on how to set up - your git environment correctly, including how to set your identity using the - following commands: - - $ git config --global user.name "John Doe" -$ git config --global user.email johndoe@example.com - - First ensure the system is up-to-date, then for the supported - distribution(s), you need the following packages:INFO: The - programlisting below is a parameters in eltf_params_updated.xml with ID: - "eltf-prereq-apt-get-command-host". If multiple hosts are supported, store - the commands for each host in the same programlisting with empty lines - between each - the comment with the FULL HOST name and version is - essential. - - - - - \ No newline at end of file diff --git a/doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml b/doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml new file mode 100644 index 0000000..f598693 --- /dev/null +++ b/doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml @@ -0,0 +1,34 @@ + + + + System Requirements and Prerequisites + + Using Enea NFV Access or compiling applications requires that your git + environment be setup properly and for certain packages to be installed on + your NFV Access development host. + + Please refer to Getting + Started - First-Time Git Setup, for more details on how to set up + your git environment correctly, including how to set your identity using the + following commands: + + $ git config --global user.name "John Doe" +$ git config --global user.email johndoe@example.com + + First ensure the system is up-to-date, then for the supported + distribution(s), you need the following packages:INFO: The + programlisting below is a parameters in eltf_params_updated.xml with ID: + "eltf-prereq-apt-get-command-host". If multiple hosts are supported, store + the commands for each host in the same programlisting with empty lines + between each - the comment with the FULL HOST name and version is + essential. + + + + + \ No newline at end of file diff --git a/doc/init.mk b/doc/init.mk index 7dc5efd..0950c27 100644 --- a/doc/init.mk +++ b/doc/init.mk @@ -91,7 +91,7 @@ $(TMPCLONEROOT)/$(NAME_DOCENEACOMMON): else \ echo "Cloning $(REPO_DOCENEACOMMON) in $(TMPCLONEROOT) as $(NAME_DOCENEACOMMON)" ; \ cd "$(TMPCLONEROOT)"; \ - git clone -b $(BRANCH_DOCENEACOMMON) git@git.enea.se:$(REPO_DOCENEACOMMON) $(NAME_DOCENEACOMMON) ; \ + git clone -b $(BRANCH_DOCENEACOMMON) git@git.enea.com:$(REPO_DOCENEACOMMON) $(NAME_DOCENEACOMMON) ; \ fi cleaninit: -- cgit v1.2.3-54-g00ecf