From 13da278fea34982e5eb398af09e9bd82c050a71c Mon Sep 17 00:00:00 2001 From: Miruna Paun Date: Mon, 10 Apr 2017 12:38:48 +0200 Subject: Updating El6-Network Relnotes LXCR-7377 Tweaking the last of needed info, build files Signed-off-by: Miruna Paun --- doc/Makefile | 154 +++++----- doc/book-enea-linux-open-source/doc/about.xml | 2 +- doc/book-enea-linux-open-source/doc/book.xml | 2 +- .../doc/about_release.xml | 187 +++--------- doc/book-enea-linux-release-info/doc/book.xml | 2 +- .../doc/build_boot_template.xml | 12 +- .../doc/eltf_params_template.xml | 151 ++++++++++ .../doc/eltf_params_updated.xml | 165 +++++++++++ .../eltf_params_updated_template_how_to_use.txt | 320 +++++++++++++++++++++ .../doc/getting_enea_linux.xml | 46 ++- .../doc/known_bugs_and_limitations.xml | 24 +- .../doc/main_changes.xml | 2 +- .../doc/prerequisites.xml | 29 +- .../doc/system_requirements.xml | 2 +- doc/docsrc_common/pardoc-distro.xml | 23 +- doc/initbuildboot.sh | 14 +- 16 files changed, 831 insertions(+), 304 deletions(-) create mode 100644 doc/book-enea-linux-release-info/doc/eltf_params_template.xml create mode 100644 doc/book-enea-linux-release-info/doc/eltf_params_updated.xml create mode 100644 doc/book-enea-linux-release-info/doc/eltf_params_updated_template_how_to_use.txt diff --git a/doc/Makefile b/doc/Makefile index 0b23b4f..9c68e80 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,3 +1,5 @@ +#2017-03-27 Replaced poky autocloning for parameter extraction with XML file updated by the ELTF test system + #Path to this subsystem's root directory SUBSYSROOT := $(shell pwd) @@ -7,21 +9,13 @@ include manifest_conf.mk MANIFESTDIR := $(shell echo "$(MANIFESTURL)" | sed 's/.*\///;s/\.git//') # Further down we extract the list of target manifest file names from the manifest itself -# We need all to get all README, but only first in alphabetic list is used to extract info from poky/ + # ***************** Generic docbuild.git auto-clone + s_docbuild symlink *** # This also defines TMPCLONEROOT which optionally can be nondefault using BOOK_GLOBALCLONEROOT=yes or a path include init.mk -# ****************** SUPPORT FOR TARGETS *************************** -PATH_TARGETS = $(SUBSYSROOT)/s_targets -#Git repositories to be cloned -NAME_TARGETS := targets -#Path to the directory under which repos shall be cloned. -DOCBASEDIR=$(shell pwd) -REPODIR=$(DOCBASEDIR)/.. -TMPCLONEROOT_TARGETS := $(TMPCLONEROOT)/$(NAME_TARGETS) TMPCLONEROOT_MANIFEST := $(TMPCLONEROOT)/manifest @@ -32,7 +26,11 @@ BUILDBOOT_TEMPLATE := book-enea-linux-release-info/doc/build_boot_template.xml PKGDIFF_GEN_XML := book-enea-linux-release-info/doc/pkgdiff_generated.xml JIRA_ISSUES_GEN_XML := book-enea-linux-release-info/doc/jiraissues_generated.xml -MANIFESTFILES_XML := book-enea-linux-release-info/doc/manifestfiles_generated.xml +MACHINE_LIST_XML := book-enea-linux-release-info/doc/machine_list_generated.xml + +ELTF_PARAMS_TEMPLATE := book-enea-linux-release-info/doc/eltf_params_template.xml +ELTF_PARAMS_UPDATED := book-enea-linux-release-info/doc/eltf_params_updated.xml + # ----------------------------------------------------- @@ -73,12 +71,12 @@ VALIDATE = no # Export all parameters including those on the command line export -.PHONY: doc books docusage init initbuild initmanifest inittargets initpardoc initbuildboot dist +.PHONY: doc books docusage init initbuild initmanifest initpardoc initbuildboot dist docusage: @echo 'make docusage #Shows this help text' - @echo ' DOCBOOK_TOOLS_VERSIONS=yes #Displays DocBook tools versions in this machine' + @echo ' DOCBOOK_TOOLS_VERSIONS=yes #Displays./testeltfver.sh DocBook tools versions in this machine' @echo 'make doc #Builds doc. ALSO automatically does all inits if needed' @echo 'make dist BOOK_DIST_DIR=xx/doc #Builds doc as above and copies results to BOOK_DIST_DIR' @echo ' # Does not work with DOCBOOK_TO_BOOKDIR or BOOK_BUILD_DIR' @@ -87,10 +85,10 @@ docusage: @echo 'make init #Init all needed init* below' @echo 'make initbuild #Init s_docbuild Docbook build system and central files' @echo 'make initmanifest #Init s_manifest by cloning, to detect which targets are included' - @echo 'make inittargets #Init s_targets using repo tool. Targets in this distro with poky' @echo 'make initpardoc #Init s_docsrc_common with extracted parameters/' @echo 'make initbuildboot #Init build_boot chapter from READMEs and template in release info' @echo 'make initissues #Init known issues section from Jira' + @echo 'make eltf #Test - displays all ELTF_xxx variables that ELTF shall replace' @echo ' MANIFESTHASH=xxxxx #Option for all inits above to use nondefault manifest version' @echo ' #It shall either be ref/tags/ or a hashvalue' @echo ' #Configured tag or hashvalue $(MANIFESTHASH)' @@ -99,7 +97,6 @@ docusage: @echo ' DOCBOOK_CLEANTMP=no #Option to keep temp files in doc/ and tmp/' @echo ' BOOK_GLOBALCLONEROOT=yes #Option for all init above to clone all outside the doc directory' @echo ' BOOK_GLOBALCLONEROOT=otherpath #Option for all init above to clone all to given path' - @echo 'make pullbuild #git pull in s_docbuild' @echo 'make clean #Clean results and all s_*, but not any external clones' @echo '' @echo 'Optional parameters for make doc:' @@ -184,9 +181,8 @@ endif books: init # BOOKPACKAGES is defined in all book-*/swcomp.mk - $(VERB)DISTRO_VERSION_MAJOR=`egrep '"EneaLinux_DISTRO_VERSION_MAJOR"' s_docsrc_common/pardoc-distro.xml | sed 's/.*//;s/<\/phrase>.*//'` ; \ - DISTRO_VERSION_MINOR=`egrep '"EneaLinux_DISTRO_VERSION_MINOR"' s_docsrc_common/pardoc-distro.xml | sed 's/.*//;s/<\/phrase>.*//'` ; \ - BOOKVER="Profile $(PROFILE_NAME)-$$DISTRO_VERSION_MAJOR$$DISTRO_VERSION_MINOR" ; \ + $(VERB)DISTRO_VERSION=`egrep '"EneaLinux_REL_VER">' $(ELTF_PARAMS_UPDATED) | sed 's/.*//;s/<\/phrase>.*//'` ; \ + BOOKVER="Profile $(PROFILE_NAME)-$$DISTRO_VERSION" ; \ for book in $(BOOKPACKAGES); do \ for format in $(FORMAT); do \ $(MAKE) -f $(DOCBOOKMAKE)/make_docbook_standalone.mk BOOK=$$book FORMAT=$$format BOOK_VER="$$BOOKVER" books || exit 10; \ @@ -216,7 +212,6 @@ endif # ****************************************************************** # ****************** SUPPORT FOR TARGETS *************************** initmanifest: s_manifest -inittargets: s_targets # ----------------------------------------- @@ -229,8 +224,8 @@ s_manifest: $(TMPCLONEROOT_MANIFEST) $(VERB)rm s_manifest 2>/dev/null; ln -s $(TMPCLONEROOT_MANIFEST) s_manifest cleanmanifest: - @echo "Cleaning generated manifestfilelist XML document file" - $(VERB)rm -f $(MANIFESTFILES_XML) 2>/dev/null + @echo "Cleaning generated manifest files" + $(VERB)rm -f $(MACHINE_LIST_XML) 2>/dev/null $(VERB)rm -rf "$(TMPCLONEROOT_MANIFEST)" s_manifest 2>/dev/null $(TMPCLONEROOT_MANIFEST): @@ -241,41 +236,16 @@ $(TMPCLONEROOT_MANIFEST): cd "$(TMPCLONEROOT_MANIFEST)"; git clone $(MANIFESTURL) ; cd $(MANIFESTDIR) ; git checkout $(MANIFESTHASH) $(VERB)if [ ! -d "$(TMPCLONEROOT_MANIFEST)/$(MANIFESTDIR)" ]; then echo "ERROR: Missing $(TMPCLONEROOT_MANIFEST)/$(MANIFESTDIR)"; exit 10 ; fi ; \ TARGETDEFAULTXMLS=`cd $(TMPCLONEROOT_MANIFEST)/$(MANIFESTDIR); ls -1 */default.xml 2>/dev/null` ; \ - echo "$$TARGETDEFAULTXMLS" | tr '\n' ' ' >$(TMPCLONEROOT_MANIFEST)/targetdefaultxmls.txt ; \ - echo "$$TARGETDEFAULTXMLS" | sed 's/\/.*//' | tr '\n' ' ' >$(TMPCLONEROOT_MANIFEST)/targetids.txt ; \ - echo "" >$(MANIFESTFILES_XML) ; \ - echo ">$(MANIFESTFILES_XML) ; \ - echo "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\">" >>$(MANIFESTFILES_XML) ; \ - echo "
" >>$(MANIFESTFILES_XML) ; \ - echo "$$TARGETDEFAULTXMLS" >>$(MANIFESTFILES_XML) ; \ - echo "
" >>$(MANIFESTFILES_XML) - - -# ----------------------------------------- -# Use repo to auto-clone each target separately - VERY LARGE if there are many targets (5 targets => about 1.3 Gbytes) - -s_targets: $(TMPCLONEROOT_TARGETS) - $(VERB)rm s_targets 2>/dev/null; ln -s $(TMPCLONEROOT_TARGETS) s_targets + TARGET_LIST=`echo "$$TARGETDEFAULTXMLS" | sed 's/\/default.xml//;s/^/# export MACHINE=/'` ; \ + echo "" >$(MACHINE_LIST_XML) ; \ + echo ">$(MACHINE_LIST_XML) ; \ + echo "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\">" >>$(MACHINE_LIST_XML) ; \ + echo "" >>$(MACHINE_LIST_XML) ; \ + echo "# Set MACHINE to ONE of the targets in this release!" >>$(MACHINE_LIST_XML) ; \ + echo "$$TARGET_LIST" >>$(MACHINE_LIST_XML) ; \ + echo "" >>$(MACHINE_LIST_XML) -$(TMPCLONEROOT_TARGETS): s_manifest - $(VERB)if [ ! -d "$(TMPCLONEROOT)" ] ; then mkdir -p "$(TMPCLONEROOT)" ; fi - $(VERB)if [ ! -d $(TMPCLONEROOT_TARGETS) ]; then mkdir -p $(TMPCLONEROOT_TARGETS) ; fi - @echo "**** Cloning all targets using repo tool into $(TMPCLONEROOT_TARGETS)" - $(VERB)if [ ! -f "$(TMPCLONEROOT_MANIFEST)/targetdefaultxmls.txt" ]; then echo "ERROR: Missing $(TMPCLONEROOT_MANIFEST)/targetdefaultxmls.txt"; exit 10; fi - $(VERB)TARGETDEFAULTXMLS=`cat "$(TMPCLONEROOT_MANIFEST)/targetdefaultxmls.txt" 2>/dev/null` ; \ - echo "Info: TARGETDEFAULTXMLS is $$TARGETDEFAULTXMLS" ; \ - for target_default_xml in $$TARGETDEFAULTXMLS; \ - do \ - TARGDIR=$(TMPCLONEROOT_TARGETS)/`dirname $$target_default_xml` ; \ - echo "TARGDIR=<$$TARGDIR>" ; \ - if [ ! -d $$TARGDIR ]; then mkdir -p $$TARGDIR ; fi ; \ - ( cd $$TARGDIR ; \ - echo "*** Doing repo init -u $(MANIFESTURL) -b $(MANIFESTHASH) -m $$target_default_xml ; repo sync"; \ - repo init -u $(MANIFESTURL) -b $(MANIFESTHASH) -m $$target_default_xml ; repo sync ; \ - ) ; \ - done - # **************************************************************************** # ******************** SUPPORT FOR dynamic pardoc with added parameters ****** # pardoc-distro can contain MAJOR.MINOR-xxxxx keeping -xxxx when replacing MINOR.MINOR from enea.conf @@ -291,32 +261,18 @@ cleanpardoc: @echo "Cleaning dynamic parameters" $(VERB)rm -rf $(TMPCLONEROOT_DOCSRC_COMMON) ; rm s_docsrc_common + s_docsrc_common: $(TMPCLONEROOT_DOCSRC_COMMON) $(VERB)rm s_docsrc_common 2>/dev/null; ln -s $(TMPCLONEROOT_DOCSRC_COMMON) s_docsrc_common -$(TMPCLONEROOT_DOCSRC_COMMON): s_targets +$(TMPCLONEROOT_DOCSRC_COMMON): $(VERB)if [ ! -d "$(TMPCLONEROOT)" ] ; then mkdir -p "$(TMPCLONEROOT)" ; fi $(VERB)if [ ! -d $(TMPCLONEROOT_DOCSRC_COMMON) ]; then mkdir -p $(TMPCLONEROOT_DOCSRC_COMMON) ; fi - @echo "**** Copy and patch docsrc_common/ files to $(TMPCLONEROOT_DOCSRC_COMMON)" - @echo "*** Add parameters from first target's enea.conf and add manifest parameters" - $(VERB)FIRSTTARGET=`ls -1 s_targets/ 2>/dev/null | head -1`; \ - if [ "$$FIRSTTARGET" = "" ]; then echo "ERROR: No targets?" ; exit 10; fi ; \ - ENEACONF=s_targets/$$FIRSTTARGET/poky/meta-el-common/conf/distro/enea.conf ; \ - if [ ! -f "$$ENEACONF" ]; then echo "ERROR: No $$ENEACONF?" ; exit 10; fi ; \ - DISTRO_VERSION_MAJOR=`egrep '^DISTRO_VERSION_MAJOR' $$ENEACONF | sed 's/^[^"]*"//;s/".*//'` ; \ - DISTRO_VERSION_MINOR=`egrep '^DISTRO_VERSION_MINOR' $$ENEACONF | sed 's/^[^"]*"//;s/".*//'` ; \ - cat docsrc_common/pardoc-distro.xml | sed '/<\/section>/d' | \ - sed '/$(TMPPARDOC) ; \ - echo "$$DISTRO_VERSION_MAJOR" >>$(TMPPARDOC) ; \ - echo "$$DISTRO_VERSION_MINOR" >>$(TMPPARDOC) ; \ - echo "$(PROFILE_NAME)" >>$(TMPPARDOC) ; \ - echo "$(MANIFESTURL)" >>$(TMPPARDOC) ; \ - echo "$(MANIFESTHASH)" >>$(TMPPARDOC) ; \ - echo "" >>$(TMPPARDOC) + @echo "**** Copy docsrc_common/ files to $(TMPCLONEROOT_DOCSRC_COMMON)" + $(VERB)cat docsrc_common/pardoc-distro.xml >$(TMPPARDOC) # **************************************************************************** -# ***** Create XML chapter with build/boot commands from all README files in s_targets +# ***** Create XML chapter with build/boot commands from all README files in manifest initbuildboot: $(BUILDBOOT_XML) @@ -325,11 +281,11 @@ cleanbuildboot: $(VERB)rm -f $(BUILDBOOT_XML) 2>/dev/null -$(BUILDBOOT_XML): s_targets $(BUILDBOOT_TEMPLATE) +$(BUILDBOOT_XML): $(BUILDBOOT_TEMPLATE) @echo "**** Creating $(BUILDBOOT_XML) from READMEs" $(VERB)INITBB_CMD=initbuildboot.sh ; \ if [ -f "$$INITBB_CMD" ]; then \ - sh "$$INITBB_CMD" -xml $(BUILDBOOT_XML) -template $(BUILDBOOT_TEMPLATE) ; \ + sh "$$INITBB_CMD" -xml $(BUILDBOOT_XML) -template $(BUILDBOOT_TEMPLATE) -readmebasedir s_manifest/$(MANIFESTDIR); \ else \ echo "ERROR: Missing $$INITBB_CMD, can not create $(BUILDBOOT_XML)"; exit 10; \ fi @@ -357,6 +313,7 @@ $(PKGDIFF_GEN_XML): initissues: $(JIRA_ISSUES_GEN_XML) + cleanissues: @echo "Cleaning generated known issues document file" $(VERB)rm -f $(JIRA_ISSUES_GEN_XML) 2>/dev/null @@ -366,3 +323,52 @@ $(JIRA_ISSUES_GEN_XML): $(VERB)python gen_known_issues.py >$(JIRA_ISSUES_GEN_XML) # **************************************************************************** + +# +# All ELTF_ variables names only has upper case, underline and digits +eltf: + @echo "# make eltf extracts and displays all ELTF_ variables found here" + @echo "# in $(SUBSYSROOT)/$(ELTF_PARAMS_TEMPLATE)" + @echo "# Replace all variables, creating a new eltf*updated.xml file from the eltf*template.xml" + @echo "#" + @echo "# Only replace + push the result file $(ELTF_PARAMS_UPDATED), IF IT WILL BE CHANGED." + @echo "#" + @echo "# IMPORTANT: See eltf_params_updated_template_how_to_use.txt for requirements and details!" + @echo "# Below is only a summary!" + @echo "#" + @echo "# ELTF_ variables must be UNIQUE, e.g. a variable must not be a part of another variable" + @echo "#" + @echo "# ELTF_PL_* and ELTF_T_PL_* shall have the format for programlisting and are often multiline - see below." + @echo "#" + @echo "# ELTF_*_URL and ELTF_*_TXTURL are the URL part and TXT part of ulink; those shall be exactly identical," + @echo "# unless the URL is very very long." + @echo "#" + @echo "# ELTF_T_* are target (MACHINE) variables in one subsection, replace with machine specific strings." + @echo "#" + @echo "# Append more target subsections to *updated.xml, if more than one target is in a release!" + @echo "# Replace the line with appended" + @echo "# complete target section elements copied before the variables are replaced." + @echo "# In each target section, replace the ELTF_T* variables with machine dependent strings" + @echo "# Append final lines seen after " + @echo "# but that would often only be two final lines" + @echo "#" + @echo "# ELTF_ Variables: Replace each variable with a string, for ELTF_*PL* it can be multiline" + @echo "# DO NOT use any leading or trailing spaces and DO NOT use TABs" + @echo "#" + @echo "# ELTF_ Everywhere: Only 7-bit ASCII inside the string replacing a variable. Translate characters" + @echo "# like & < > to & < > etc." + @echo "# unless real XML shall be inserted like when entire sections are appended." + @echo "#" + @echo "# ELTF_ programlisting, variables with PL in the name: Max line length < 80 char." + @echo "# Use backslash + indent-leading-spaces for continuation lines." + @echo "# Multiline. No trailing spaces on any line inside the programlisting." + @echo "#" + @echo "# The following variables shall be replaced with suitable contents (egrep from the template):" + @echo "# Again: See details in eltf_params_updated_template_how_to_use.txt" + @echo "# including also examples of contents of each variable!" + @echo "#" + $(VERB)( egrep 'ELTF_[A-Z_0-9][A-Z_0-9]*' $(ELTF_PARAMS_TEMPLATE) 2>/dev/null | sed 's/ELTF_/\nELTF_/g' | egrep 'ELTF_[A-Z_0-9][A-Z_0-9]*' | sed 's/\(ELTF_[A-Z_0-9][A-Z_0-9]*\).*/\1/' ) | sort + @echo "# The make eltf also here extracts any left-over ELTF variables from $(ELTF_PARAMS_UPDATED)" + @echo "# It should not be any left here:" + $(VERB)( egrep 'ELTF_[A-Z_0-9][A-Z_0-9]*' $(ELTF_PARAMS_UPDATED) 2>/dev/null | sed 's/ELTF_/\nELTF_/g' | egrep 'ELTF_[A-Z_0-9][A-Z_0-9]*' | sed 's/\(ELTF_[A-Z_0-9][A-Z_0-9]*\).*/\1/' ) | sort + @echo "# If you see any left-over above, something is wrong" diff --git a/doc/book-enea-linux-open-source/doc/about.xml b/doc/book-enea-linux-open-source/doc/about.xml index f2f863f..d4b6437 100644 --- a/doc/book-enea-linux-open-source/doc/about.xml +++ b/doc/book-enea-linux-open-source/doc/about.xml @@ -6,7 +6,7 @@ This document contains the open source and license information pertaining to packages provided with Enea Linux . \ No newline at end of file diff --git a/doc/book-enea-linux-open-source/doc/book.xml b/doc/book-enea-linux-open-source/doc/book.xml index d5da88e..1fd8217 100644 --- a/doc/book-enea-linux-open-source/doc/book.xml +++ b/doc/book-enea-linux-open-source/doc/book.xml @@ -6,7 +6,7 @@ <trademark class="registered">Enea</trademark> Linux Open Source Report Release Version - diff --git a/doc/book-enea-linux-release-info/doc/about_release.xml b/doc/book-enea-linux-release-info/doc/about_release.xml index 6907507..01679f8 100644 --- a/doc/book-enea-linux-release-info/doc/about_release.xml +++ b/doc/book-enea-linux-release-info/doc/about_release.xml @@ -4,16 +4,23 @@ About This Release - This release of Enea Linux This release of Enea Linux provides a publicly available Enea Linux distribution for a selected set of targets. This release is - generated from the yocto distribution using the branch .INFO Yocto distro autopicked - from poky.ent as DISTRO_NAME_NO_CAP + xpointer="element(Yocto_VER/1)" /> distribution using the branch .INFO eltf_params_updated.xml contains many parameters in + the book, also in the open source books, and MUST be created FROM eltf_params_template.xml. The parameters are + automatically used in the books, via xi:include statements, similar to how + parameters from pardoc-distro.xml are included in the book. Read the file + eltf_params_updated_template_how_to_use.txt + for important details about formats and how to do! The idea is that ELTF + will auto-create/update it.
Provided Contents @@ -43,8 +50,16 @@ - Pre-built packages (RPM) + 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. + + @@ -96,76 +111,21 @@ - Ubuntu 14.04 LTS, 64-bitwas - EneaLinux_HOST_VER + 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.
-
- Supported Versions - - - - - - Item - - Version - - - - - - Yocto - - ()INFO: Auto-fetched - from poky.ent via pardoc-distro.xml - - - - Poky - - Git commit id: - 75ca53211488a3e268037a44ee2a7ac5c7181bd2Problem: - Unfortunately the poky version in poky.ent is not correct unless - the EL release would be based on a Yocto release, so we can not - use that here. This is a problem because we don't want to manually - edit the git commit ID in this file? The poky version in poky.ent - is just now - - - - GCC - - 5.3was EneaLinux_GCC_VER Not in poky.ent - - - - - Linux kernelwas EneaLinux_KERNEL_VER Not in - poky.ent - - 3.12 - - - - Packages - - See - - - - -
+
Provided Packages @@ -194,6 +154,7 @@ class="registered">Enea Linux Open Source Report + @@ -211,76 +172,6 @@ toolchain.
-
- Supported Drivers - - - - - - - - - - Driver - - P2041RDB - - - - - - Ethernet - - X - - - - I2C - - X - - - - SPI - - X - - - - PCI Express - - X - - - - USB - - X - - - - Flash - - X - - - - SD/SDHC/SDXC - - X - - - - RTC - - X - - - - -
-
Provided Documentation @@ -326,7 +217,7 @@ - Enea Linux 6 Test + Enea Linux Test Report @@ -343,7 +234,9 @@ 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: + functionality is also available, among other:INFO: This section + might be hidden by setting condition hidden on the section, MANUALLY in + this file. @@ -381,7 +274,9 @@ Intentional Limitations The following functionality supported in other Enea Linux releases - has been excluded in this release: + 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 diff --git a/doc/book-enea-linux-release-info/doc/book.xml b/doc/book-enea-linux-release-info/doc/book.xml index d1226b9..91af443 100644 --- a/doc/book-enea-linux-release-info/doc/book.xml +++ b/doc/book-enea-linux-release-info/doc/book.xml @@ -5,7 +5,7 @@ <trademark class="registered">Enea</trademark> Linux Release Information Release Version - diff --git a/doc/book-enea-linux-release-info/doc/build_boot_template.xml b/doc/book-enea-linux-release-info/doc/build_boot_template.xml index 653f943..2200997 100644 --- a/doc/book-enea-linux-release-info/doc/build_boot_template.xml +++ b/doc/book-enea-linux-release-info/doc/build_boot_template.xml @@ -10,11 +10,13 @@ reader, the contents of these build/boot instruction have been extracted into the following sections. - NOTE: Only EDIT THE TEMPLATE FILE! A new build_boot.xml file - is created from the template and sections are added below automatically from - the README files for each target when building the book! Only in the - template file you see a line below with SCRIPT_...._HERE and the text - telling that this is a template file. + NOTE: Only EDIT THE TEMPLATE build_boot_template.xml file here + and also only edit the manifest template ".README" (name starting by a dot)! + A new build_boot_generated.xml file is created from the template and + sections are added below automatically from the README files for each target + when building the book! Only in the template file you see a line below with + SCRIPT_...._HERE and the text telling that this is a template + file. SCRIPT_INCLUDES_BUILD_BOOT_SECTIONS_HERE diff --git a/doc/book-enea-linux-release-info/doc/eltf_params_template.xml b/doc/book-enea-linux-release-info/doc/eltf_params_template.xml new file mode 100644 index 0000000..278ad71 --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/eltf_params_template.xml @@ -0,0 +1,151 @@ + + +
+ File with Parameters in the Book Auto-updated by ELFT + + + See the eltf_params_updated_template_howto_use.txt text + file for description of how to create the final eltf_params_updated.xml from this template and for + all REQUIREMENTS. Use the command + "make eltf" to extract a full list of all + ELTF variables, which always begins with ELTF_ and don't only rely on the + howto text file list! The plan is that ELTF will auto-update this when + needed. + + +
+ Common Parameters + + A programlisting, ID + "eltf-prereq-apt-get-commands-host" + + ELTF_PL_HOST_PREREQ + + A programlisting, ID + "eltf-getting-repo-install-command" + + ELTF_PL_GET_REPO + + Several phrase elements, various IDs. Ensure EL_REL_VER is + correct also compared to the "previous" REL VER in pardoc-distro.xml + "prev_baseline". + + ELTF_EL_REL_VER + + ELTF_YOCTO_VER + + ELTF_YOCTO_NAME + + ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL + + ELTF_EL_DOWNLOAD_TXTURL + + A programlisting, ID "eltf-repo-cloning-enea-linux". Use + $MACHINE/default.xml as parameter, where MACHINE is one of the target + directory names in the manifest. + + ELTF_PL_CLONE_W_REPO + + A table with ONE row, only the row with ID + "eltf-eclipse-version-row" is included in the book. MANUALLY BOTH in the + template.xml and in the updated.xml, set condition hidden on the + <row>, if eclipse is not in the release. + + + + + + Eclipse version ELTF_ECLIPSE_VERSION plus command line + development tools are included in this Enea Linux release. + + + + + + Below is one big section with title "Supported Targets with + Parameters". The entire section is included completely in the book via ID + "eltf-target-tables-section" and shall be LAST in the template. The + template contains ONE target subsection. COPY/APPEND it, if multiple + targets exist in the release and optionally add rows with additional + target parameters in each target subsection table. +
+ +
+ Supported Targets with Parameters + + The tables below describes the target(s) supported in this Enea + Linux release. + +
+ MACHINE ELTF_T_MANIFEST_DIR - Information + + + + + + + + + + Target official name + + ELTF_T_NAME + + + + Architecture and Description + + ELTF_T_ARC_DESC + + + + Link to target datasheet + + See ELTF_T_DS_TXTURL + + + + Poky version + + ELTF_T_POKY_VER + + + + GCC version + + ELTF_T_GCC_VER + + + + Linux Kernel Version + + ELTF_T_KERN_VER + + + + Supported Drivers + + ELTF_T_DRIVERS + + + + Enea rpm folder for downloading RPM packages for this + target + + ELTF_T_EL_RPM_TXTURL + + + + +
+ + +
+
\ No newline at end of file diff --git a/doc/book-enea-linux-release-info/doc/eltf_params_updated.xml b/doc/book-enea-linux-release-info/doc/eltf_params_updated.xml new file mode 100644 index 0000000..a55234f --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/eltf_params_updated.xml @@ -0,0 +1,165 @@ + + +
+ File with Parameters in the Book Auto-updated by ELFT + + + See the eltf_params_updated_template_howto_use.txt text + file for description of how to create the final eltf_params_updated.xml from this template and for + all REQUIREMENTS. Use the command + "make eltf" to extract a full list of all + ELTF variables, which always begins with ELTF_ and don't only rely on the + howto text file list! The plan is that ELTF will auto-update this when + needed. + + +
+ Common Parameters + + A programlisting, ID + "eltf-prereq-apt-get-commands-host" + + # Host Ubuntu 14.04.5 LTS 64bit +sudo apt-get -y update +sudo apt-get -y install sed wget subversion git-core coreutils unzip texi2html \ + texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \ + make gcc build-essential xsltproc g++ desktop-file-utils chrpath \ + libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \ + libxml-parser-perl + + A programlisting, ID + "eltf-getting-repo-install-command" + + mkdir -p ~/bin +curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo +chmod a+x ~/bin/repo +export PATH=~/bin:$PATH + + Several phrase elements, various IDs. Ensure EL_REL_VER is + correct also compared to the "previous" REL VER in pardoc-distro.xml + "prev_baseline". + + 6 + + 2.1 + + krogoth + + http://www.yoctoproject.org/downloads/core/krogoth/21 + + https://linux.enea.com/6 + + A programlisting, ID "eltf-repo-cloning-enea-linux". Use + $MACHINE/default.xml as parameter, where MACHINE is one of the target + directory names in the manifest. + + mkdir enea-linux +cd enea-linux +repo init -u git://git.enea.com/linux/el_manifests-networking.git \ + -b refs/tags/EL6 -m $MACHINE/default.xml +repo sync + + A table with ONE row, only the row with ID + "eltf-eclipse-version-row" is included in the book. MANUALLY in book, set + condition hidden if eclipse is not in the release. Do this both in + template.xml and updated.xml. + + + + + + Eclipse version 4.3 (Mars) plus command line development + tools are included in this Enea Linux release. + + + + + + Below is one big section with title "Supported Targets with + Parameters". The entire section is included completely in the book via ID + "eltf-target-tables-section" and shall be LAST in the template. The + template contains ONE target subsection. COPY/APPEND it, if multiple + targets exist in the release and optionally add rows with additional + target parameters in each target subsection table. +
+ +
+ Supported Targets with Parameters + + The tables below describes the target(s) supported in this Enea + Linux release. + +
+ MACHINE p2041rdb - Information + + + + + + + + + + Target official name + + P2041RDB + + + + Architecture and Description + + Power, e500mc + + + + Link to target datasheet + + See link + to NXP's datasheet + + + + Poky version + + Git-commit-id: + 75ca53211488a3e268037a44ee2a7ac5c7181bd2 + + + + GCC version + + 5.3 + + + + Linux Kernel Version + + 3.12 + + + + Supported Drivers + + Ethernet, I2C, SPI, PCI Express, USB, Flash, + SD/SDHC/SDXC, RTC + + + + Enea rpm folder for downloading RPM packages for this + target + + https://linux.enea.com/6/p2041rgb/rpm + + + + +
+
+
\ No newline at end of file diff --git a/doc/book-enea-linux-release-info/doc/eltf_params_updated_template_how_to_use.txt b/doc/book-enea-linux-release-info/doc/eltf_params_updated_template_how_to_use.txt new file mode 100644 index 0000000..7f1d3cb --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/eltf_params_updated_template_how_to_use.txt @@ -0,0 +1,320 @@ +eltf_params_template_updated_howto_use.txt + +This is a way to collect all parameters for an Enea Linux 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 Linux 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-linux-release-info/doc/getting_enea_linux.xml b/doc/book-enea-linux-release-info/doc/getting_enea_linux.xml index 93a5c59..055be15 100644 --- a/doc/book-enea-linux-release-info/doc/getting_enea_linux.xml +++ b/doc/book-enea-linux-release-info/doc/getting_enea_linux.xml @@ -33,38 +33,34 @@ Make sure that the repo tool is installed. If not, follow the - instructions below: + instructions below. The instruction assumes a suitable place in your + PATH to use. You might change that.INFO: Below is include of + ID "eltf-getting-repo-install-command" from + eltf_params_updated.xml - $ curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo -$ chmod a+x ~/bin/repoThe instruction assumes that ~/bin - exists and is included in the PATH variable. + - Use the repo tool to download the source:FIXME: At final - release the tag for the manifest must be set in mainfest_conf.mk as - MANIFESTHASH, typically something like refs/tags/EL6. Before final - release, it is possible to set MANIFESTHASH on the make command line - to override the value, e.g. with a commit hash string for a release - candidate to be tested + Use the repo tool to download the source: Please define MACHINE + to your target, uncomment and use one of the MACHINE lines listed + here,Below is the "machine_list" programlisting in + machine_list_generated.xml created by the make system by extracting + from the manifest - $ mkdir enea-linux -$ cd enea-linux -$ repo init -u \ - -b \ - -m <manifest file> -$ repo sync + - The parameter <manifest file> depends on the target. Use - the following: + and use the repo command below: Below is include of ID + "eltf-repo-cloning-enea-linux" from eltf_params_updated.xml. Here the + $MACHINE shall be given! - + diff --git a/doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml index 0cd0b13..173046b 100644 --- a/doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml +++ b/doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml @@ -6,16 +6,20 @@ 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 Linux regardless of - when they will be included by the open source project. Remaining issues are - listed below. + upstream, and the corrections are included in Enea Linux 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 + Linux 6" and needs to be adapted when a release info for another EL version + changes.
Yocto The Yocto Project community uses a Bugzilla database to track - information on reported bugs and other issues: - + information on reported bugs and other issues: https://bugzilla.yoctoproject.org.
@@ -26,7 +30,9 @@ 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. + to version 3.81.INFO It is possible to hide this entire + subsection by setting condition hidden on the section + element @@ -43,7 +49,8 @@ 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. + 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 @@ -63,7 +70,8 @@ Example with Failing QEMU Package As an example, the qemu installation can show the following - error. + 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 diff --git a/doc/book-enea-linux-release-info/doc/main_changes.xml b/doc/book-enea-linux-release-info/doc/main_changes.xml index c295ade..115acb5 100644 --- a/doc/book-enea-linux-release-info/doc/main_changes.xml +++ b/doc/book-enea-linux-release-info/doc/main_changes.xml @@ -17,7 +17,7 @@ New Yocto version (). See https://www.yoctoproject.org/downloads/core/krogoth21. diff --git a/doc/book-enea-linux-release-info/doc/prerequisites.xml b/doc/book-enea-linux-release-info/doc/prerequisites.xml index fb2d208..9c5aa95 100644 --- a/doc/book-enea-linux-release-info/doc/prerequisites.xml +++ b/doc/book-enea-linux-release-info/doc/prerequisites.xml @@ -4,11 +4,8 @@ Prerequisites - - Building Enea Linux or compiling applications requires that your git - environment be setup properly, and for certain packages to be installed on + environment be setup properly and for certain packages to be installed on your Linux development host. Please refer to $ git config --global user.name "John Doe" $ git config --global user.email johndoe@example.com -
- Ubuntu 14.04 LTS, 64-bit + 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. - For the supported distribution(s) you need the following packages: - INFO: The programlisting below is a parameter 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-linux-release-info/doc/system_requirements.xml b/doc/book-enea-linux-release-info/doc/system_requirements.xml index 2c14761..e94d012 100644 --- a/doc/book-enea-linux-release-info/doc/system_requirements.xml +++ b/doc/book-enea-linux-release-info/doc/system_requirements.xml @@ -15,7 +15,7 @@ and the Yocto Project Reference Manual http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements. - If needed, replace the Yocto version in the links provided with a more + If needed, replace the Yocto version in the link(s) provided with a more recent version. diff --git a/doc/docsrc_common/pardoc-distro.xml b/doc/docsrc_common/pardoc-distro.xml index 6434ab9..32fbf2a 100644 --- a/doc/docsrc_common/pardoc-distro.xml +++ b/doc/docsrc_common/pardoc-distro.xml @@ -1,14 +1,6 @@ - - - -%common_poky_entities; -]> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> @@ -23,21 +15,12 @@ must be included, not just parts of them. **** The phrase elements below can be used as variables in several - places in XML files **** - - You can add more elements using ENTITY lines in poky.ent, e.g. like Poky_VER below + places in XML files and/or in make script files **** -&ENEA_LINUX_REL_VER; -https://linux.enea.com/&ENEA_LINUX_REL_VER; -&POKYVERSION; -&DISTRO; -&DISTRO_NAME_NO_CAP; -&YOCTO_RELEASE_NOTES; - doc/book-enea-linux-open-source/doc/licenses.xml doc/book-enea-linux-open-source/doc/licenses.xml diff --git a/doc/initbuildboot.sh b/doc/initbuildboot.sh index ea8dc12..37b691f 100644 --- a/doc/initbuildboot.sh +++ b/doc/initbuildboot.sh @@ -1,14 +1,16 @@ #!/bin/sh -VER="R0.06" +VER="R0.07" +# R0.07/lejo 2017-01-20 Add -readmebasedir to the README files from the manifest instead of s_targets BBTEMPLATE= BBXML= +BB_TARGETREADME_BASE= -USAGE="`basename $0` -xml buildbootxml-to-create -template templatexml-file ($VER) +USAGE="`basename $0` -xml buildbootxml-to-create -template templatexml-file -readmebasedir targetreadmebase ($VER) Currently only supports sequence types Build-command: and Boot-command: Both files should have path book-*release-info/doc/ Creates the XML file from the template, inserting build/boot commands - from the various s_targets/XXXtargetXXX/README files + from the various s_manifests/el_manifest-XXX/XXXtargetXXX/README files at the place in template with >SCRIPT_INCLUDES_BUILD_BOOT_SECTIONS_HERE< ignoring rest of template The code tries to fold too long lines, but this is not perfect. Best would @@ -21,14 +23,16 @@ do if [ "$OPT" = "--help" -o "$OPT" = "-h" -o "$OPT" = "-help" ] ; then echo "$USAGE" ; exit ; fi if [ "$OPT" = "-xml" ] ; then BBXML="$1" ; shift; fi if [ "$OPT" = "-template" ] ; then BBTEMPLATE="$1" ; shift; fi + if [ "$OPT" = "-readmebasedir" ] ; then BB_TARGETREADME_BASE="$1" ; shift; fi done if [ "$BBTEMPLATE" = "" ]; then echo "ERROR: Missing option -template templatefile"; exit ; fi if [ "$BBXML" = "" ]; then echo "ERROR: Missing option -xml buildbootxml-to-create"; exit ; fi if [ ! -f "$BBTEMPLATE" ]; then echo "ERROR: Missing templatefile '$BBTEMPLATE'"; exit; fi if [ ! -d "`dirname \"$BBXML\"`" ]; then echo "ERROR: Missing parent directory for '$BBXML'"; exit ; fi +if [ ! -d "$BB_TARGETREADME_BASE" ]; then echo "ERROR: Missing basedir for README files '$BB_TARGETREADME_BASE'"; exit; fi echo "`basename $0` Creating $BBXML from" -TARGETREADMES=`cd s_targets ; ls -d */README | tr '\n' ' '` +TARGETREADMES=`cd $BB_TARGETREADME_BASE ; ls -d */README | tr '\n' ' '` echo " $TARGETREADMES" # README file formats: @@ -77,7 +81,7 @@ extractcmds_filter() { } extractcmds_for_type() { # target/README BOOTorBUILD - README=s_targets/"$1" + README=$BB_TARGETREADME_BASE/"$1" CMDTYPE="$2" COMMANDSFOR=`egrep "___$CMDTYPE:" $README` for CMDS in $COMMANDSFOR -- cgit v1.2.3-54-g00ecf