1 files changed, 80 insertions, 74 deletions

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/<tagvalue> 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/.*<phrase>//;s/<\/phrase>.*//'` ; \
-               DISTRO_VERSION_MINOR=`egrep '"EneaLinux_DISTRO_VERSION_MINOR"' s_docsrc_common/pardoc-distro.xml | sed 's/.*<phrase>//;s/<\/phrase>.*//'` ; \
-               BOOKVER="Profile $(PROFILE_NAME)-$$DISTRO_VERSION_MAJOR$$DISTRO_VERSION_MINOR" ; \
+        $(VERB)DISTRO_VERSION=`egrep '"EneaLinux_REL_VER"><phrase>' $(ELTF_PARAMS_UPDATED) | sed 's/.*<phrase>//;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 "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>" >$(MANIFESTFILES_XML) ; \
-           echo "<!DOCTYPE section PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\"" >>$(MANIFESTFILES_XML) ; \
-           echo "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\">" >>$(MANIFESTFILES_XML) ; \
-           echo "<section id=\"manifestfiles\">" >>$(MANIFESTFILES_XML) ; \
-           echo "<programlisting>$$TARGETDEFAULTXMLS</programlisting>" >>$(MANIFESTFILES_XML) ; \
-           echo "</section>" >>$(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 "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>" >$(MACHINE_LIST_XML) ; \
+           echo "<!DOCTYPE para PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\"" >>$(MACHINE_LIST_XML) ; \
+           echo "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\">" >>$(MACHINE_LIST_XML) ; \
+           echo "<para id=\"machine-list\">" >>$(MACHINE_LIST_XML) ; \
+           echo "<programlisting># Set MACHINE to ONE of the targets in this release!" >>$(MACHINE_LIST_XML) ; \
+           echo "$$TARGET_LIST</programlisting>" >>$(MACHINE_LIST_XML) ; \
+           echo "</para>" >>$(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 '/<!ENTITY ENEA_LINUX_REL_VER/s/MAJOR.MINOR/'"$$DISTRO_VERSION_MAJOR$$DISTRO_VERSION_MINOR"'/' | \
-             sed '/<!ENTITY . common_poky_entities SYSTEM/s/s_targets\/[^\/]*\/poky/s_targets\/'"$$FIRSTTARGET"'\/poky/' >$(TMPPARDOC) ; \
-          echo "<para id=\"EneaLinux_DISTRO_VERSION_MAJOR\"><phrase>$$DISTRO_VERSION_MAJOR</phrase></para>" >>$(TMPPARDOC) ; \
-          echo "<para id=\"EneaLinux_DISTRO_VERSION_MINOR\"><phrase>$$DISTRO_VERSION_MINOR</phrase></para>" >>$(TMPPARDOC) ; \
-          echo "<para id=\"EneaLinux_PROFILE_NAME\"><phrase>$(PROFILE_NAME)</phrase></para>" >>$(TMPPARDOC) ; \
-          echo "<para id=\"EneaLinux_MANIFESTURL\"><phrase>$(MANIFESTURL)</phrase></para>" >>$(TMPPARDOC) ; \
-          echo "<para id=\"EneaLinux_MANIFESTHASH\"><phrase>$(MANIFESTHASH)</phrase></para>" >>$(TMPPARDOC) ; \
-          echo "</section>" >>$(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 <!-- ELTFADD_MORE_TARGET_SECTIONS_BELOW_IF_NEEDED --> 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 <!-- ELTFADD_MORE_TARGET_SECTIONS_BELOW_IF_NEEDED -->"
+        @echo "#                   but that would often only be two final </section> </section> 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 &amp; &lt; &gt; 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"