summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiruna Paun <Miruna.Paun@enea.com>2017-04-10 12:38:48 +0200
committerMiruna Paun <Miruna.Paun@enea.com>2017-04-10 12:38:48 +0200
commit13da278fea34982e5eb398af09e9bd82c050a71c (patch)
treeea1437ba47a7ccfed1720fc39bfee5649ff84b42
parent5a049353e8294b8c7c181430c8ef2744cecdb605 (diff)
downloadel_releases-networking-13da278fea34982e5eb398af09e9bd82c050a71c.tar.gz
Updating El6-Network Relnotes
LXCR-7377 Tweaking the last of needed info, build files Signed-off-by: Miruna Paun <Miruna.Paun@enea.com>
-rw-r--r--doc/Makefile154
-rw-r--r--doc/book-enea-linux-open-source/doc/about.xml2
-rw-r--r--doc/book-enea-linux-open-source/doc/book.xml2
-rw-r--r--doc/book-enea-linux-release-info/doc/about_release.xml187
-rw-r--r--doc/book-enea-linux-release-info/doc/book.xml2
-rw-r--r--doc/book-enea-linux-release-info/doc/build_boot_template.xml12
-rw-r--r--doc/book-enea-linux-release-info/doc/eltf_params_template.xml151
-rw-r--r--doc/book-enea-linux-release-info/doc/eltf_params_updated.xml165
-rw-r--r--doc/book-enea-linux-release-info/doc/eltf_params_updated_template_how_to_use.txt320
-rw-r--r--doc/book-enea-linux-release-info/doc/getting_enea_linux.xml46
-rw-r--r--doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml24
-rw-r--r--doc/book-enea-linux-release-info/doc/main_changes.xml2
-rw-r--r--doc/book-enea-linux-release-info/doc/prerequisites.xml29
-rw-r--r--doc/book-enea-linux-release-info/doc/system_requirements.xml2
-rw-r--r--doc/docsrc_common/pardoc-distro.xml23
-rw-r--r--doc/initbuildboot.sh14
16 files changed, 831 insertions, 304 deletions
diff --git a/doc/Makefile b/doc/Makefile
index 0b23b4f..9c68e80 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -1,3 +1,5 @@
1#2017-03-27 Replaced poky autocloning for parameter extraction with XML file updated by the ELTF test system
2
1#Path to this subsystem's root directory 3#Path to this subsystem's root directory
2SUBSYSROOT := $(shell pwd) 4SUBSYSROOT := $(shell pwd)
3 5
@@ -7,21 +9,13 @@ include manifest_conf.mk
7MANIFESTDIR := $(shell echo "$(MANIFESTURL)" | sed 's/.*\///;s/\.git//') 9MANIFESTDIR := $(shell echo "$(MANIFESTURL)" | sed 's/.*\///;s/\.git//')
8 10
9# Further down we extract the list of target manifest file names from the manifest itself 11# Further down we extract the list of target manifest file names from the manifest itself
10# We need all to get all README, but only first in alphabetic list is used to extract info from poky/ 12
11 13
12 14
13# ***************** Generic docbuild.git auto-clone + s_docbuild symlink *** 15# ***************** Generic docbuild.git auto-clone + s_docbuild symlink ***
14# This also defines TMPCLONEROOT which optionally can be nondefault using BOOK_GLOBALCLONEROOT=yes or a path 16# This also defines TMPCLONEROOT which optionally can be nondefault using BOOK_GLOBALCLONEROOT=yes or a path
15include init.mk 17include init.mk
16 18
17# ****************** SUPPORT FOR TARGETS ***************************
18PATH_TARGETS = $(SUBSYSROOT)/s_targets
19#Git repositories to be cloned
20NAME_TARGETS := targets
21#Path to the directory under which repos shall be cloned.
22DOCBASEDIR=$(shell pwd)
23REPODIR=$(DOCBASEDIR)/..
24TMPCLONEROOT_TARGETS := $(TMPCLONEROOT)/$(NAME_TARGETS)
25TMPCLONEROOT_MANIFEST := $(TMPCLONEROOT)/manifest 19TMPCLONEROOT_MANIFEST := $(TMPCLONEROOT)/manifest
26 20
27 21
@@ -32,7 +26,11 @@ BUILDBOOT_TEMPLATE := book-enea-linux-release-info/doc/build_boot_template.xml
32PKGDIFF_GEN_XML := book-enea-linux-release-info/doc/pkgdiff_generated.xml 26PKGDIFF_GEN_XML := book-enea-linux-release-info/doc/pkgdiff_generated.xml
33JIRA_ISSUES_GEN_XML := book-enea-linux-release-info/doc/jiraissues_generated.xml 27JIRA_ISSUES_GEN_XML := book-enea-linux-release-info/doc/jiraissues_generated.xml
34 28
35MANIFESTFILES_XML := book-enea-linux-release-info/doc/manifestfiles_generated.xml 29MACHINE_LIST_XML := book-enea-linux-release-info/doc/machine_list_generated.xml
30
31ELTF_PARAMS_TEMPLATE := book-enea-linux-release-info/doc/eltf_params_template.xml
32ELTF_PARAMS_UPDATED := book-enea-linux-release-info/doc/eltf_params_updated.xml
33
36 34
37 35
38# ----------------------------------------------------- 36# -----------------------------------------------------
@@ -73,12 +71,12 @@ VALIDATE = no
73# Export all parameters including those on the command line 71# Export all parameters including those on the command line
74export 72export
75 73
76.PHONY: doc books docusage init initbuild initmanifest inittargets initpardoc initbuildboot dist 74.PHONY: doc books docusage init initbuild initmanifest initpardoc initbuildboot dist
77 75
78 76
79docusage: 77docusage:
80 @echo 'make docusage #Shows this help text' 78 @echo 'make docusage #Shows this help text'
81 @echo ' DOCBOOK_TOOLS_VERSIONS=yes #Displays DocBook tools versions in this machine' 79 @echo ' DOCBOOK_TOOLS_VERSIONS=yes #Displays./testeltfver.sh DocBook tools versions in this machine'
82 @echo 'make doc #Builds doc. ALSO automatically does all inits if needed' 80 @echo 'make doc #Builds doc. ALSO automatically does all inits if needed'
83 @echo 'make dist BOOK_DIST_DIR=xx/doc #Builds doc as above and copies results to BOOK_DIST_DIR' 81 @echo 'make dist BOOK_DIST_DIR=xx/doc #Builds doc as above and copies results to BOOK_DIST_DIR'
84 @echo ' # Does not work with DOCBOOK_TO_BOOKDIR or BOOK_BUILD_DIR' 82 @echo ' # Does not work with DOCBOOK_TO_BOOKDIR or BOOK_BUILD_DIR'
@@ -87,10 +85,10 @@ docusage:
87 @echo 'make init #Init all needed init* below' 85 @echo 'make init #Init all needed init* below'
88 @echo 'make initbuild #Init s_docbuild Docbook build system and central files' 86 @echo 'make initbuild #Init s_docbuild Docbook build system and central files'
89 @echo 'make initmanifest #Init s_manifest by cloning, to detect which targets are included' 87 @echo 'make initmanifest #Init s_manifest by cloning, to detect which targets are included'
90 @echo 'make inittargets #Init s_targets using repo tool. Targets in this distro with poky'
91 @echo 'make initpardoc #Init s_docsrc_common with extracted parameters/' 88 @echo 'make initpardoc #Init s_docsrc_common with extracted parameters/'
92 @echo 'make initbuildboot #Init build_boot chapter from READMEs and template in release info' 89 @echo 'make initbuildboot #Init build_boot chapter from READMEs and template in release info'
93 @echo 'make initissues #Init known issues section from Jira' 90 @echo 'make initissues #Init known issues section from Jira'
91 @echo 'make eltf #Test - displays all ELTF_xxx variables that ELTF shall replace'
94 @echo ' MANIFESTHASH=xxxxx #Option for all inits above to use nondefault manifest version' 92 @echo ' MANIFESTHASH=xxxxx #Option for all inits above to use nondefault manifest version'
95 @echo ' #It shall either be ref/tags/<tagvalue> or a hashvalue' 93 @echo ' #It shall either be ref/tags/<tagvalue> or a hashvalue'
96 @echo ' #Configured tag or hashvalue $(MANIFESTHASH)' 94 @echo ' #Configured tag or hashvalue $(MANIFESTHASH)'
@@ -99,7 +97,6 @@ docusage:
99 @echo ' DOCBOOK_CLEANTMP=no #Option to keep temp files in doc/ and tmp/' 97 @echo ' DOCBOOK_CLEANTMP=no #Option to keep temp files in doc/ and tmp/'
100 @echo ' BOOK_GLOBALCLONEROOT=yes #Option for all init above to clone all outside the doc directory' 98 @echo ' BOOK_GLOBALCLONEROOT=yes #Option for all init above to clone all outside the doc directory'
101 @echo ' BOOK_GLOBALCLONEROOT=otherpath #Option for all init above to clone all to given path' 99 @echo ' BOOK_GLOBALCLONEROOT=otherpath #Option for all init above to clone all to given path'
102 @echo 'make pullbuild #git pull in s_docbuild'
103 @echo 'make clean #Clean results and all s_*, but not any external clones' 100 @echo 'make clean #Clean results and all s_*, but not any external clones'
104 @echo '' 101 @echo ''
105 @echo 'Optional parameters for make doc:' 102 @echo 'Optional parameters for make doc:'
@@ -184,9 +181,8 @@ endif
184 181
185books: init 182books: init
186# BOOKPACKAGES is defined in all book-*/swcomp.mk 183# BOOKPACKAGES is defined in all book-*/swcomp.mk
187 $(VERB)DISTRO_VERSION_MAJOR=`egrep '"EneaLinux_DISTRO_VERSION_MAJOR"' s_docsrc_common/pardoc-distro.xml | sed 's/.*<phrase>//;s/<\/phrase>.*//'` ; \ 184 $(VERB)DISTRO_VERSION=`egrep '"EneaLinux_REL_VER"><phrase>' $(ELTF_PARAMS_UPDATED) | sed 's/.*<phrase>//;s/<\/phrase>.*//'` ; \
188 DISTRO_VERSION_MINOR=`egrep '"EneaLinux_DISTRO_VERSION_MINOR"' s_docsrc_common/pardoc-distro.xml | sed 's/.*<phrase>//;s/<\/phrase>.*//'` ; \ 185 BOOKVER="Profile $(PROFILE_NAME)-$$DISTRO_VERSION" ; \
189 BOOKVER="Profile $(PROFILE_NAME)-$$DISTRO_VERSION_MAJOR$$DISTRO_VERSION_MINOR" ; \
190 for book in $(BOOKPACKAGES); do \ 186 for book in $(BOOKPACKAGES); do \
191 for format in $(FORMAT); do \ 187 for format in $(FORMAT); do \
192 $(MAKE) -f $(DOCBOOKMAKE)/make_docbook_standalone.mk BOOK=$$book FORMAT=$$format BOOK_VER="$$BOOKVER" books || exit 10; \ 188 $(MAKE) -f $(DOCBOOKMAKE)/make_docbook_standalone.mk BOOK=$$book FORMAT=$$format BOOK_VER="$$BOOKVER" books || exit 10; \
@@ -216,7 +212,6 @@ endif
216# ****************************************************************** 212# ******************************************************************
217# ****************** SUPPORT FOR TARGETS *************************** 213# ****************** SUPPORT FOR TARGETS ***************************
218initmanifest: s_manifest 214initmanifest: s_manifest
219inittargets: s_targets
220 215
221 216
222# ----------------------------------------- 217# -----------------------------------------
@@ -229,8 +224,8 @@ s_manifest: $(TMPCLONEROOT_MANIFEST)
229 $(VERB)rm s_manifest 2>/dev/null; ln -s $(TMPCLONEROOT_MANIFEST) s_manifest 224 $(VERB)rm s_manifest 2>/dev/null; ln -s $(TMPCLONEROOT_MANIFEST) s_manifest
230 225
231cleanmanifest: 226cleanmanifest:
232 @echo "Cleaning generated manifestfilelist XML document file" 227 @echo "Cleaning generated manifest files"
233 $(VERB)rm -f $(MANIFESTFILES_XML) 2>/dev/null 228 $(VERB)rm -f $(MACHINE_LIST_XML) 2>/dev/null
234 $(VERB)rm -rf "$(TMPCLONEROOT_MANIFEST)" s_manifest 2>/dev/null 229 $(VERB)rm -rf "$(TMPCLONEROOT_MANIFEST)" s_manifest 2>/dev/null
235 230
236$(TMPCLONEROOT_MANIFEST): 231$(TMPCLONEROOT_MANIFEST):
@@ -241,41 +236,16 @@ $(TMPCLONEROOT_MANIFEST):
241 cd "$(TMPCLONEROOT_MANIFEST)"; git clone $(MANIFESTURL) ; cd $(MANIFESTDIR) ; git checkout $(MANIFESTHASH) 236 cd "$(TMPCLONEROOT_MANIFEST)"; git clone $(MANIFESTURL) ; cd $(MANIFESTDIR) ; git checkout $(MANIFESTHASH)
242 $(VERB)if [ ! -d "$(TMPCLONEROOT_MANIFEST)/$(MANIFESTDIR)" ]; then echo "ERROR: Missing $(TMPCLONEROOT_MANIFEST)/$(MANIFESTDIR)"; exit 10 ; fi ; \ 237 $(VERB)if [ ! -d "$(TMPCLONEROOT_MANIFEST)/$(MANIFESTDIR)" ]; then echo "ERROR: Missing $(TMPCLONEROOT_MANIFEST)/$(MANIFESTDIR)"; exit 10 ; fi ; \
243 TARGETDEFAULTXMLS=`cd $(TMPCLONEROOT_MANIFEST)/$(MANIFESTDIR); ls -1 */default.xml 2>/dev/null` ; \ 238 TARGETDEFAULTXMLS=`cd $(TMPCLONEROOT_MANIFEST)/$(MANIFESTDIR); ls -1 */default.xml 2>/dev/null` ; \
244 echo "$$TARGETDEFAULTXMLS" | tr '\n' ' ' >$(TMPCLONEROOT_MANIFEST)/targetdefaultxmls.txt ; \ 239 TARGET_LIST=`echo "$$TARGETDEFAULTXMLS" | sed 's/\/default.xml//;s/^/# export MACHINE=/'` ; \
245 echo "$$TARGETDEFAULTXMLS" | sed 's/\/.*//' | tr '\n' ' ' >$(TMPCLONEROOT_MANIFEST)/targetids.txt ; \ 240 echo "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>" >$(MACHINE_LIST_XML) ; \
246 echo "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>" >$(MANIFESTFILES_XML) ; \ 241 echo "<!DOCTYPE para PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\"" >>$(MACHINE_LIST_XML) ; \
247 echo "<!DOCTYPE section PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\"" >>$(MANIFESTFILES_XML) ; \ 242 echo "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\">" >>$(MACHINE_LIST_XML) ; \
248 echo "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\">" >>$(MANIFESTFILES_XML) ; \ 243 echo "<para id=\"machine-list\">" >>$(MACHINE_LIST_XML) ; \
249 echo "<section id=\"manifestfiles\">" >>$(MANIFESTFILES_XML) ; \ 244 echo "<programlisting># Set MACHINE to ONE of the targets in this release!" >>$(MACHINE_LIST_XML) ; \
250 echo "<programlisting>$$TARGETDEFAULTXMLS</programlisting>" >>$(MANIFESTFILES_XML) ; \ 245 echo "$$TARGET_LIST</programlisting>" >>$(MACHINE_LIST_XML) ; \
251 echo "</section>" >>$(MANIFESTFILES_XML) 246 echo "</para>" >>$(MACHINE_LIST_XML)
252
253
254# -----------------------------------------
255# Use repo to auto-clone each target separately - VERY LARGE if there are many targets (5 targets => about 1.3 Gbytes)
256
257s_targets: $(TMPCLONEROOT_TARGETS)
258 $(VERB)rm s_targets 2>/dev/null; ln -s $(TMPCLONEROOT_TARGETS) s_targets
259 247
260 248
261$(TMPCLONEROOT_TARGETS): s_manifest
262 $(VERB)if [ ! -d "$(TMPCLONEROOT)" ] ; then mkdir -p "$(TMPCLONEROOT)" ; fi
263 $(VERB)if [ ! -d $(TMPCLONEROOT_TARGETS) ]; then mkdir -p $(TMPCLONEROOT_TARGETS) ; fi
264 @echo "**** Cloning all targets using repo tool into $(TMPCLONEROOT_TARGETS)"
265 $(VERB)if [ ! -f "$(TMPCLONEROOT_MANIFEST)/targetdefaultxmls.txt" ]; then echo "ERROR: Missing $(TMPCLONEROOT_MANIFEST)/targetdefaultxmls.txt"; exit 10; fi
266 $(VERB)TARGETDEFAULTXMLS=`cat "$(TMPCLONEROOT_MANIFEST)/targetdefaultxmls.txt" 2>/dev/null` ; \
267 echo "Info: TARGETDEFAULTXMLS is $$TARGETDEFAULTXMLS" ; \
268 for target_default_xml in $$TARGETDEFAULTXMLS; \
269 do \
270 TARGDIR=$(TMPCLONEROOT_TARGETS)/`dirname $$target_default_xml` ; \
271 echo "TARGDIR=<$$TARGDIR>" ; \
272 if [ ! -d $$TARGDIR ]; then mkdir -p $$TARGDIR ; fi ; \
273 ( cd $$TARGDIR ; \
274 echo "*** Doing repo init -u $(MANIFESTURL) -b $(MANIFESTHASH) -m $$target_default_xml ; repo sync"; \
275 repo init -u $(MANIFESTURL) -b $(MANIFESTHASH) -m $$target_default_xml ; repo sync ; \
276 ) ; \
277 done
278
279# **************************************************************************** 249# ****************************************************************************
280# ******************** SUPPORT FOR dynamic pardoc with added parameters ****** 250# ******************** SUPPORT FOR dynamic pardoc with added parameters ******
281# pardoc-distro can contain MAJOR.MINOR-xxxxx keeping -xxxx when replacing MINOR.MINOR from enea.conf 251# pardoc-distro can contain MAJOR.MINOR-xxxxx keeping -xxxx when replacing MINOR.MINOR from enea.conf
@@ -291,32 +261,18 @@ cleanpardoc:
291 @echo "Cleaning dynamic parameters" 261 @echo "Cleaning dynamic parameters"
292 $(VERB)rm -rf $(TMPCLONEROOT_DOCSRC_COMMON) ; rm s_docsrc_common 262 $(VERB)rm -rf $(TMPCLONEROOT_DOCSRC_COMMON) ; rm s_docsrc_common
293 263
264
294s_docsrc_common: $(TMPCLONEROOT_DOCSRC_COMMON) 265s_docsrc_common: $(TMPCLONEROOT_DOCSRC_COMMON)
295 $(VERB)rm s_docsrc_common 2>/dev/null; ln -s $(TMPCLONEROOT_DOCSRC_COMMON) s_docsrc_common 266 $(VERB)rm s_docsrc_common 2>/dev/null; ln -s $(TMPCLONEROOT_DOCSRC_COMMON) s_docsrc_common
296 267
297$(TMPCLONEROOT_DOCSRC_COMMON): s_targets 268$(TMPCLONEROOT_DOCSRC_COMMON):
298 $(VERB)if [ ! -d "$(TMPCLONEROOT)" ] ; then mkdir -p "$(TMPCLONEROOT)" ; fi 269 $(VERB)if [ ! -d "$(TMPCLONEROOT)" ] ; then mkdir -p "$(TMPCLONEROOT)" ; fi
299 $(VERB)if [ ! -d $(TMPCLONEROOT_DOCSRC_COMMON) ]; then mkdir -p $(TMPCLONEROOT_DOCSRC_COMMON) ; fi 270 $(VERB)if [ ! -d $(TMPCLONEROOT_DOCSRC_COMMON) ]; then mkdir -p $(TMPCLONEROOT_DOCSRC_COMMON) ; fi
300 @echo "**** Copy and patch docsrc_common/ files to $(TMPCLONEROOT_DOCSRC_COMMON)" 271 @echo "**** Copy docsrc_common/ files to $(TMPCLONEROOT_DOCSRC_COMMON)"
301 @echo "*** Add parameters from first target's enea.conf and add manifest parameters" 272 $(VERB)cat docsrc_common/pardoc-distro.xml >$(TMPPARDOC)
302 $(VERB)FIRSTTARGET=`ls -1 s_targets/ 2>/dev/null | head -1`; \
303 if [ "$$FIRSTTARGET" = "" ]; then echo "ERROR: No targets?" ; exit 10; fi ; \
304 ENEACONF=s_targets/$$FIRSTTARGET/poky/meta-el-common/conf/distro/enea.conf ; \
305 if [ ! -f "$$ENEACONF" ]; then echo "ERROR: No $$ENEACONF?" ; exit 10; fi ; \
306 DISTRO_VERSION_MAJOR=`egrep '^DISTRO_VERSION_MAJOR' $$ENEACONF | sed 's/^[^"]*"//;s/".*//'` ; \
307 DISTRO_VERSION_MINOR=`egrep '^DISTRO_VERSION_MINOR' $$ENEACONF | sed 's/^[^"]*"//;s/".*//'` ; \
308 cat docsrc_common/pardoc-distro.xml | sed '/<\/section>/d' | \
309 sed '/<!ENTITY ENEA_LINUX_REL_VER/s/MAJOR.MINOR/'"$$DISTRO_VERSION_MAJOR$$DISTRO_VERSION_MINOR"'/' | \
310 sed '/<!ENTITY . common_poky_entities SYSTEM/s/s_targets\/[^\/]*\/poky/s_targets\/'"$$FIRSTTARGET"'\/poky/' >$(TMPPARDOC) ; \
311 echo "<para id=\"EneaLinux_DISTRO_VERSION_MAJOR\"><phrase>$$DISTRO_VERSION_MAJOR</phrase></para>" >>$(TMPPARDOC) ; \
312 echo "<para id=\"EneaLinux_DISTRO_VERSION_MINOR\"><phrase>$$DISTRO_VERSION_MINOR</phrase></para>" >>$(TMPPARDOC) ; \
313 echo "<para id=\"EneaLinux_PROFILE_NAME\"><phrase>$(PROFILE_NAME)</phrase></para>" >>$(TMPPARDOC) ; \
314 echo "<para id=\"EneaLinux_MANIFESTURL\"><phrase>$(MANIFESTURL)</phrase></para>" >>$(TMPPARDOC) ; \
315 echo "<para id=\"EneaLinux_MANIFESTHASH\"><phrase>$(MANIFESTHASH)</phrase></para>" >>$(TMPPARDOC) ; \
316 echo "</section>" >>$(TMPPARDOC)
317 273
318# **************************************************************************** 274# ****************************************************************************
319# ***** Create XML chapter with build/boot commands from all README files in s_targets 275# ***** Create XML chapter with build/boot commands from all README files in manifest
320 276
321initbuildboot: $(BUILDBOOT_XML) 277initbuildboot: $(BUILDBOOT_XML)
322 278
@@ -325,11 +281,11 @@ cleanbuildboot:
325 $(VERB)rm -f $(BUILDBOOT_XML) 2>/dev/null 281 $(VERB)rm -f $(BUILDBOOT_XML) 2>/dev/null
326 282
327 283
328$(BUILDBOOT_XML): s_targets $(BUILDBOOT_TEMPLATE) 284$(BUILDBOOT_XML): $(BUILDBOOT_TEMPLATE)
329 @echo "**** Creating $(BUILDBOOT_XML) from READMEs" 285 @echo "**** Creating $(BUILDBOOT_XML) from READMEs"
330 $(VERB)INITBB_CMD=initbuildboot.sh ; \ 286 $(VERB)INITBB_CMD=initbuildboot.sh ; \
331 if [ -f "$$INITBB_CMD" ]; then \ 287 if [ -f "$$INITBB_CMD" ]; then \
332 sh "$$INITBB_CMD" -xml $(BUILDBOOT_XML) -template $(BUILDBOOT_TEMPLATE) ; \ 288 sh "$$INITBB_CMD" -xml $(BUILDBOOT_XML) -template $(BUILDBOOT_TEMPLATE) -readmebasedir s_manifest/$(MANIFESTDIR); \
333 else \ 289 else \
334 echo "ERROR: Missing $$INITBB_CMD, can not create $(BUILDBOOT_XML)"; exit 10; \ 290 echo "ERROR: Missing $$INITBB_CMD, can not create $(BUILDBOOT_XML)"; exit 10; \
335 fi 291 fi
@@ -357,6 +313,7 @@ $(PKGDIFF_GEN_XML):
357 313
358initissues: $(JIRA_ISSUES_GEN_XML) 314initissues: $(JIRA_ISSUES_GEN_XML)
359 315
316
360cleanissues: 317cleanissues:
361 @echo "Cleaning generated known issues document file" 318 @echo "Cleaning generated known issues document file"
362 $(VERB)rm -f $(JIRA_ISSUES_GEN_XML) 2>/dev/null 319 $(VERB)rm -f $(JIRA_ISSUES_GEN_XML) 2>/dev/null
@@ -366,3 +323,52 @@ $(JIRA_ISSUES_GEN_XML):
366 $(VERB)python gen_known_issues.py >$(JIRA_ISSUES_GEN_XML) 323 $(VERB)python gen_known_issues.py >$(JIRA_ISSUES_GEN_XML)
367 324
368# **************************************************************************** 325# ****************************************************************************
326
327#
328# All ELTF_ variables names only has upper case, underline and digits
329eltf:
330 @echo "# make eltf extracts and displays all ELTF_ variables found here"
331 @echo "# in $(SUBSYSROOT)/$(ELTF_PARAMS_TEMPLATE)"
332 @echo "# Replace all variables, creating a new eltf*updated.xml file from the eltf*template.xml"
333 @echo "#"
334 @echo "# Only replace + push the result file $(ELTF_PARAMS_UPDATED), IF IT WILL BE CHANGED."
335 @echo "#"
336 @echo "# IMPORTANT: See eltf_params_updated_template_how_to_use.txt for requirements and details!"
337 @echo "# Below is only a summary!"
338 @echo "#"
339 @echo "# ELTF_ variables must be UNIQUE, e.g. a variable must not be a part of another variable"
340 @echo "#"
341 @echo "# ELTF_PL_* and ELTF_T_PL_* shall have the format for programlisting and are often multiline - see below."
342 @echo "#"
343 @echo "# ELTF_*_URL and ELTF_*_TXTURL are the URL part and TXT part of ulink; those shall be exactly identical,"
344 @echo "# unless the URL is very very long."
345 @echo "#"
346 @echo "# ELTF_T_* are target (MACHINE) variables in one subsection, replace with machine specific strings."
347 @echo "#"
348 @echo "# Append more target subsections to *updated.xml, if more than one target is in a release!"
349 @echo "# Replace the line <!-- ELTFADD_MORE_TARGET_SECTIONS_BELOW_IF_NEEDED --> with appended"
350 @echo "# complete target section elements copied before the variables are replaced."
351 @echo "# In each target section, replace the ELTF_T* variables with machine dependent strings"
352 @echo "# Append final lines seen after <!-- ELTFADD_MORE_TARGET_SECTIONS_BELOW_IF_NEEDED -->"
353 @echo "# but that would often only be two final </section> </section> lines"
354 @echo "#"
355 @echo "# ELTF_ Variables: Replace each variable with a string, for ELTF_*PL* it can be multiline"
356 @echo "# DO NOT use any leading or trailing spaces and DO NOT use TABs"
357 @echo "#"
358 @echo "# ELTF_ Everywhere: Only 7-bit ASCII inside the string replacing a variable. Translate characters"
359 @echo "# like & < > to &amp; &lt; &gt; etc."
360 @echo "# unless real XML shall be inserted like when entire sections are appended."
361 @echo "#"
362 @echo "# ELTF_ programlisting, variables with PL in the name: Max line length < 80 char."
363 @echo "# Use backslash + indent-leading-spaces for continuation lines."
364 @echo "# Multiline. No trailing spaces on any line inside the programlisting."
365 @echo "#"
366 @echo "# The following variables shall be replaced with suitable contents (egrep from the template):"
367 @echo "# Again: See details in eltf_params_updated_template_how_to_use.txt"
368 @echo "# including also examples of contents of each variable!"
369 @echo "#"
370 $(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
371 @echo "# The make eltf also here extracts any left-over ELTF variables from $(ELTF_PARAMS_UPDATED)"
372 @echo "# It should not be any left here:"
373 $(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
374 @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 @@
6 6
7 <para>This document contains the open source and license information 7 <para>This document contains the open source and license information
8 pertaining to packages provided with Enea Linux <xi:include 8 pertaining to packages provided with Enea Linux <xi:include
9 href="../../s_docsrc_common/pardoc-distro.xml" 9 href="../../book-enea-linux-release-info/doc/eltf_params_updated.xml"
10 xmlns:xi="http://www.w3.org/2001/XInclude" 10 xmlns:xi="http://www.w3.org/2001/XInclude"
11 xpointer="element(EneaLinux_REL_VER/1)" />.</para> 11 xpointer="element(EneaLinux_REL_VER/1)" />.</para>
12</chapter> \ No newline at end of file 12</chapter> \ 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 @@
6<book id="book_enea_linux_open_source"> 6<book id="book_enea_linux_open_source">
7 <title><trademark class="registered">Enea</trademark> Linux Open Source Report</title> 7 <title><trademark class="registered">Enea</trademark> Linux Open Source Report</title>
8 <subtitle>Release Version 8 <subtitle>Release Version
9 <xi:include href="../../s_docsrc_common/pardoc-distro.xml" xpointer="element(EneaLinux_REL_VER/1)" 9 <xi:include href="../../book-enea-linux-release-info/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)"
10 xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle> 10 xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle>
11 <xi:include href="../../s_docbuild/template/docsrc_common/bookinfo_userdoc.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> 11 <xi:include href="../../s_docbuild/template/docsrc_common/bookinfo_userdoc.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
12 <xi:include href="about.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> 12 <xi:include href="about.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
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 @@
4<chapter id="relinfo-about-release"> 4<chapter id="relinfo-about-release">
5 <title>About This Release</title> 5 <title>About This Release</title>
6 6
7 <para>This release of Enea Linux <xi:include 7 <para>This release of Enea Linux <xi:include href="eltf_params_updated.xml"
8 href="../../s_docsrc_common/pardoc-distro.xml"
9 xmlns:xi="http://www.w3.org/2001/XInclude" 8 xmlns:xi="http://www.w3.org/2001/XInclude"
10 xpointer="element(EneaLinux_REL_VER/1)" /> provides a publicly available 9 xpointer="element(EneaLinux_REL_VER/1)" /> provides a publicly available
11 Enea Linux distribution for a selected set of targets. This release is 10 Enea Linux distribution for a selected set of targets. This release is
12 generated from the yocto distribution using the branch <xi:include 11 generated from the yocto <xi:include href="eltf_params_updated.xml"
13 href="../../s_docsrc_common/pardoc-distro.xml"
14 xmlns:xi="http://www.w3.org/2001/XInclude" 12 xmlns:xi="http://www.w3.org/2001/XInclude"
15 xpointer="element(Yocto_NAME/1)" />.<remark>INFO Yocto distro autopicked 13 xpointer="element(Yocto_VER/1)" /> distribution using the branch <xi:include
16 from poky.ent as DISTRO_NAME_NO_CAP</remark></para> 14 href="eltf_params_updated.xml" xmlns:xi="http://www.w3.org/2001/XInclude"
15 xpointer="element(Yocto_NAME/1)" />.<remark>INFO <emphasis
16 role="bold">eltf_params_updated.xml</emphasis> contains many parameters in
17 the book, also in the open source books, and MUST be created FROM <emphasis
18 role="bold">eltf_params_template.xml</emphasis>. The parameters are
19 automatically used in the books, via xi:include statements, similar to how
20 parameters from pardoc-distro.xml are included in the book. Read the file
21 <emphasis role="bold">eltf_params_updated_template_how_to_use.txt</emphasis>
22 for important details about formats and how to do! The idea is that ELTF
23 will auto-create/update it.</remark></para>
17 24
18 <section id="relinfo-provided-contents"> 25 <section id="relinfo-provided-contents">
19 <title>Provided Contents</title> 26 <title>Provided Contents</title>
@@ -43,8 +50,16 @@
43 </row> 50 </row>
44 51
45 <row> 52 <row>
46 <entry>Pre-built packages (RPM)</entry> 53 <entry>Pre-built packages (RPM). See links for each
54 target.<remark>INFO Below is an Eclipse row from
55 eltf_params_updated.xml. MANUALLY if eclipse is not included, set
56 condition hidden on the row element BOTH in template.xml and in
57 updated.xml.</remark></entry>
47 </row> 58 </row>
59
60 <xi:include href="eltf_params_updated.xml"
61 xmlns:xi="http://www.w3.org/2001/XInclude"
62 xpointer="element(eltf-eclipse-version-row)" />
48 </tbody> 63 </tbody>
49 </tgroup> 64 </tgroup>
50 </informaltable> 65 </informaltable>
@@ -96,76 +111,21 @@
96 111
97 <itemizedlist> 112 <itemizedlist>
98 <listitem> 113 <listitem>
99 <para>Ubuntu 14.04 LTS, 64-bit<remark>was 114 <para>Ubuntu 14.04 LTS, 64-bit<remark>Hardcoded now in this XML file.
100 EneaLinux_HOST_VER</remark></para> 115 Might be moved to the parameter file later.</remark><remark>INFO Below
116 is a complete section with ID "eltf-target-tables-section" included
117 from elft_params_updated.xml. It contains a variable number of target
118 tables and the section title should be "Supported Targets with
119 Parameters". It has have a short sentence about what it is in the
120 beginning. The subtitles shall have the directory name of the target
121 in the manifest.</remark></para>
101 </listitem> 122 </listitem>
102 </itemizedlist> 123 </itemizedlist>
103 </section> 124 </section>
104 125
105 <section id="relinfo-supported-versions"> 126 <xi:include href="eltf_params_updated.xml"
106 <title>Supported Versions</title> 127 xmlns:xi="http://www.w3.org/2001/XInclude"
107 128 xpointer="element(eltf-target-tables-section)" />
108 <informaltable>
109 <tgroup cols="2">
110 <thead valign="bottom">
111 <row>
112 <entry>Item</entry>
113
114 <entry>Version</entry>
115 </row>
116 </thead>
117
118 <tbody>
119 <row>
120 <entry><para>Yocto</para></entry>
121
122 <entry><xi:include href="../../s_docsrc_common/pardoc-distro.xml"
123 xmlns:xi="http://www.w3.org/2001/XInclude"
124 xpointer="element(Yocto_VER/1)" /> (<xi:include
125 href="../../s_docsrc_common/pardoc-distro.xml"
126 xmlns:xi="http://www.w3.org/2001/XInclude"
127 xpointer="element(Yocto_NAME/1)" />)<remark>INFO: Auto-fetched
128 from poky.ent via pardoc-distro.xml</remark></entry>
129 </row>
130
131 <row>
132 <entry>Poky</entry>
133
134 <entry><para>Git commit id:</para>
135 <para>75ca53211488a3e268037a44ee2a7ac5c7181bd2</para><remark>Problem:
136 Unfortunately the poky version in poky.ent is not correct unless
137 the EL release would be based on a Yocto release, so we can not
138 use that here. This is a problem because we don't want to manually
139 edit the git commit ID in this file? The poky version in poky.ent
140 is just now <xi:include
141 href="../../s_docsrc_common/pardoc-distro.xml"
142 xmlns:xi="http://www.w3.org/2001/XInclude"
143 xpointer="element(Poky_VER/1)" /></remark></entry>
144 </row>
145
146 <row>
147 <entry>GCC</entry>
148
149 <entry>5.3<remark>was EneaLinux_GCC_VER Not in poky.ent
150 </remark></entry>
151 </row>
152
153 <row>
154 <entry>Linux kernel<remark>was EneaLinux_KERNEL_VER Not in
155 poky.ent</remark></entry>
156
157 <entry><para>3.12</para></entry>
158 </row>
159
160 <row>
161 <entry>Packages</entry>
162
163 <entry>See <xref linkend="relinfo-packages" /></entry>
164 </row>
165 </tbody>
166 </tgroup>
167 </informaltable>
168 </section>
169 129
170 <section id="relinfo-packages"> 130 <section id="relinfo-packages">
171 <title>Provided Packages</title> 131 <title>Provided Packages</title>
@@ -194,6 +154,7 @@
194 class="registered">Enea</trademark> Linux Open Source 154 class="registered">Enea</trademark> Linux Open Source
195 Report</olink></para></entry> 155 Report</olink></para></entry>
196 </row> 156 </row>
157
197 </tbody> 158 </tbody>
198 </tgroup> 159 </tgroup>
199 </informaltable></para> 160 </informaltable></para>
@@ -211,76 +172,6 @@
211 toolchain.</para> 172 toolchain.</para>
212 </section> 173 </section>
213 174
214 <section id="relinfo-provided-drivers">
215 <title>Supported Drivers</title>
216
217 <informaltable>
218 <tgroup cols="2">
219 <colspec align="left" colwidth="3*" />
220
221 <colspec align="center" colwidth="2*" />
222
223 <thead>
224 <row>
225 <entry>Driver</entry>
226
227 <entry>P2041RDB</entry>
228 </row>
229 </thead>
230
231 <tbody>
232 <row>
233 <entry>Ethernet</entry>
234
235 <entry>X</entry>
236 </row>
237
238 <row>
239 <entry>I2C</entry>
240
241 <entry>X</entry>
242 </row>
243
244 <row>
245 <entry>SPI</entry>
246
247 <entry>X</entry>
248 </row>
249
250 <row>
251 <entry>PCI Express</entry>
252
253 <entry>X</entry>
254 </row>
255
256 <row>
257 <entry>USB</entry>
258
259 <entry>X</entry>
260 </row>
261
262 <row>
263 <entry>Flash</entry>
264
265 <entry>X</entry>
266 </row>
267
268 <row>
269 <entry>SD/SDHC/SDXC</entry>
270
271 <entry>X</entry>
272 </row>
273
274 <row>
275 <entry>RTC</entry>
276
277 <entry>X</entry>
278 </row>
279 </tbody>
280 </tgroup>
281 </informaltable>
282 </section>
283
284 <section id="relinfo-documentation"> 175 <section id="relinfo-documentation">
285 <title>Provided Documentation</title> 176 <title>Provided Documentation</title>
286 177
@@ -326,7 +217,7 @@
326 </listitem> 217 </listitem>
327 218
328 <listitem> 219 <listitem>
329 <para><trademark class="registered">Enea</trademark> Linux 6 Test 220 <para><trademark class="registered">Enea</trademark> Linux Test
330 Report</para> 221 Report</para>
331 </listitem> 222 </listitem>
332 223
@@ -343,7 +234,9 @@
343 234
344 <para>The functionality in a distribution depends on included packages in 235 <para>The functionality in a distribution depends on included packages in
345 the default image. In addition to the supported features, the following 236 the default image. In addition to the supported features, the following
346 functionality is also available, among other:</para> 237 functionality is also available, among other:<remark>INFO: This section
238 might be hidden by setting condition hidden on the section, MANUALLY in
239 this file.</remark></para>
347 240
348 <itemizedlist spacing="compact"> 241 <itemizedlist spacing="compact">
349 <listitem> 242 <listitem>
@@ -381,7 +274,9 @@
381 <title>Intentional Limitations</title> 274 <title>Intentional Limitations</title>
382 275
383 <para>The following functionality supported in other Enea Linux releases 276 <para>The following functionality supported in other Enea Linux releases
384 has been excluded in this release:<itemizedlist spacing="compact"> 277 has been excluded in this release:<remark>INFO: This section might be
278 hidden by setting condition hidden on the section, MANUALLY in this
279 file.</remark><itemizedlist spacing="compact">
385 <listitem> 280 <listitem>
386 <para>Networking features: DPDK vSwitch, DPDK</para> 281 <para>Networking features: DPDK vSwitch, DPDK</para>
387 </listitem> 282 </listitem>
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 @@
5<book id="book_enea_linux_release_info"> 5<book id="book_enea_linux_release_info">
6 <title><trademark class="registered">Enea</trademark> Linux Release Information</title> 6 <title><trademark class="registered">Enea</trademark> Linux Release Information</title>
7 <subtitle>Release Version 7 <subtitle>Release Version
8 <xi:include href="../../s_docsrc_common/pardoc-distro.xml" xpointer="element(EneaLinux_REL_VER/1)" 8 <xi:include href="eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)"
9 xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle> 9 xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle>
10 <xi:include href="../../s_docbuild/template/docsrc_common/bookinfo_userdoc.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> 10 <xi:include href="../../s_docbuild/template/docsrc_common/bookinfo_userdoc.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
11 <xi:include href="about_release.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> 11 <xi:include href="about_release.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
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 @@
10 reader, the contents of these build/boot instruction have been extracted 10 reader, the contents of these build/boot instruction have been extracted
11 into the following sections.</para> 11 into the following sections.</para>
12 12
13 <para><remark>NOTE: Only EDIT THE TEMPLATE FILE! A new build_boot.xml file 13 <para><remark>NOTE: Only EDIT THE TEMPLATE build_boot_template.xml file here
14 is created from the template and sections are added below automatically from 14 and also only edit the manifest template ".README" (name starting by a dot)!
15 the README files for each target when building the book! Only in the 15 A new build_boot_generated.xml file is created from the template and
16 template file you see a line below with SCRIPT_...._HERE and the text 16 sections are added below automatically from the README files for each target
17 telling that this is a template file.</remark></para> 17 when building the book! Only in the template file you see a line below with
18 SCRIPT_...._HERE and the text telling that this is a template
19 file.</remark></para>
18 20
19 <para>SCRIPT_INCLUDES_BUILD_BOOT_SECTIONS_HERE</para> 21 <para>SCRIPT_INCLUDES_BUILD_BOOT_SECTIONS_HERE</para>
20 22
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 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<section id="eltf_created_params">
5 <title>File with Parameters in the Book Auto-updated by ELFT</title>
6
7 <note>
8 <para>See the <emphasis
9 role="bold">eltf_params_updated_template_howto_use.txt</emphasis> text
10 file for description of how to create the final <emphasis
11 role="bold">eltf_params_updated.xml</emphasis> from this template and for
12 all <emphasis role="bold">REQUIREMENTS</emphasis>. Use the command
13 "<emphasis role="bold">make eltf</emphasis>" to extract a full list of all
14 ELTF variables, which always begins with ELTF_ and don't only rely on the
15 howto text file list! The plan is that ELTF will auto-update this when
16 needed.</para>
17 </note>
18
19 <section id="host_prereq">
20 <title>Common Parameters</title>
21
22 <bridgehead>A programlisting, ID
23 "eltf-prereq-apt-get-commands-host"</bridgehead>
24
25 <para id="eltf-prereq-apt-get-commands-host"><programlisting>ELTF_PL_HOST_PREREQ</programlisting></para>
26
27 <bridgehead>A programlisting, ID
28 "eltf-getting-repo-install-command"</bridgehead>
29
30 <para id="eltf-getting-repo-install-command"><programlisting>ELTF_PL_GET_REPO</programlisting></para>
31
32 <bridgehead>Several phrase elements, various IDs. Ensure EL_REL_VER is
33 correct also compared to the "previous" REL VER in pardoc-distro.xml
34 "prev_baseline".</bridgehead>
35
36 <para id="EneaLinux_REL_VER"><phrase>ELTF_EL_REL_VER</phrase></para>
37
38 <para id="Yocto_VER"><phrase>ELTF_YOCTO_VER</phrase></para>
39
40 <para id="Yocto_NAME"><phrase>ELTF_YOCTO_NAME</phrase></para>
41
42 <para id="ULINK_YOCTO_PROJECT_DOWNLOAD"><ulink
43 url="ELTF_YOCTO_PROJ_DOWNLOAD_URL">ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL</ulink></para>
44
45 <para id="ULINK_ENEA_LINUX_URL"><ulink
46 url="ELTF_EL_DOWNLOAD_URL">ELTF_EL_DOWNLOAD_TXTURL</ulink></para>
47
48 <bridgehead>A programlisting, ID "eltf-repo-cloning-enea-linux". Use
49 $MACHINE/default.xml as parameter, where MACHINE is one of the target
50 directory names in the manifest.</bridgehead>
51
52 <para id="eltf-repo-cloning-enea-linux"><programlisting>ELTF_PL_CLONE_W_REPO</programlisting></para>
53
54 <bridgehead>A table with ONE row, only the row with ID
55 "eltf-eclipse-version-row" is included in the book. MANUALLY BOTH in the
56 template.xml and in the updated.xml, set condition hidden on the
57 &lt;row&gt;, if eclipse is not in the release.</bridgehead>
58
59 <informaltable>
60 <tgroup cols="1">
61 <tbody>
62 <row id="eltf-eclipse-version-row">
63 <entry>Eclipse version ELTF_ECLIPSE_VERSION plus command line
64 development tools are included in this Enea Linux release.</entry>
65 </row>
66 </tbody>
67 </tgroup>
68 </informaltable>
69
70 <bridgehead>Below is one big section with title "Supported Targets with
71 Parameters". The entire section is included completely in the book via ID
72 "eltf-target-tables-section" and shall be LAST in the template. The
73 template contains ONE target subsection. COPY/APPEND it, if multiple
74 targets exist in the release and optionally add rows with additional
75 target parameters in each target subsection table.</bridgehead>
76 </section>
77
78 <section id="eltf-target-tables-section">
79 <title>Supported Targets with Parameters</title>
80
81 <para>The tables below describes the target(s) supported in this Enea
82 Linux release.</para>
83
84 <section id="eltf-target-table-ELTF_T_MANIFEST_DIR">
85 <title>MACHINE ELTF_T_MANIFEST_DIR - Information</title>
86
87 <para><informaltable>
88 <tgroup cols="2">
89 <colspec colwidth="6*" />
90
91 <colspec colwidth="9*" />
92
93 <tbody>
94 <row>
95 <entry>Target official name</entry>
96
97 <entry>ELTF_T_NAME</entry>
98 </row>
99
100 <row>
101 <entry>Architecture and Description</entry>
102
103 <entry>ELTF_T_ARC_DESC</entry>
104 </row>
105
106 <row>
107 <entry>Link to target datasheet</entry>
108
109 <entry>See <ulink
110 url="ELTF_T_DS_URL">ELTF_T_DS_TXTURL</ulink></entry>
111 </row>
112
113 <row>
114 <entry>Poky version</entry>
115
116 <entry>ELTF_T_POKY_VER</entry>
117 </row>
118
119 <row>
120 <entry>GCC version</entry>
121
122 <entry>ELTF_T_GCC_VER</entry>
123 </row>
124
125 <row>
126 <entry>Linux Kernel Version</entry>
127
128 <entry>ELTF_T_KERN_VER</entry>
129 </row>
130
131 <row>
132 <entry>Supported Drivers</entry>
133
134 <entry>ELTF_T_DRIVERS</entry>
135 </row>
136
137 <row>
138 <entry>Enea rpm folder for downloading RPM packages for this
139 target</entry>
140
141 <entry><ulink
142 url="ELTF_T_EL_RPM_URL">ELTF_T_EL_RPM_TXTURL</ulink></entry>
143 </row>
144 </tbody>
145 </tgroup>
146 </informaltable></para>
147 </section>
148
149 <!-- ELTFADD_MORE_TARGET_SECTIONS_BELOW_IF_NEEDED -->
150 </section>
151</section> \ No newline at end of file
diff --git a/doc/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 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<section id="eltf_created_params">
5 <title>File with Parameters in the Book Auto-updated by ELFT</title>
6
7 <note>
8 <para>See the <emphasis
9 role="bold">eltf_params_updated_template_howto_use.txt</emphasis> text
10 file for description of how to create the final <emphasis
11 role="bold">eltf_params_updated.xml</emphasis> from this template and for
12 all <emphasis role="bold">REQUIREMENTS</emphasis>. Use the command
13 "<emphasis role="bold">make eltf</emphasis>" to extract a full list of all
14 ELTF variables, which always begins with ELTF_ and don't only rely on the
15 howto text file list! The plan is that ELTF will auto-update this when
16 needed.</para>
17 </note>
18
19 <section id="host_prereq">
20 <title>Common Parameters</title>
21
22 <bridgehead>A programlisting, ID
23 "eltf-prereq-apt-get-commands-host"</bridgehead>
24
25 <para id="eltf-prereq-apt-get-commands-host"><programlisting># Host Ubuntu 14.04.5 LTS 64bit
26sudo apt-get -y update
27sudo apt-get -y install sed wget subversion git-core coreutils unzip texi2html \
28 texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \
29 make gcc build-essential xsltproc g++ desktop-file-utils chrpath \
30 libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \
31 libxml-parser-perl</programlisting></para>
32
33 <bridgehead>A programlisting, ID
34 "eltf-getting-repo-install-command"</bridgehead>
35
36 <para id="eltf-getting-repo-install-command"><programlisting>mkdir -p ~/bin
37curl https://storage.googleapis.com/git-repo-downloads/repo &gt; ~/bin/repo
38chmod a+x ~/bin/repo
39export PATH=~/bin:$PATH</programlisting></para>
40
41 <bridgehead>Several phrase elements, various IDs. Ensure EL_REL_VER is
42 correct also compared to the "previous" REL VER in pardoc-distro.xml
43 "prev_baseline".</bridgehead>
44
45 <para id="EneaLinux_REL_VER"><phrase>6</phrase></para>
46
47 <para id="Yocto_VER"><phrase>2.1</phrase></para>
48
49 <para id="Yocto_NAME"><phrase>krogoth</phrase></para>
50
51 <para id="ULINK_YOCTO_PROJECT_DOWNLOAD"><ulink
52 url="http://www.yoctoproject.org/downloads/core/krogoth/21">http://www.yoctoproject.org/downloads/core/krogoth/21</ulink></para>
53
54 <para id="ULINK_ENEA_LINUX_URL"><ulink
55 url="https://linux.enea.com/6">https://linux.enea.com/6</ulink></para>
56
57 <bridgehead>A programlisting, ID "eltf-repo-cloning-enea-linux". Use
58 $MACHINE/default.xml as parameter, where MACHINE is one of the target
59 directory names in the manifest.</bridgehead>
60
61 <para id="eltf-repo-cloning-enea-linux"><programlisting>mkdir enea-linux
62cd enea-linux
63repo init -u git://git.enea.com/linux/el_manifests-networking.git \
64 -b refs/tags/EL6 -m $MACHINE/default.xml
65repo sync</programlisting></para>
66
67 <bridgehead>A table with ONE row, only the row with ID
68 "eltf-eclipse-version-row" is included in the book. MANUALLY in book, set
69 condition hidden if eclipse is not in the release. Do this both in
70 template.xml and updated.xml.</bridgehead>
71
72 <informaltable>
73 <tgroup cols="1">
74 <tbody>
75 <row condition="hidden" id="eltf-eclipse-version-row">
76 <entry>Eclipse version 4.3 (Mars) plus command line development
77 tools are included in this Enea Linux release.</entry>
78 </row>
79 </tbody>
80 </tgroup>
81 </informaltable>
82
83 <bridgehead>Below is one big section with title "Supported Targets with
84 Parameters". The entire section is included completely in the book via ID
85 "eltf-target-tables-section" and shall be LAST in the template. The
86 template contains ONE target subsection. COPY/APPEND it, if multiple
87 targets exist in the release and optionally add rows with additional
88 target parameters in each target subsection table.</bridgehead>
89 </section>
90
91 <section id="eltf-target-tables-section">
92 <title>Supported Targets with Parameters</title>
93
94 <para>The tables below describes the target(s) supported in this Enea
95 Linux release.</para>
96
97 <section id="eltf-target-table-p2041rdb">
98 <title>MACHINE p2041rdb - Information</title>
99
100 <para><informaltable>
101 <tgroup cols="2">
102 <colspec colwidth="6*" />
103
104 <colspec colwidth="9*" />
105
106 <tbody>
107 <row>
108 <entry>Target official name</entry>
109
110 <entry>P2041RDB</entry>
111 </row>
112
113 <row>
114 <entry>Architecture and Description</entry>
115
116 <entry>Power, e500mc</entry>
117 </row>
118
119 <row>
120 <entry>Link to target datasheet</entry>
121
122 <entry>See <ulink
123 url="http://www.nxp.com/products/microcontrollers-and-processors/power-architecture-processors/qoriq-power-architecture-processors/p2041-qoriq-reference-design-board:RDP2041BOARD">link
124 to NXP's datasheet</ulink></entry>
125 </row>
126
127 <row>
128 <entry>Poky version</entry>
129
130 <entry>Git-commit-id:
131 75ca53211488a3e268037a44ee2a7ac5c7181bd2</entry>
132 </row>
133
134 <row>
135 <entry>GCC version</entry>
136
137 <entry>5.3</entry>
138 </row>
139
140 <row>
141 <entry>Linux Kernel Version</entry>
142
143 <entry>3.12</entry>
144 </row>
145
146 <row>
147 <entry>Supported Drivers</entry>
148
149 <entry>Ethernet, I2C, SPI, PCI Express, USB, Flash,
150 SD/SDHC/SDXC, RTC</entry>
151 </row>
152
153 <row>
154 <entry>Enea rpm folder for downloading RPM packages for this
155 target</entry>
156
157 <entry><ulink
158 url="https://linux.enea.com/6/p2041rgb/rpm">https://linux.enea.com/6/p2041rgb/rpm</ulink></entry>
159 </row>
160 </tbody>
161 </tgroup>
162 </informaltable></para>
163 </section>
164 </section>
165</section> \ 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 @@
1eltf_params_template_updated_howto_use.txt
2
3This is a way to collect all parameters for an Enea Linux release
4in one parameter file, easy to automatically update by ELTF regularly.
5
6NOTE: Both the release info AND the open source books use parameters from
7 here, but the XML file is inside the release info book directory.
8
9NOTE: The manifest_conf.mk, or overridden by the environment variable
10 MANIFESTHASH, contains the full tag (or hashvalue) for downloading
11 the manifest when the books are built. The list of target
12 directories are fetched from the manifest into the book.
13 The eltf_params_updates.xml can all the time contain
14 the final next complete tag e.g. refs/tags/EL6 or similar
15 in the ELTF_PL_CLONE_W_REPO parameter command lines.
16
17The ordinary book XML files use xi:include statements to include elements
18from this parameter file. The book XML files can thus be manually edited.
19Before editing, you must run "make init".
20Any other text in the template or updated.xml file, outside the parts that
21are included in the book, are not used but still all must be correct
22DocBook XML files.
23
24ELTF work:
25 template => ELTF replaces ALL ELTF_xxx variables => updated XML file
26 => push to git only if changed
27
28
29eltf_params_template.xml (in git)
30 File used by ELTF to autocreate/update the real parameter
31 file eltf_params_updated.xml.
32
33eltf_params_updated.xml (in git)
34 Real parameter file where ELTF has replaced all ELTF_xx variables with
35 strings, in several cases with multiline strings.
36 No spaces or linefeed allowed in beginning or end of the variable values!
37
38
39xi:include: Each parameter is xi:include'ed in various book files, using
40 the IDs existing in the parameter files.
41 In most cases the 1:st element inside an element with an ID is included
42 using a format like eltf-prereq-apt-get-commands-host/1.
43 In very few cases the element with the ID is included in the book, one
44 example is the target section which has an ID, but which contains
45 multiple subsections, one per target.
46 All IDs in a book must be unique.
47
48DocBook XML: All XML files must be correct DocBook XML files.
49
50Do NOT edit/save the real *updated.xml file with XMLmind to avoid changes
51 not done by ELTF. But it is OK to open the real file in XMLmind to
52 check that the format is correct.
53
54ELTF should autocreate a temporary "real" file but only replace
55 and push the eltf_params_updated.xml if it is changed.
56
57
58make eltf
59 This lists all ELTF_xxx variables and some rules how to treat them
60
61DocBook Format: All elements - rules:
62 Several strict generic XML rules apply for all strings:
63 1. No TABs allowed or any other control chr than "linefeed"
64 2. Only 7-bit ASCII
65 3. Any < > & must be converted to &lt; &gt; and &amp;
66 Similar for any other non-7-bit-ASCII but avoid those!
67 4. No leading spaces or linefeeds when replacing the ELTF_* variable
68 5. No trailing spaces or linefeeds when replacing the ELTF_* variable
69 6. Note: Keep existing spaces before/efter ELTF_* in a few cases.
70
71DocBook Format: <programlisting> - rules: ELTF*PL* variables
72 Several strict rules apply for the multiline string in programlisting
73 in addition to the general XML rules above:
74 7. Max line length < 80 char
75 8. Use backslash (\) to break longer lines
76 9. Use spaces (e.g. 4) to indent continuation lines in programlistings
77 10. No trailing spaces on any line
78 11. No spaces or linefeed immediately after leading <programlisting>
79 12. No spaces or linefeed before trailing </programlisting>
80
81DocBook Format: <ulink> - rules: ELTF_*URL* variables
82 13. ELTF_*URL and corresponding ELTF_*TXTURL shall be identical strings
83 14. Only if the URL is extremely long, the TXTURL can be a separate string
84
85Each target has one section with target parameters:
86 <section id="eltf-target-table-ELTF_T_MANIFEST_DIR">
87 <title>MACHINE ELTF_T_MANIFEST_DIR - Information</title>
88 ..... with many ELTF_ variables ....
89 </section>
90
91 15. If there is only one target. ELTF just replaces ELTF parameters
92
93 16. It there are multiple targets. ELTF copies the section and appends the
94 section the required number of times.
95 Each section ID will become unique: eltf-target-table-ELTF_T_MANIFEST_DIR
96 Each section title will become unique
97
98Tables with target parameters in each target section:
99 17. It is possible for ELTF to append more rows with one parameter each
100 to these tables, because the entire tables are included in the book
101
102Special - NOT YET READY DEFINED how to handle the optionally included
103 Eclipse and its version, but this is a first suggestion:
104 18. Just now ELTF can define ELFT_ECLIPSE_VERSION as a full string
105 with both version number and name,
106 19. MANUALLY if Eclipse is NOT included in the release,
107 the release manager should manually set condition="hidden" on
108 the entire section in the book XML about Eclipse
109
110
111
112BELOW WE TRY TO EXPLAIN EACH ELTF_* variable, but always check with make eltf
113if there are more new variables, missing in this description file.
114
115_____________________________________________________________________________
116ELTF_PL_HOST_PREREQ Multiline list of host prerequisites, e.g. commands
117 like sudo apt-get install xxxx or similar.
118 First line = comment with the complete host name!
119 It is possible to include multiple hosts by just
120 adding an empty line, comment with host name, etc.
121 xi:include eltf-prereq-apt-get-commands-host/1
122 This is a <programlisting>...</programlisting>
123 Example:
124# Host Ubuntu 14.04.5 LTS 64bit
125sudo apt-get update
126sudo apt-get install sed wget subversion git-core coreutils unzip texi2html \
127 texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \
128 make gcc build-essential xsltproc g++ desktop-file-utils chrpath \
129 libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \
130 libxml-parser-perl
131
132_____________________________________________________________________________
133ELTF_PL_GET_REPO Multiline commands to download the repo tool
134 xi:include eltf-getting-repo-install-command/1
135 This is a <programlisting>...</programlisting>
136 Example:
137mkdir -p ~/bin
138curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
139chmod a+x ~/bin/repo
140export PATH=~/bin:$PATH
141
142_____________________________________________________________________________
143ELTF_EL_REL_VER General parameter string: The version of this Enea
144 Linux release. Major version and optional .Minor
145 Typically created from MAJOR and MINOR in enea.conf
146 MINOR in enea.conf is empty or contains a dot+minor
147 xi_include EneaLinux_REL_VER/1
148 This is a <phrase>X.x</phrase> used in many places.
149 Examples:
1506
151 or
1526.1
153
154_____________________________________________________________________________
155ELTF_YOCTO_VER General parameter string: Yocto version, created
156 from DISTRO in poky.ent
157 xi:include Yocto_VER/1
158 This is a <phrase>X.x</phrase> used in many places.
159 Example:
1602.1
161
162_____________________________________________________________________________
163ELTF_YOCTO_NAME General parameter string: Yocto name (branch), created
164 from DISTRO_NAME_NO_CAP in poky.ent
165 xi:include Yocto_NAME/1
166 This is a <phrase>X.x</phrase> used in many places.
167 Example:
168krogoth
169
170_____________________________________________________________________________
171ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL
172ELTF_YOCTO_PROJ_DOWNLOAD_URL strings with correct Yocto version string
173 at the end, typically without "dot".
174 xi:include ULINK_YOCTO_PROJECT_DOWNLOAD/1
175 This is an <ulink url="...">...</ulink>
176 Example:
177http://www.yoctoproject.org/downloads/core/krogoth/21
178
179_____________________________________________________________________________
180ELTF_EL_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL strings
181ELTF_EL_DOWNLOAD_URL and shall be the http:/..... address where
182 Enea Linux can be downloaded
183 Often containing same version as in ELTF_EL_REL_VER
184 xi:include ULINK_ENEA_LINUX_URL/1
185 This is an <ulink url="...">...</ulink>
186 Example:
187http://linux.enea.com/6
188
189_____________________________________________________________________________
190ELTF_PL_CLONE_W_REPO Multiline commands to run repo to clone everything.
191 Use the variable $MACHINE/default.xml (the text in
192 the book will list the avaiable values of MACHINE,
193 taken from the manifest repository)
194 xi:include eltf-repo-cloning-enea-linux/1
195 This is a <programlisting>...</programlisting>
196 Example:
197mkdir enea-linux
198cd enea-linux
199repo init -u git://git.enea.com/linux/el_manifests-standard.git \
200 -b refs/tags/EL6 -m $MACHINE/default.xml
201repo sync
202
203_____________________________________________________________________________
204ELTF_ECLIPSE_VERSION Optional general parameter string.
205 NOT YET READY DEFINED
206 Just now a release manage must manually set
207 condition="hidden" on the Eclipse section,
208 if Eclipse is not included in the release.
209 ELTF just replaces ELTF_ECLIPSE_VERSION with a full
210 string with "X.Y (name)"
211 It includes the ID and can only be ONCE in the book.
212 xi:include eltf-eclipse-version-row
213 Example.
2144.5 (Mars)
215
216
217_____________________________________________________________________________
218ELTF_T_* All these are in each target (MACHINE) and ELTF
219 must separately replace them with strings for
220 each target
221 NOTE: All (except the MANIFEST_DIR) are in rows
222 in a table and ELTF can select to append
223 more parameters by adding more rows
224
225_____________________________________________________________________________
226ELTF_T_MANIFEST_DIR This happens to be in two places. Must be exactly
227ELTF_T_MANIFEST_DIR the directory name in the manifest, e.g. same
228 as the MACHINE names in $MACHINE/default.xml.
229 In book: a) Part of section ID
230 b) Part of section title
231 Examples:
232p2041rgb
233 or
234ls1021aiot
235 or
236qemuarm
237
238_____________________________________________________________________________
239ELTF_T_NAME Target specific: "Target Official Name"
240 NOT same as the target directory name in most cases.
241 In book: An <entry> element in a row
242 Examples:
243P2041RGB
244 or
245LS1021a-IoT
246 or
247qemuarm
248
249_____________________________________________________________________________
250ELTF_T_ARC_DESC Target specific: "Architecture and Description"
251 It can be a short identification string or
252 it can be a longer descriptive sentence.
253 In book: An <entry> element in a row
254 Examples:
255Power, e500mc
256 or
257ARM Cortex-A7
258
259_____________________________________________________________________________
260ELTF_T_DS_TXTURL Target specific: "Link to target datasheet. These
261ELTF_T_DS_URL two usually are IDENTICAL strings with correct
262 hyperlink to the target's official datasheet.
263 In book: an <ulink url="...">...</ulink>
264 Only if the link is VERY LONG, the text part shall
265 instead be a descriptive string (see 2:nd example).
266 NOTE: Also here no spaces or line-feeds!
267 Examples:
268url="http://wiki.qemu.org">http://wiki.qemu.org
269or
270url="http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors/qoriq-ls1021a-iot-gateway-reference-design:LS1021A-IoT">link to NXP's datasheet
271
272_____________________________________________________________________________
273ELTF_T_POKY_VER Target specific: "Poky version" created either
274 from POKYVERSION in poky.ent
275 or using a hashvalue with a leading string, in
276 which case it may be different per target.
277 In book: An <entry> in a row
278 Examples:
27915.0.0
280or
281Git commit id: 75ca53211488a3e268037a44ee2a7ac5c7181bd2
282
283_____________________________________________________________________________
284ELTF_T_GCC_VER Target specific: "GCC Version". Should be in poky
285 but not easy to find among various parameters.
286 ELTF would extract it from build logs building SDK
287 and it is possibly different per target.
288 In book: An <entry> in a row
289 Example:
2905.3
291
292_____________________________________________________________________________
293ELTF_T_KERN_VER Target specific: "Linux Kernel Version". Often
294 different per target.
295 In book: An <entry> in a row
296 Example:
2973.12
298
299_____________________________________________________________________________
300ELTF_T_DRIVERS Target specific: "Supported Drivers". This is a
301 comma-separated list of driver names.
302 ELTF should create the list in same order for each
303 target, e.g. alphabetic migth be OK.
304 In book: An <entry> in a row
305 Example:
306Ethernet, I2C, SPI, PCI, USB, SD/SDHC/SDXC
307
308
309_____________________________________________________________________________
310ELTF_T_EL_RPM_TXTURL Target specific: "Enea rpm folder for downloading
311ELTF_T_EL_RPM_URL RPM packages for this target". These two are
312 INDENTICAL strings with hyperlink to the web site
313 at Enea where the customer can download RPMs
314 Note: Often the ELFT_EL_REL_VER value and
315 the ELTF_T_MANIFEST_DIR are used in the link.
316 In book: an <ulink url="...">...</ulink>
317 Example:
318url="https://linux.enea.com/6/ls1021aiot/rpm">https://linux.enea.com/6/ls1021aiot/rpm
319
320_____________________________________________________________________________
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 @@
33 <orderedlist> 33 <orderedlist>
34 <listitem> 34 <listitem>
35 <para>Make sure that the repo tool is installed. If not, follow the 35 <para>Make sure that the repo tool is installed. If not, follow the
36 instructions below:</para> 36 instructions below. The instruction assumes a suitable place in your
37 PATH to use. You might change that.<remark>INFO: Below is include of
38 ID "eltf-getting-repo-install-command" from
39 eltf_params_updated.xml</remark></para>
37 40
38 <para><programlisting>$ curl https://storage.googleapis.com/git-repo-downloads/repo &gt; ~/bin/repo 41 <xi:include href="eltf_params_updated.xml"
39$ chmod a+x ~/bin/repo</programlisting>The instruction assumes that ~/bin 42 xmlns:xi="http://www.w3.org/2001/XInclude"
40 exists and is included in the PATH variable.</para> 43 xpointer="element(eltf-getting-repo-install-command/1)" />
41 </listitem> 44 </listitem>
42 45
43 <listitem> 46 <listitem>
44 <para>Use the repo tool to download the source:<remark>FIXME: At final 47 <para>Use the repo tool to download the source: Please define MACHINE
45 release the tag for the manifest must be set in mainfest_conf.mk as 48 to your target, uncomment and use one of the MACHINE lines listed
46 MANIFESTHASH, typically something like refs/tags/EL6. Before final 49 here,<remark>Below is the "machine_list" programlisting in
47 release, it is possible to set MANIFESTHASH on the make command line 50 machine_list_generated.xml created by the make system by extracting
48 to override the value, e.g. with a commit hash string for a release 51 from the manifest</remark></para>
49 candidate to be tested</remark></para>
50 52
51 <programlisting>$ mkdir enea-linux 53 <xi:include href="machine_list_generated.xml"
52$ cd enea-linux 54 xmlns:xi="http://www.w3.org/2001/XInclude"
53$ repo init -u <xi:include href="../../s_docsrc_common/pardoc-distro.xml" 55 xpointer="element(machine-list/1)" />
54 xmlns:xi="http://www.w3.org/2001/XInclude"
55 xpointer="element(EneaLinux_MANIFESTURL/1)" /> \
56 -b <xi:include href="../../s_docsrc_common/pardoc-distro.xml"
57 xmlns:xi="http://www.w3.org/2001/XInclude"
58 xpointer="element(EneaLinux_MANIFESTHASH/1)" /> \
59 -m &lt;manifest file&gt;
60$ repo sync</programlisting>
61 56
62 <para>The parameter &lt;manifest file&gt; depends on the target. Use 57 <para>and use the repo command below:<remark> Below is include of ID
63 the following:</para> 58 "eltf-repo-cloning-enea-linux" from eltf_params_updated.xml. Here the
59 $MACHINE shall be given!</remark></para>
64 60
65 <xi:include element="manifestfiles/1" 61 <xi:include href="eltf_params_updated.xml"
66 href="manifestfiles_generated.xml" 62 xmlns:xi="http://www.w3.org/2001/XInclude"
67 xmlns:xi="http://www.w3.org/2001/XInclude" /> 63 xpointer="element(eltf-repo-cloning-enea-linux/1)" />
68 </listitem> 64 </listitem>
69 </orderedlist> 65 </orderedlist>
70 66
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 @@
6 6
7 <para>The open source projects are continuously working on correcting 7 <para>The open source projects are continuously working on correcting
8 reported problems. Corrections to bugs detected by Enea are submitted 8 reported problems. Corrections to bugs detected by Enea are submitted
9 upstream, and the corrections are included in Enea Linux regardless of 9 upstream, and the corrections are included in Enea Linux regardless of when
10 when they will be included by the open source project. Remaining issues are 10 they will be included by the open source project. Remaining issues are
11 listed below.</para> 11 listed below.<remark>INFO: The <emphasis role="bold">Release-Specific
12 Problems</emphasis> section further down is generated from JIRA with
13 gen_known_issues.py, but that script is HARDCODED with affectedversion "Enea
14 Linux 6" and needs to be adapted when a release info for another EL version
15 changes.</remark></para>
12 16
13 <section id="bugs-limitations-yocto"> 17 <section id="bugs-limitations-yocto">
14 <title>Yocto</title> 18 <title>Yocto</title>
15 19
16 <para>The Yocto Project community uses a Bugzilla database to track 20 <para>The Yocto Project community uses a Bugzilla database to track
17 information on reported bugs and other issues: 21 information on reported bugs and other issues: <ulink
18 <ulink url="https://bugzilla.yoctoproject.org"> 22 url="https://bugzilla.yoctoproject.org">
19 https://bugzilla.yoctoproject.org</ulink>.</para> 23 https://bugzilla.yoctoproject.org</ulink>.</para>
20 </section> 24 </section>
21 25
@@ -26,7 +30,9 @@
26 <listitem> 30 <listitem>
27 <para>Building the kernel might fail if GNU Make of version 3.82 has 31 <para>Building the kernel might fail if GNU Make of version 3.82 has
28 been installed on the host. The mandatory recovery action is to revert 32 been installed on the host. The mandatory recovery action is to revert
29 to version 3.81.</para> 33 to version 3.81.<remark>INFO It is possible to hide this entire
34 subsection by setting condition hidden on the section
35 element</remark></para>
30 </listitem> 36 </listitem>
31 37
32 <listitem> 38 <listitem>
@@ -43,7 +49,8 @@
43 <para>Installation of some packages might currently fail when installing 49 <para>Installation of some packages might currently fail when installing
44 using the Smart Package Manager. An example is the qemu package. Errors 50 using the Smart Package Manager. An example is the qemu package. Errors
45 can e.g. be reported by smart about conflicts with files from other 51 can e.g. be reported by smart about conflicts with files from other
46 packages.</para> 52 packages.<remark>INFO It is possible to hide this setting condition hidden
53 on the section element</remark></para>
47 54
48 <para>The recommended solution to this problem is to install the failing 55 <para>The recommended solution to this problem is to install the failing
49 package using rpm, already available in enea-image-base. In order to 56 package using rpm, already available in enea-image-base. In order to
@@ -63,7 +70,8 @@
63 <title>Example with Failing QEMU Package</title> 70 <title>Example with Failing QEMU Package</title>
64 71
65 <para>As an example, the qemu installation can show the following 72 <para>As an example, the qemu installation can show the following
66 error.</para> 73 error.<remark>INFO It is possible to hide this setting condition hidden
74 on the section element</remark></para>
67 75
68 <note> 76 <note>
69 <para>The example below is for ARM, including the RPM names. For 77 <para>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 @@
17 <itemizedlist spacing="compact"> 17 <itemizedlist spacing="compact">
18 <listitem> 18 <listitem>
19 <para>New Yocto version (<xi:include 19 <para>New Yocto version (<xi:include
20 href="../../s_docsrc_common/pardoc-distro.xml" 20 href="eltf_params_updated.xml"
21 xmlns:xi="http://www.w3.org/2001/XInclude" 21 xmlns:xi="http://www.w3.org/2001/XInclude"
22 xpointer="element(Yocto_VER/1)" />). See <ulink 22 xpointer="element(Yocto_VER/1)" />). See <ulink
23 url="https://www.yoctoproject.org/downloads/core/krogoth21">https://www.yoctoproject.org/downloads/core/krogoth21</ulink>.</para> 23 url="https://www.yoctoproject.org/downloads/core/krogoth21">https://www.yoctoproject.org/downloads/core/krogoth21</ulink>.</para>
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 @@
4<chapter id="prerequisites"> 4<chapter id="prerequisites">
5 <title>Prerequisites</title> 5 <title>Prerequisites</title>
6 6
7 <xi:include href="../../s_doceneacommon/doc/system_requirements.xml"
8 xmlns:xi="http://www.w3.org/2001/XInclude" />
9
10 <para>Building Enea Linux or compiling applications requires that your git 7 <para>Building Enea Linux or compiling applications requires that your git
11 environment be setup properly, and for certain packages to be installed on 8 environment be setup properly and for certain packages to be installed on
12 your Linux development host.</para> 9 your Linux development host.</para>
13 10
14 <para>Please refer to <ulink 11 <para>Please refer to <ulink
@@ -20,18 +17,18 @@
20 <programlisting>$ git config --global user.name "John Doe" 17 <programlisting>$ git config --global user.name "John Doe"
21$ git config --global user.email johndoe@example.com</programlisting> 18$ git config --global user.email johndoe@example.com</programlisting>
22 19
23 <section id="inst-host-packages-ubuntu-debian"> 20 <para>First ensure the system is up-to-date, then for the supported
24 <title>Ubuntu 14.04 LTS, 64-bit</title> 21 distribution(s), you need the following packages:<remark>INFO: The
22 programlisting below is a parameters in eltf_params_updated.xml with ID:
23 "eltf-prereq-apt-get-command-host". If multiple hosts are supported, store
24 the commands for each host in the same programlisting with empty lines
25 between each - the comment with the FULL HOST name and version is
26 essential.</remark></para>
25 27
26 <para>For the supported distribution(s) you need the following packages: 28 <xi:include href="eltf_params_updated.xml"
27 <remark>INFO: The programlisting below is a parameter in 29 xmlns:xi="http://www.w3.org/2001/XInclude"
28 eltf_params_updated.xml with ID: "eltf-prereq-apt-get-command-host". If 30 xpointer="element(eltf-prereq-apt-get-commands-host/1)" />
29 multiple hosts are supported, store the commands for each host in the same
30 programlisting with empty lines between each - the comment with the FULL
31 HOST name and version is essential.</remark></para>
32 31
33 <!-- <xi:include href="eltf_params_updated.xml" 32 <xi:include href="system_requirements.xml"
34 xmlns:xi="http://www.w3.org/2001/XInclude" 33 xmlns:xi="http://www.w3.org/2001/XInclude" />
35 xpointer="element(eltf-prereq-apt-get-commands-host/1)" /> -->
36 </section>
37</chapter> \ No newline at end of file 34</chapter> \ 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 @@
15 and the Yocto Project Reference Manual <ulink 15 and the Yocto Project Reference Manual <ulink
16 url="http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements"> 16 url="http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements">
17 http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements</ulink>. 17 http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements</ulink>.
18 If needed, replace the Yocto version in the links provided with a more 18 If needed, replace the Yocto version in the link(s) provided with a more
19 recent version.</para> 19 recent version.</para>
20 20
21 <informaltable> 21 <informaltable>
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 @@
1<?xml version="1.0" encoding="ISO-8859-1"?> 1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ 3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<!-- Version and name entities
5==============================
6-->
7<!-- Distribution and release -->
8<!ENTITY ENEA_LINUX_REL_VER "MAJOR.MINOR"> <!-- TEMPLATE LINE, IS PATCHED by Makefile with values from enea.conf in poky/ -->
9<!ENTITY % common_poky_entities SYSTEM "../s_targets/qemuarm/poky/documentation/poky.ent">
10%common_poky_entities;
11]>
12 4
13<!-- Declarations to inherit by xi:include 5<!-- Declarations to inherit by xi:include
14========================================== --> 6========================================== -->
@@ -23,21 +15,12 @@
23 must be included, not just parts of them.</para> 15 must be included, not just parts of them.</para>
24 16
25 <para>**** The phrase elements below can be used as variables in several 17 <para>**** The phrase elements below can be used as variables in several
26 places in XML files ****</para> 18 places in XML files and/or in make script files ****</para>
27
28 <para>You can add more elements using ENTITY lines in poky.ent, e.g. like Poky_VER below</para>
29 19
30<!-- Distribution and release --> 20<!-- Distribution and release -->
31<para id="EneaLinux_REL_VER"><phrase>&ENEA_LINUX_REL_VER;</phrase></para>
32<para id="ULINK_ENEA_LINUX_URL"><ulink url='https://linux.enea.com/&ENEA_LINUX_REL_VER;'>https://linux.enea.com/&ENEA_LINUX_REL_VER;</ulink></para>
33<para id="Poky_VER"><phrase>&POKYVERSION;</phrase></para>
34<para id="Yocto_VER"><phrase>&DISTRO;</phrase></para>
35<para id="Yocto_NAME"><phrase>&DISTRO_NAME_NO_CAP;</phrase></para>
36<para id="ULINK_YOCTO_RELEASE_NOTES"><ulink url='&YOCTO_RELEASE_NOTES;'>&YOCTO_RELEASE_NOTES;</ulink></para>
37
38<!-- 21<!--
39 The parameter 'prev_baseline' is intentionally undefined here since this 22 The parameter 'prev_baseline' is intentionally undefined here since this
40 is the first release of the networking profile. 23 is the first release of the networking profile. The line must be removed.
41--> 24-->
42<para id="prev_lic_file"><phrase>doc/book-enea-linux-open-source/doc/licenses.xml</phrase></para> 25<para id="prev_lic_file"><phrase>doc/book-enea-linux-open-source/doc/licenses.xml</phrase></para>
43<para id="new_lic_file"><phrase>doc/book-enea-linux-open-source/doc/licenses.xml</phrase></para> 26<para id="new_lic_file"><phrase>doc/book-enea-linux-open-source/doc/licenses.xml</phrase></para>
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 @@
1#!/bin/sh 1#!/bin/sh
2VER="R0.06" 2VER="R0.07"
3# R0.07/lejo 2017-01-20 Add -readmebasedir to the README files from the manifest instead of s_targets
3 4
4BBTEMPLATE= 5BBTEMPLATE=
5BBXML= 6BBXML=
7BB_TARGETREADME_BASE=
6 8
7USAGE="`basename $0` -xml buildbootxml-to-create -template templatexml-file ($VER) 9USAGE="`basename $0` -xml buildbootxml-to-create -template templatexml-file -readmebasedir targetreadmebase ($VER)
8 Currently only supports sequence types Build-command: and Boot-command: 10 Currently only supports sequence types Build-command: and Boot-command:
9 Both files should have path book-*release-info/doc/ 11 Both files should have path book-*release-info/doc/
10 Creates the XML file from the template, inserting build/boot commands 12 Creates the XML file from the template, inserting build/boot commands
11 from the various s_targets/XXXtargetXXX/README files 13 from the various s_manifests/el_manifest-XXX/XXXtargetXXX/README files
12 at the place in template with >SCRIPT_INCLUDES_BUILD_BOOT_SECTIONS_HERE< 14 at the place in template with >SCRIPT_INCLUDES_BUILD_BOOT_SECTIONS_HERE<
13 ignoring rest of template 15 ignoring rest of template
14 The code tries to fold too long lines, but this is not perfect. Best would 16 The code tries to fold too long lines, but this is not perfect. Best would
@@ -21,14 +23,16 @@ do
21 if [ "$OPT" = "--help" -o "$OPT" = "-h" -o "$OPT" = "-help" ] ; then echo "$USAGE" ; exit ; fi 23 if [ "$OPT" = "--help" -o "$OPT" = "-h" -o "$OPT" = "-help" ] ; then echo "$USAGE" ; exit ; fi
22 if [ "$OPT" = "-xml" ] ; then BBXML="$1" ; shift; fi 24 if [ "$OPT" = "-xml" ] ; then BBXML="$1" ; shift; fi
23 if [ "$OPT" = "-template" ] ; then BBTEMPLATE="$1" ; shift; fi 25 if [ "$OPT" = "-template" ] ; then BBTEMPLATE="$1" ; shift; fi
26 if [ "$OPT" = "-readmebasedir" ] ; then BB_TARGETREADME_BASE="$1" ; shift; fi
24done 27done
25if [ "$BBTEMPLATE" = "" ]; then echo "ERROR: Missing option -template templatefile"; exit ; fi 28if [ "$BBTEMPLATE" = "" ]; then echo "ERROR: Missing option -template templatefile"; exit ; fi
26if [ "$BBXML" = "" ]; then echo "ERROR: Missing option -xml buildbootxml-to-create"; exit ; fi 29if [ "$BBXML" = "" ]; then echo "ERROR: Missing option -xml buildbootxml-to-create"; exit ; fi
27if [ ! -f "$BBTEMPLATE" ]; then echo "ERROR: Missing templatefile '$BBTEMPLATE'"; exit; fi 30if [ ! -f "$BBTEMPLATE" ]; then echo "ERROR: Missing templatefile '$BBTEMPLATE'"; exit; fi
28if [ ! -d "`dirname \"$BBXML\"`" ]; then echo "ERROR: Missing parent directory for '$BBXML'"; exit ; fi 31if [ ! -d "`dirname \"$BBXML\"`" ]; then echo "ERROR: Missing parent directory for '$BBXML'"; exit ; fi
32if [ ! -d "$BB_TARGETREADME_BASE" ]; then echo "ERROR: Missing basedir for README files '$BB_TARGETREADME_BASE'"; exit; fi
29 33
30echo "`basename $0` Creating $BBXML from" 34echo "`basename $0` Creating $BBXML from"
31TARGETREADMES=`cd s_targets ; ls -d */README | tr '\n' ' '` 35TARGETREADMES=`cd $BB_TARGETREADME_BASE ; ls -d */README | tr '\n' ' '`
32echo " $TARGETREADMES" 36echo " $TARGETREADMES"
33 37
34# README file formats: 38# README file formats:
@@ -77,7 +81,7 @@ extractcmds_filter() {
77} 81}
78 82
79extractcmds_for_type() { # target/README BOOTorBUILD 83extractcmds_for_type() { # target/README BOOTorBUILD
80 README=s_targets/"$1" 84 README=$BB_TARGETREADME_BASE/"$1"
81 CMDTYPE="$2" 85 CMDTYPE="$2"
82 COMMANDSFOR=`egrep "___$CMDTYPE:" $README` 86 COMMANDSFOR=`egrep "___$CMDTYPE:" $README`
83 for CMDS in $COMMANDSFOR 87 for CMDS in $COMMANDSFOR