diff options
author | Lennart Johansson <lennart.johansson@enea.com> | 2016-06-02 13:41:04 +0200 |
---|---|---|
committer | Lennart Johansson <lennart.johansson@enea.com> | 2016-06-02 13:41:04 +0200 |
commit | 70919fc0a582f58aeac67863f5e0f5c232613f72 (patch) | |
tree | 6ca479c08be2d3449d361418f94dc83c83deb7d1 /doc | |
parent | 236463c519085d87a3096d6171f3e92d9b68db00 (diff) | |
download | el_manifests-standard-70919fc0a582f58aeac67863f5e0f5c232613f72.tar.gz |
Doc Add autovariables from manifest, poky.ent, enea.conf
Add autovariable from manifest repository name,
e.g. the profile name
Add autovariables from poky.ent, e.g. Yocto version etc..
in pardoc-distro
Add autovariables from enea.conf e.g. release MAJOR MINOR
via generated s_docsrc_common/pardoc-distro
and also pick up MAJOR MINOR into the
make system to create BOOK_VER => BL_LABEL on books
Add autocreate build_boot chapter in release info
from the README files in all included targets
Adapt book XML files to the above
Currently this makes the Makefile and init scripts identical
in different el6-<profile>.git
All are now automatic: Just clone el6-xxxx.git and
cd el6-xxx/doc ; make doc
and all are done until the books are built and ready.
It takes several minutes to autofetch all from git
using the repo command according to the target manifests
before the books start to build.
Rebuilding books are quick.
Signed-off-by: Lennart Johansson <lennart.johansson@enea.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile | 60 | ||||
-rw-r--r-- | doc/book-enea-linux-eclipse-open-source/doc/book.xml | 2 | ||||
-rw-r--r-- | doc/book-enea-linux-open-source/doc/about.xml | 2 | ||||
-rw-r--r-- | doc/book-enea-linux-release-info/doc/about_release.xml | 6 | ||||
-rw-r--r-- | doc/book-enea-linux-release-info/doc/book.xml | 1 | ||||
-rw-r--r-- | doc/book-enea-linux-release-info/doc/build_boot_template.xml | 26 | ||||
-rw-r--r-- | doc/book-enea-linux-release-info/doc/supported_features.xml | 2 | ||||
-rw-r--r-- | doc/book-enea-linux-release-info/doc/targetscontain.xml | 8 | ||||
-rw-r--r-- | doc/book-enea-linux-release-info/doc/targetscontain_template.xml | 7 | ||||
-rw-r--r-- | doc/initbuildboot.sh | 111 |
10 files changed, 197 insertions, 28 deletions
diff --git a/doc/Makefile b/doc/Makefile index 7fd9b52..59d25d5 100644 --- a/doc/Makefile +++ b/doc/Makefile | |||
@@ -20,8 +20,10 @@ TARGETDEFAULTXMLS := $(shell cd $(REPODIR); ls -1 */default.xml) | |||
20 | # URL and HASH of this manifest repository to be used by the repo tool | 20 | # URL and HASH of this manifest repository to be used by the repo tool |
21 | CURRENTHASH := $(shell git log -1 --pretty=format:%H 2>/dev/null) | 21 | CURRENTHASH := $(shell git log -1 --pretty=format:%H 2>/dev/null) |
22 | CURRENTURL := $(shell git remote show origin | sed -n '/Fetch URL: /s/^.*URL: //p' 2>/dev/null) | 22 | CURRENTURL := $(shell git remote show origin | sed -n '/Fetch URL: /s/^.*URL: //p' 2>/dev/null) |
23 | .PHONY: inittargets | 23 | |
24 | # ****************************************************************** | 24 | # ******************* AutoGenerated chapter from template and target READMEs ******* |
25 | BUILDBOOT_XML := book-enea-linux-release-info/doc/build_boot_generated.xml | ||
26 | BUILDBOOT_TEMPLATE := book-enea-linux-release-info/doc/build_boot_template.xml | ||
25 | 27 | ||
26 | 28 | ||
27 | 29 | ||
@@ -38,11 +40,10 @@ DOCBOOK_FO_USEFOP ?= yes | |||
38 | DOCBOOK_TO_BOOKDIR ?= yes | 40 | DOCBOOK_TO_BOOKDIR ?= yes |
39 | DOCBOOK_CLEANTMP ?= yes | 41 | DOCBOOK_CLEANTMP ?= yes |
40 | 42 | ||
41 | #Components in this subsystem | 43 | #Components (books) in this subsystem |
42 | COMPONENTS := book-enea-linux-release-info book-enea-linux-open-source | 44 | # COMPONENTS := book-enea-linux-release-info book-enea-linux-open-source |
43 | # COMPONENTS += book-enea-linux-eclipse-open-source | 45 | # COMPONENTS += book-enea-linux-eclipse-open-source |
44 | # COMPONENTS += book-enea-linux-target-guide | 46 | COMPONENTS := $(shell ls -d book-enea* ) |
45 | |||
46 | 47 | ||
47 | # -------------------------------------------------------------- | 48 | # -------------------------------------------------------------- |
48 | ifeq ($(VERBOSE),yes) | 49 | ifeq ($(VERBOSE),yes) |
@@ -65,24 +66,23 @@ VALIDATE = no | |||
65 | # Export all parameters including those on the command line | 66 | # Export all parameters including those on the command line |
66 | export | 67 | export |
67 | 68 | ||
68 | .PHONY: doc books docusage | 69 | .PHONY: doc books docusage init initbuild inittargets initpardoc initbuildboot |
69 | 70 | ||
70 | 71 | ||
71 | docusage: | 72 | docusage: |
72 | @echo 'make docusage #Shows this help text' | 73 | @echo 'make docusage #Shows this help text' |
73 | @echo ' DOCBOOK_TOOLS_VERSIONS=yes #Displays DocBook tools versions in this machine' | 74 | @echo ' DOCBOOK_TOOLS_VERSIONS=yes #Displays DocBook tools versions in this machine' |
74 | @echo 'make doc #Builds the userdoc, does autoinit if needed' | 75 | @echo 'make doc #Builds the userdoc, does autoinit if needed' |
75 | @echo 'make init #Init all needed s_* below' | 76 | @echo 'make init #Init all needed init* below' |
76 | @echo 'make initbuild #Init s_docbuild Docbook build system and central files' | 77 | @echo 'make initbuild #Init s_docbuild Docbook build system and central files' |
77 | @echo 'make inittargets #Init s_targets using repo tool Targets in this distro with poky' | 78 | @echo 'make inittargets #Init s_targets using repo tool Targets in this distro with poky' |
78 | @echo 'make initpardoc #Init s_docsrc_common using info from poky/' | 79 | @echo 'make initpardoc #Init s_docsrc_common using info from poky/' |
80 | @echo 'make initbuildboot #Init build_boot chapter from READMEs and template in release info' | ||
79 | @echo ' DOCBOOK_CLEANTMP=no #Option to keep temp files in doc/ and tmp/' | 81 | @echo ' DOCBOOK_CLEANTMP=no #Option to keep temp files in doc/ and tmp/' |
80 | @echo ' BOOK_GLOBALCLONEROOT=yes #Option for all init above to clone all outside the doc directory' | 82 | @echo ' BOOK_GLOBALCLONEROOT=yes #Option for all init above to clone all outside the doc directory' |
81 | @echo ' BOOK_GLOBALCLONEROOT=otherpath #Option for all init above to clone all' | 83 | @echo ' BOOK_GLOBALCLONEROOT=otherpath #Option for all init above to clone all' |
82 | @echo #Force rebuilding (ignore dependency on file times or BL_LABEL)' | ||
83 | @echo ' # Dependency only works if common doc directory is kept' | ||
84 | @echo 'make pullbuild #git pull in s_docbuild' | 84 | @echo 'make pullbuild #git pull in s_docbuild' |
85 | @echo 'make pulltargets #git pull in s_targets' | 85 | @echo 'make pulltargets #git pull in s_targets. You need also initpardoc initbuildboot' |
86 | @echo 'make clean #Clean. Also clean s_* but not any external clones' | 86 | @echo 'make clean #Clean. Also clean s_* but not any external clones' |
87 | @echo '' | 87 | @echo '' |
88 | @echo 'Optional parameters for make doc:' | 88 | @echo 'Optional parameters for make doc:' |
@@ -105,7 +105,7 @@ docusage: | |||
105 | @echo ' DOCBOOK_OLINK_TARGETDB=only #Build a target db for this book (for links into it)' | 105 | @echo ' DOCBOOK_OLINK_TARGETDB=only #Build a target db for this book (for links into it)' |
106 | @echo ' DOCBOOK_OLINK_TARGETDB=yes #Build a target db AND build the book' | 106 | @echo ' DOCBOOK_OLINK_TARGETDB=yes #Build a target db AND build the book' |
107 | @echo ' #Master olinkdb defined in this Makefile, one per generated format, is:' | 107 | @echo ' #Master olinkdb defined in this Makefile, one per generated format, is:' |
108 | @echo ' $(DOCBOOKOLINKDB_BASE)_*.db' | 108 | @echo ' $(DOCBOOKOLINKDB_BASE)_*.db' |
109 | @echo ' Typical examples:' | 109 | @echo ' Typical examples:' |
110 | @echo ' make doc Creates all books, all formats' | 110 | @echo ' make doc Creates all books, all formats' |
111 | @echo ' make doc COMP=book-xxxx FORMAT=html' | 111 | @echo ' make doc COMP=book-xxxx FORMAT=html' |
@@ -124,7 +124,8 @@ ifeq ($(DOCBOOK_TOOLS_VERSIONS),yes) | |||
124 | $(VERB)$(MAKE) -f $(DOCBOOKMAKE)/tools_book_standalone.mk book_tools_versions | 124 | $(VERB)$(MAKE) -f $(DOCBOOKMAKE)/tools_book_standalone.mk book_tools_versions |
125 | endif | 125 | endif |
126 | 126 | ||
127 | init: initbuild inittargets initpardoc | 127 | # We rely on make doing these in order left to right |
128 | init: initbuild inittargets initpardoc initbuildboot | ||
128 | pullall: pullbuild pulltargets | 129 | pullall: pullbuild pulltargets |
129 | 130 | ||
130 | # If no COMP, iterate over books-* in COMPONENTS with make doc | 131 | # If no COMP, iterate over books-* in COMPONENTS with make doc |
@@ -150,7 +151,7 @@ FORMAT=html pdf eclipse | |||
150 | endif | 151 | endif |
151 | 152 | ||
152 | 153 | ||
153 | books: initbuild inittargets initpardoc | 154 | books: init |
154 | # BOOKPACKAGES is defined in all book-*/swcomp.mk | 155 | # BOOKPACKAGES is defined in all book-*/swcomp.mk |
155 | $(VERB)DISTRO_VERSION_MAJOR=`egrep '"EneaLinux_DISTRO_VERSION_MAJOR"' s_docsrc_common/pardoc-distro.xml | sed 's/.*<phrase>//;s/<\/phrase>.*//'` ; \ | 156 | $(VERB)DISTRO_VERSION_MAJOR=`egrep '"EneaLinux_DISTRO_VERSION_MAJOR"' s_docsrc_common/pardoc-distro.xml | sed 's/.*<phrase>//;s/<\/phrase>.*//'` ; \ |
156 | DISTRO_VERSION_MINOR=`egrep '"EneaLinux_DISTRO_VERSION_MINOR"' s_docsrc_common/pardoc-distro.xml | sed 's/.*<phrase>//;s/<\/phrase>.*//'` ; \ | 157 | DISTRO_VERSION_MINOR=`egrep '"EneaLinux_DISTRO_VERSION_MINOR"' s_docsrc_common/pardoc-distro.xml | sed 's/.*<phrase>//;s/<\/phrase>.*//'` ; \ |
@@ -169,8 +170,8 @@ ifeq ($(DOCBOOK_CLEANTMP),yes) | |||
169 | endif | 170 | endif |
170 | endif | 171 | endif |
171 | 172 | ||
172 | # cleaninit cleans ALL tmpcommon and all s_* | 173 | # cleaninit cleans ALL tmpcommon and all s_* and generated build_boot chapter xml |
173 | clean: cleaninit | 174 | clean: cleaninit cleanbuildboot |
174 | $(VERB)rm -rf doc tmp 2>/dev/null | 175 | $(VERB)rm -rf doc tmp 2>/dev/null |
175 | ifneq ($(filter book-%, $(COMPONENTS)),) | 176 | ifneq ($(filter book-%, $(COMPONENTS)),) |
176 | $(VERB)for comp in $(filter book-%, $(COMPONENTS)); do \ | 177 | $(VERB)for comp in $(filter book-%, $(COMPONENTS)); do \ |
@@ -214,12 +215,12 @@ $(TMPCLONEROOT_TARGETS): | |||
214 | 215 | ||
215 | # **************************************************************************** | 216 | # **************************************************************************** |
216 | # ******************** SUPPORT FOR dynamic pardoc with added parameters ****** | 217 | # ******************** SUPPORT FOR dynamic pardoc with added parameters ****** |
218 | # pardoc-distro can contain MAJOR.MINOR-xxxxx keeping -xxxx when replacing MINOR.MINOR from enea.conf | ||
217 | 219 | ||
218 | PATH_DOCSRC_COMMON = $(SUBSYSROOT)/s_docsrc_common | 220 | PATH_DOCSRC_COMMON = $(SUBSYSROOT)/s_docsrc_common |
219 | NAME_DOCSRC_COMMON = docsrc_common | 221 | NAME_DOCSRC_COMMON = docsrc_common |
220 | TMPCLONEROOT_DOCSRC_COMMON := $(TMPCLONEROOT)/$(NAME_DOCSRC_COMMON) | 222 | TMPCLONEROOT_DOCSRC_COMMON := $(TMPCLONEROOT)/$(NAME_DOCSRC_COMMON) |
221 | TMPPARDOC := $(TMPCLONEROOT_DOCSRC_COMMON)/pardoc-distro.xml | 223 | TMPPARDOC := $(TMPCLONEROOT_DOCSRC_COMMON)/pardoc-distro.xml |
222 | .PHONY: initpardoc | ||
223 | 224 | ||
224 | initpardoc: s_docsrc_common | 225 | initpardoc: s_docsrc_common |
225 | 226 | ||
@@ -233,14 +234,33 @@ $(TMPCLONEROOT_DOCSRC_COMMON): s_targets | |||
233 | $(VERB)if [ ! -d "$(TMPCLONEROOT)" ] ; then mkdir -p "$(TMPCLONEROOT)" ; fi | 234 | $(VERB)if [ ! -d "$(TMPCLONEROOT)" ] ; then mkdir -p "$(TMPCLONEROOT)" ; fi |
234 | $(VERB)if [ ! -d $(TMPCLONEROOT_DOCSRC_COMMON) ]; then mkdir -p $(TMPCLONEROOT_DOCSRC_COMMON) ; fi | 235 | $(VERB)if [ ! -d $(TMPCLONEROOT_DOCSRC_COMMON) ]; then mkdir -p $(TMPCLONEROOT_DOCSRC_COMMON) ; fi |
235 | @echo "Copy and patch docsrc_common/ files to $(TMPCLONEROOT_DOCSRC_COMMON)" | 236 | @echo "Copy and patch docsrc_common/ files to $(TMPCLONEROOT_DOCSRC_COMMON)" |
236 | $(VERB)FIRSTTARGET=`ls -1 s_targets/ | head -1`; echo "FIRSTTARGET is $$FIRSTTARGET" ; \ | 237 | $(VERB)FIRSTTARGET=`ls -1 s_targets/ | head -1`; \ |
237 | ENEACONF=s_targets/$$FIRSTTARGET/poky/meta-el-common/conf/distro/enea.conf ; \ | 238 | ENEACONF=s_targets/$$FIRSTTARGET/poky/meta-el-common/conf/distro/enea.conf ; \ |
238 | DISTRO_VERSION_MAJOR=`egrep '^DISTRO_VERSION_MAJOR' $$ENEACONF | sed 's/^[^"]*"//;s/".*//'` ; \ | 239 | DISTRO_VERSION_MAJOR=`egrep '^DISTRO_VERSION_MAJOR' $$ENEACONF | sed 's/^[^"]*"//;s/".*//'` ; \ |
239 | DISTRO_VERSION_MINOR=`egrep '^DISTRO_VERSION_MINOR' $$ENEACONF | sed 's/^[^"]*"//;s/".*//'` ; \ | 240 | DISTRO_VERSION_MINOR=`egrep '^DISTRO_VERSION_MINOR' $$ENEACONF | sed 's/^[^"]*"//;s/".*//'` ; \ |
240 | cat docsrc_common/pardoc-distro.xml | sed '/<\/section>/d' | \ | 241 | cat docsrc_common/pardoc-distro.xml | sed '/<\/section>/d' | \ |
241 | sed '/<!ENTITY ENEA_LINUX_REL_VER/s/".*"/"'"$$DISTRO_VERSION_MAJOR$$DISTRO_VERSION_MINOR"'"/' >$(TMPPARDOC) ; \ | 242 | sed '/<!ENTITY ENEA_LINUX_REL_VER/s/MAJOR.MINOR/'"$$DISTRO_VERSION_MAJOR$$DISTRO_VERSION_MINOR"'/' | \ |
243 | sed '/<!ENTITY . common_poky_entities SYSTEM/s/s_targets\/[^\/]*\/poky/s_targets\/'"$$FIRSTTARGET"'\/poky/' >$(TMPPARDOC) ; \ | ||
242 | echo "<para id=\"EneaLinux_DISTRO_VERSION_MAJOR\"><phrase>$$DISTRO_VERSION_MAJOR</phrase></para>" >>$(TMPPARDOC) ; \ | 244 | echo "<para id=\"EneaLinux_DISTRO_VERSION_MAJOR\"><phrase>$$DISTRO_VERSION_MAJOR</phrase></para>" >>$(TMPPARDOC) ; \ |
243 | echo "<para id=\"EneaLinux_DISTRO_VERSION_MINOR\"><phrase>$$DISTRO_VERSION_MINOR</phrase></para>" >>$(TMPPARDOC) ; \ | 245 | echo "<para id=\"EneaLinux_DISTRO_VERSION_MINOR\"><phrase>$$DISTRO_VERSION_MINOR</phrase></para>" >>$(TMPPARDOC) ; \ |
244 | echo "</section>" >>$(TMPPARDOC) | 246 | echo "</section>" >>$(TMPPARDOC) |
245 | 247 | ||
246 | # **************************************************************************** | 248 | # **************************************************************************** |
249 | # ***** Create XML chapter with build/boot commands from all README files in s_targets | ||
250 | |||
251 | initbuildboot: $(BUILDBOOT_XML) | ||
252 | |||
253 | cleanbuildboot: | ||
254 | $(VERB)rm -f $(BUILDBOOT_XML) 2>/dev/null | ||
255 | |||
256 | |||
257 | $(BUILDBOOT_XML): s_targets $(BUILDBOOT_TEMPLATE) | ||
258 | @echo "Creating $(BUILDBOOT_XML) from READMEs" | ||
259 | $(VERB)INITBB_CMD=initbuildboot.sh ; \ | ||
260 | if [ -f "$$INITBB_CMD" ]; then \ | ||
261 | sh "$$INITBB_CMD" -xml $(BUILDBOOT_XML) -template $(BUILDBOOT_TEMPLATE) ; \ | ||
262 | else \ | ||
263 | echo "ERROR: Missing $$INITBB_CMD, can not create $(BUILDBOOT_XML)"; exit 10; \ | ||
264 | fi | ||
265 | |||
266 | # **************************************************************************** | ||
diff --git a/doc/book-enea-linux-eclipse-open-source/doc/book.xml b/doc/book-enea-linux-eclipse-open-source/doc/book.xml index a25a7de..b76e105 100644 --- a/doc/book-enea-linux-eclipse-open-source/doc/book.xml +++ b/doc/book-enea-linux-eclipse-open-source/doc/book.xml | |||
@@ -8,7 +8,7 @@ | |||
8 | Source Report</title> | 8 | Source Report</title> |
9 | 9 | ||
10 | <subtitle>Release Version <xi:include | 10 | <subtitle>Release Version <xi:include |
11 | href="../../docsrc_common/pardoc-distro.xml" | 11 | href="../../s_docsrc_common/pardoc-distro.xml" |
12 | xmlns:xi="http://www.w3.org/2001/XInclude" | 12 | xmlns:xi="http://www.w3.org/2001/XInclude" |
13 | xpointer="element(EneaLinux_REL_VER/1)" /></subtitle> | 13 | xpointer="element(EneaLinux_REL_VER/1)" /></subtitle> |
14 | 14 | ||
diff --git a/doc/book-enea-linux-open-source/doc/about.xml b/doc/book-enea-linux-open-source/doc/about.xml index cd5be36..f2f863f 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="../../docsrc_common/pardoc-distro.xml" | 9 | href="../../s_docsrc_common/pardoc-distro.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-release-info/doc/about_release.xml b/doc/book-enea-linux-release-info/doc/about_release.xml index d60a10c..90bedaa 100644 --- a/doc/book-enea-linux-release-info/doc/about_release.xml +++ b/doc/book-enea-linux-release-info/doc/about_release.xml | |||
@@ -55,7 +55,7 @@ | |||
55 | </listitem> | 55 | </listitem> |
56 | 56 | ||
57 | <listitem> | 57 | <listitem> |
58 | <para>Freescale P2041DS, Power architecture, No DSPs, Quad-core QorIQ | 58 | <para>Freescale P2041RDB, Power architecture, No DSPs, Quad-core QorIQ |
59 | P2041 processor, e500mc cores.</para> | 59 | P2041 processor, e500mc cores.</para> |
60 | </listitem> | 60 | </listitem> |
61 | 61 | ||
@@ -137,7 +137,7 @@ | |||
137 | <para>Distribution channel:<itemizedlist spacing="compact"> | 137 | <para>Distribution channel:<itemizedlist spacing="compact"> |
138 | <listitem> | 138 | <listitem> |
139 | <para>All deliverables can be downloaded from <xi:include | 139 | <para>All deliverables can be downloaded from <xi:include |
140 | href="../../docsrc_common/pardoc-distro.xml" | 140 | href="../../s_docsrc_common/pardoc-distro.xml" |
141 | xmlns:xi="http://www.w3.org/2001/XInclude" | 141 | xmlns:xi="http://www.w3.org/2001/XInclude" |
142 | xpointer="element(ULINK_ENEA_LINUX_URL/1)" /> <remark>QUEST REMOVE???? | 142 | xpointer="element(ULINK_ENEA_LINUX_URL/1)" /> <remark>QUEST REMOVE???? |
143 | This is still in pardoc-distro.xml</remark></para> | 143 | This is still in pardoc-distro.xml</remark></para> |
@@ -195,7 +195,7 @@ | |||
195 | <entry>Packages provided by Yocto</entry> | 195 | <entry>Packages provided by Yocto</entry> |
196 | 196 | ||
197 | <entry><para>See the Yocto "Release Notes" <xi:include | 197 | <entry><para>See the Yocto "Release Notes" <xi:include |
198 | href="../../docsrc_common/pardoc-distro.xml" | 198 | href="../../s_docsrc_common/pardoc-distro.xml" |
199 | xmlns:xi="http://www.w3.org/2001/XInclude" | 199 | xmlns:xi="http://www.w3.org/2001/XInclude" |
200 | xpointer="element(ULINK_YOCTO_RELEASE_NOTES/1)" /></para></entry> | 200 | xpointer="element(ULINK_YOCTO_RELEASE_NOTES/1)" /></para></entry> |
201 | </row> | 201 | </row> |
diff --git a/doc/book-enea-linux-release-info/doc/book.xml b/doc/book-enea-linux-release-info/doc/book.xml index cc5788f..2be87b0 100644 --- a/doc/book-enea-linux-release-info/doc/book.xml +++ b/doc/book-enea-linux-release-info/doc/book.xml | |||
@@ -10,6 +10,7 @@ | |||
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" /> |
12 | <xi:include href="prerequisites.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | 12 | <xi:include href="prerequisites.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> |
13 | <xi:include href="build_boot_generated.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
13 | <xi:include href="main_changes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | 14 | <xi:include href="main_changes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> |
14 | <xi:include href="known_bugs_and_limitations.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | 15 | <xi:include href="known_bugs_and_limitations.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> |
15 | <xi:include href="extracted_info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | 16 | <xi:include href="extracted_info.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 new file mode 100644 index 0000000..709e624 --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/build_boot_template.xml | |||
@@ -0,0 +1,26 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | ||
4 | <chapter id="target_build_boot"> | ||
5 | <title>Target Specific Build and Boot Instructions</title> | ||
6 | |||
7 | <para>For each target, a README file contains the build and boot | ||
8 | instructions. To make it easier for the reader, the contents of these | ||
9 | build/boot instruction have been extracted below into this release | ||
10 | information document.</para> | ||
11 | |||
12 | <para>The README files are parts of the distribution and can be seen after | ||
13 | the distribution is fetched.<remark>NOTE: Only EDIT THE TEMPLATE FILE! A new | ||
14 | build_boot.xml file is created from the template and sections are added | ||
15 | below automatically from the README files for each target when building the | ||
16 | book! Only in the template file you see a line below with SCRIPT_...._HERE | ||
17 | and the text telling that this is a template file.</remark></para> | ||
18 | |||
19 | <para>SCRIPT_INCLUDES_BUILD_BOOT_SECTIONS_HERE</para> | ||
20 | |||
21 | <para><emphasis role="bold">This is a template file which you can edit. When | ||
22 | the book is built, a new XML chapter file is created where the above part of | ||
23 | this file is copied to the new XML file and all from the line above is | ||
24 | replaced automatically by build and boot sections from the README | ||
25 | files!</emphasis></para> | ||
26 | </chapter> \ No newline at end of file | ||
diff --git a/doc/book-enea-linux-release-info/doc/supported_features.xml b/doc/book-enea-linux-release-info/doc/supported_features.xml index 11e49b1..ebc4b59 100644 --- a/doc/book-enea-linux-release-info/doc/supported_features.xml +++ b/doc/book-enea-linux-release-info/doc/supported_features.xml | |||
@@ -6,7 +6,7 @@ | |||
6 | 6 | ||
7 | <para>The basic features provided by Yocto are listed on the "Features" tab | 7 | <para>The basic features provided by Yocto are listed on the "Features" tab |
8 | on the <xi:include | 8 | on the <xi:include |
9 | href="../../docsrc_common/pardoc-distro.xml" | 9 | href="../../s_docsrc_common/pardoc-distro.xml" |
10 | xmlns:xi="http://www.w3.org/2001/XInclude" | 10 | xmlns:xi="http://www.w3.org/2001/XInclude" |
11 | xpointer="element(ULINK_YOCTO_RELEASE_NOTES/1)" /><remark>???? FIXME THIS WAS "ULINK_YOCTO_DOWN_MINOR_URL" in previous pardoc-distro file - I don't know what is shall be | 11 | xpointer="element(ULINK_YOCTO_RELEASE_NOTES/1)" /><remark>???? FIXME THIS WAS "ULINK_YOCTO_DOWN_MINOR_URL" in previous pardoc-distro file - I don't know what is shall be |
12 | now. Perhaps it is Yocto release notes which I have changed this to, as found in poky.ent</remark>.</para> | 12 | now. Perhaps it is Yocto release notes which I have changed this to, as found in poky.ent</remark>.</para> |
diff --git a/doc/book-enea-linux-release-info/doc/targetscontain.xml b/doc/book-enea-linux-release-info/doc/targetscontain.xml index 06ec23d..42522ae 100644 --- a/doc/book-enea-linux-release-info/doc/targetscontain.xml +++ b/doc/book-enea-linux-release-info/doc/targetscontain.xml | |||
@@ -2,7 +2,13 @@ | |||
2 | <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 2 | <!DOCTYPE section 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 | <section id="targetscontain"> | 4 | <section id="targetscontain"> |
5 | <title>Poky Components in this Distribution</title> | 5 | <title>DEMO-Autogenerated chapter - Poky Components in this |
6 | Distribution</title> | ||
7 | |||
8 | <note> | ||
9 | <para>JUST A DEMO, Examples what could be autoextracted from poky if we | ||
10 | want to</para> | ||
11 | </note> | ||
6 | 12 | ||
7 | <section> | 13 | <section> |
8 | <title>Various Config Files extracted from ls1021atwr/poky</title> | 14 | <title>Various Config Files extracted from ls1021atwr/poky</title> |
diff --git a/doc/book-enea-linux-release-info/doc/targetscontain_template.xml b/doc/book-enea-linux-release-info/doc/targetscontain_template.xml index ea29af5..b91350b 100644 --- a/doc/book-enea-linux-release-info/doc/targetscontain_template.xml +++ b/doc/book-enea-linux-release-info/doc/targetscontain_template.xml | |||
@@ -2,6 +2,11 @@ | |||
2 | <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 2 | <!DOCTYPE section 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 | <section id="targetscontain"> | 4 | <section id="targetscontain"> |
5 | <title>Poky Components in this Distribution</title> | 5 | <title>DEMO-Autogenerated chapter - Poky Components in this |
6 | Distribution</title> | ||
6 | 7 | ||
8 | <note> | ||
9 | <para>JUST A DEMO, Examples what could be autoextracted from poky if we | ||
10 | want to</para> | ||
11 | </note> | ||
7 | </section> \ No newline at end of file | 12 | </section> \ No newline at end of file |
diff --git a/doc/initbuildboot.sh b/doc/initbuildboot.sh new file mode 100644 index 0000000..72606a6 --- /dev/null +++ b/doc/initbuildboot.sh | |||
@@ -0,0 +1,111 @@ | |||
1 | #!/bin/sh | ||
2 | VER="R0.06" | ||
3 | |||
4 | BBTEMPLATE= | ||
5 | BBXML= | ||
6 | |||
7 | USAGE="`basename $0` -xml buildbootxml-to-create -template templatexml-file ($VER) | ||
8 | Currently only supports sequence types Build-command: and Boot-command: | ||
9 | Both files should have path book-*release-info/doc/ | ||
10 | Creates the XML file from the template, inserting build/boot commands | ||
11 | from the various s_targets/XXXtargetXXX/README files | ||
12 | at the place in template with >SCRIPT_INCLUDES_BUILD_BOOT_SECTIONS_HERE< | ||
13 | ignoring rest of template | ||
14 | The code tries to fold too long lines, but this is not perfect. Best would | ||
15 | be if the command lines already in README are short enough, e.g. by | ||
16 | using short variables, which work both on shell and uboot command lines" | ||
17 | |||
18 | while echo "x$1" | egrep '^x-' >/dev/null 2>&1 | ||
19 | do | ||
20 | OPT="$1" ; shift | ||
21 | if [ "$OPT" = "--help" -o "$OPT" = "-h" -o "$OPT" = "-help" ] ; then echo "$USAGE" ; exit ; fi | ||
22 | if [ "$OPT" = "-xml" ] ; then BBXML="$1" ; shift; fi | ||
23 | if [ "$OPT" = "-template" ] ; then BBTEMPLATE="$1" ; shift; fi | ||
24 | done | ||
25 | if [ "$BBTEMPLATE" = "" ]; then echo "ERROR: Missing option -template templatefile"; exit ; fi | ||
26 | if [ "$BBXML" = "" ]; then echo "ERROR: Missing option -xml buildbootxml-to-create"; exit ; fi | ||
27 | if [ ! -f "$BBTEMPLATE" ]; then echo "ERROR: Missing templatefile '$BBTEMPLATE'"; exit; fi | ||
28 | if [ ! -d "`dirname \"$BBXML\"`" ]; then echo "ERROR: Missing parent directory for '$BBXML'"; exit ; fi | ||
29 | |||
30 | echo "`basename $0` Creating $BBXML from" | ||
31 | TARGETREADMES=`cd s_targets ; ls -d */README | tr '\n' ' '` | ||
32 | echo " $TARGETREADMES" | ||
33 | |||
34 | # README file formats: | ||
35 | # a) Sequence starts: ___ XXXX:yyyy or ___ XXXX:yyyy conffile | ||
36 | # where XXXX is a type, yyyy is text to be in title | ||
37 | # b) Inside sequence: ___ END ends the sequence (ignore rest of line) | ||
38 | # c) Inside sequence: # Documentation line | ||
39 | # d) Inside sequence: Anything else is command or config lines | ||
40 | # Conv.to XML: ">" "<" "&" and put all inside <programlisting> | ||
41 | # *) Anywhere ____xxxx Leading 4 underlines or more, always ignored | ||
42 | # unless one of the recognized XXXX | ||
43 | # *) Anywhere outside sequence, ignore all | ||
44 | # *) There can be multiple of each type of sequence in each README file | ||
45 | # with different yyyy | ||
46 | |||
47 | |||
48 | cat $BBTEMPLATE | awk ' | ||
49 | />SCRIPT_INCLUDES_BUILD_BOOT_SECTIONS_HERE</ {exit 0; } | ||
50 | { print $0; } | ||
51 | ' >$BBXML | ||
52 | |||
53 | |||
54 | # Long command lines: The awk code below breaks too long lines, but this is not perfect. | ||
55 | extractcmds_filter() { | ||
56 | echo " <programlisting>" | tr -d '\n' | ||
57 | sed '/^___/d;s/\&/\&/g' | sed 's/</\</g;s/>/\>/g;/^$/d' | \ | ||
58 | awk 'BEGIN { MAX=90; } | ||
59 | ( length($0) > MAX ) { | ||
60 | LINE=$0; | ||
61 | while (length(LINE) > MAX) { | ||
62 | if (index(LINE," ") == 0 ) { | ||
63 | print "ERROR: PROBLEM: No space in too long line:" LINE > "/dev/stderr"; | ||
64 | print $LINE; | ||
65 | next; | ||
66 | } | ||
67 | i=MAX; while ( substr(LINE,i,1) != " " ) { i=i-1; if (i==0) {break;} } | ||
68 | print substr(LINE,0,i) "\\"; | ||
69 | REST=substr(LINE,i+1); | ||
70 | if ( length(REST) == 0 ) { next ; } | ||
71 | LINE=" " REST; | ||
72 | } | ||
73 | if ( length(LINE) > 0 ) { print LINE; next ; } | ||
74 | } | ||
75 | { print;}' | ||
76 | echo "</programlisting>" | ||
77 | } | ||
78 | |||
79 | extractcmds_for_type() { # target/README BOOTorBUILD | ||
80 | README=s_targets/"$1" | ||
81 | CMDTYPE="$2" | ||
82 | COMMANDSFOR=`egrep "___$CMDTYPE:" $README` | ||
83 | for CMDS in $COMMANDSFOR | ||
84 | do | ||
85 | cmdsfor=`echo "$CMDS" | sed 's/[^:]*://'` | ||
86 | echo " <para>$CMDTYPE for $cmdsfor</para>" | ||
87 | cat "$README" | sed -n "/$COMMANDSFOR/,/___END/p" | extractcmds_filter | ||
88 | done | ||
89 | } | ||
90 | |||
91 | for targetreadme in $TARGETREADMES | ||
92 | do | ||
93 | TARGET=`dirname $targetreadme` | ||
94 | echo "" >>$BBXML | ||
95 | echo " <section id=\"target_$TARGET\">" >>$BBXML | ||
96 | echo " <title>Target $TARGET - Build and Boot Instructions</title>" >>$BBXML | ||
97 | echo " <remark>NOTE: DO NOT EDIT THIS GENERATED FILE! Only edit the template file.</remark>" >>$BBXML | ||
98 | echo " <section>" >>$BBXML | ||
99 | echo " <title>Build Instructions</title>" >>$BBXML | ||
100 | extractcmds_for_type $targetreadme Build-command >>$BBXML | ||
101 | echo " </section>" >>$BBXML | ||
102 | echo "" >>$BBXML | ||
103 | echo " <section>" >>$BBXML | ||
104 | echo " <title>Boot Instructions</title>" >>$BBXML | ||
105 | extractcmds_for_type $targetreadme Boot-command >>$BBXML | ||
106 | echo " </section>" >>$BBXML | ||
107 | echo " </section>" >>$BBXML | ||
108 | done | ||
109 | |||
110 | echo "</chapter>" >>$BBXML | ||
111 | echo "Ready created $BBXML" | ||