diff options
Diffstat (limited to 'doc/Makefile')
-rw-r--r-- | doc/Makefile | 381 |
1 files changed, 381 insertions, 0 deletions
diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..f5ab81f --- /dev/null +++ b/doc/Makefile | |||
@@ -0,0 +1,381 @@ | |||
1 | #2017-03-27 Replaced poky autocloning for parameter extraction with XML file updated by the ELTF test system | ||
2 | #2017-11-24 Added support for pdf download in eclipse | ||
3 | |||
4 | #Path to this subsystem's root directory | ||
5 | SUBSYSROOT := $(shell pwd) | ||
6 | |||
7 | # NOTE: MANIFESTHASH in manifest_conf.mk needs to be the final release tag before a release | ||
8 | # The manifest_conf.mk defines MANIFESTHASH and MANIFESTURL and PROFILE_NAME(on front+footers) | ||
9 | include manifest_conf.mk | ||
10 | MANIFESTDIR := $(shell echo "$(MANIFESTURL)" | sed 's/.*\///;s/\.git//') | ||
11 | |||
12 | # Further down we extract the list of target manifest file names from the manifest itself | ||
13 | |||
14 | |||
15 | |||
16 | # ***************** Generic docbuild.git auto-clone + s_docbuild symlink *** | ||
17 | # This also defines TMPCLONEROOT which optionally can be nondefault using BOOK_GLOBALCLONEROOT=yes or a path | ||
18 | include init.mk | ||
19 | |||
20 | TMPCLONEROOT_MANIFEST := $(TMPCLONEROOT)/manifest | ||
21 | |||
22 | |||
23 | # ******************* AutoGenerated chapter from template and target READMEs ******* | ||
24 | BUILDBOOT_XML := book-enea-linux-release-info/doc/build_boot_generated.xml | ||
25 | BUILDBOOT_TEMPLATE := book-enea-linux-release-info/doc/build_boot_template.xml | ||
26 | |||
27 | PKGDIFF_GEN_XML := book-enea-linux-release-info/doc/pkgdiff_generated.xml | ||
28 | JIRA_ISSUES_GEN_XML := book-enea-linux-release-info/doc/jiraissues_generated.xml | ||
29 | |||
30 | MACHINE_LIST_XML := book-enea-linux-release-info/doc/machine_list_generated.xml | ||
31 | |||
32 | ELTF_PARAMS_TEMPLATE := book-enea-linux-release-info/doc/eltf_params_template.xml | ||
33 | ELTF_PARAMS_UPDATED := book-enea-linux-release-info/doc/eltf_params_updated.xml | ||
34 | |||
35 | |||
36 | |||
37 | # ----------------------------------------------------- | ||
38 | #Path to DocBook make files and templates | ||
39 | DOCBOOKMAKE = $(SUBSYSROOT)/s_docbuild/docmake | ||
40 | DOCBOOKTEMPLATE = $(SUBSYSROOT)/s_docbuild/template | ||
41 | |||
42 | #Path to the OLINK database including leading part of file name (will add -$(FORMAT).db) | ||
43 | DOCBOOKOLINKDB_BASE = $(SUBSYSROOT)/s_docbuild/olinkdb/olink-targetdb-ose5-master | ||
44 | |||
45 | DOCBOOK_OLINKS ?= yes | ||
46 | DOCBOOK_FO_USEFOP ?= yes | ||
47 | DOCBOOK_TO_BOOKDIR ?= yes | ||
48 | DOCBOOK_CLEANTMP ?= yes | ||
49 | |||
50 | #Components (books) in this subsystem. Now use all books found here | ||
51 | # COMPONENTS := book-enea-linux-release-info book-enea-linux-open-source | ||
52 | # COMPONENTS += book-enea-linux-eclipse-open-source | ||
53 | COMPONENTS := $(shell ls -d book-enea* ) | ||
54 | |||
55 | # -------------------------------------------------------------- | ||
56 | ifeq ($(VERBOSE),yes) | ||
57 | VERB := | ||
58 | else | ||
59 | VERB := @ | ||
60 | endif | ||
61 | MAKEFLAGS += --no-print-directory | ||
62 | MAKEFLAGS += --directory $(SUBSYSROOT) | ||
63 | MAKEFLAGS += --no-builtin-rules --no-builting-variables | ||
64 | |||
65 | # Skip xml validation to make it possible to include xml files with unresolved links | ||
66 | VALIDATE = no | ||
67 | |||
68 | # BL_LABEL is either given on make command line or using BOOK_VER which have defaults below or a timestamp | ||
69 | |||
70 | # ****************************************************************** | ||
71 | |||
72 | # Export all parameters including those on the command line | ||
73 | export | ||
74 | |||
75 | .PHONY: doc books docusage init initbuild initmanifest initpardoc initbuildboot dist | ||
76 | |||
77 | |||
78 | docusage: | ||
79 | @echo 'make docusage #Shows this help text' | ||
80 | @echo ' DOCBOOK_TOOLS_VERSIONS=yes #Displays./testeltfver.sh DocBook tools versions in this machine' | ||
81 | @echo 'make doc #Builds doc. ALSO automatically does all inits if needed' | ||
82 | @echo 'make dist BOOK_DIST_DIR=xx/doc #Builds doc as above and copies results to BOOK_DIST_DIR' | ||
83 | @echo ' # Does not work with DOCBOOK_TO_BOOKDIR or BOOK_BUILD_DIR' | ||
84 | @echo ' BOOK_DIST_ECLIPSE=yes #Currently EclipseHelp formated doc will not be in BOOK_DIST_DIR' | ||
85 | @echo ' # unless BOOK_DIST_ECLIPSE is set to yes' | ||
86 | @echo 'make init #Init all needed init* below' | ||
87 | @echo 'make initbuild #Init s_docbuild Docbook build system and central files' | ||
88 | @echo 'make initmanifest #Init s_manifest by cloning, to detect which targets are included' | ||
89 | @echo 'make initpardoc #Init s_docsrc_common with extracted parameters/' | ||
90 | @echo 'make initbuildboot #Init build_boot chapter from READMEs and template in release info' | ||
91 | @echo 'make initissues #Init known issues section from Jira' | ||
92 | @echo 'make eltf #Test - displays all ELTF_xxx variables that ELTF shall replace' | ||
93 | @echo ' MANIFESTHASH=xxxxx #Option for all inits above to use nondefault manifest version' | ||
94 | @echo ' #It shall either be ref/tags/<tagvalue> or a hashvalue' | ||
95 | @echo ' #Configured tag or hashvalue $(MANIFESTHASH)' | ||
96 | @echo ' #Configured MANIFESTURL $(MANIFESTURL)' | ||
97 | @echo ' #Configured PROFILE_NAME $(PROFILE_NAME)' | ||
98 | @echo ' DOCBOOK_CLEANTMP=no #Option to keep temp files in doc/ and tmp/' | ||
99 | @echo ' BOOK_GLOBALCLONEROOT=yes #Option for all init above to clone all outside the doc directory' | ||
100 | @echo ' BOOK_GLOBALCLONEROOT=otherpath #Option for all init above to clone all to given path' | ||
101 | @echo 'make clean #Clean results and all s_*, but not any external clones' | ||
102 | @echo '' | ||
103 | @echo 'Optional parameters for make doc:' | ||
104 | @echo ' COMP=<book-directory> #Component (book) to build. Book component names are book-*' | ||
105 | @echo ' #Default component/s:' | ||
106 | @echo ' $(COMPONENTS)' | ||
107 | @echo ' FORMAT=<format> #One of: pdf, html, or eclipse (Default all are built)' | ||
108 | @echo ' BL_LABEL=<baseline> #Becomes footer in book (default: from poky enea.conf MAJORMINOR' | ||
109 | @echo ' # and with profile name taken from the manifest repo name)' | ||
110 | @echo ' DOCBOOK_TO_BOOKDIR=no #(default yes) Avoid moving result to book directory' | ||
111 | @echo ' # and avoid erasing common doc and tmp directories' | ||
112 | @echo ' BOOKFORCE=yes #Force rebuilding (ignore dependency on file times or BL_LABEL)' | ||
113 | @echo ' # Dependency only works if common doc directory is kept' | ||
114 | @echo ' BOOKCONDITION="xx;yy;.." #Include XML elements with condition any of xx or yy' | ||
115 | @echo ' # (if rebuilding, BOOKFORCE=yes may be needed)' | ||
116 | @echo ' # Empty=only default. none=none, all=everything.' | ||
117 | @echo ' BOOKDEFAULTCONDITION #Default conditions, if no BOOKCONDITION. Used in book-*/swcomp.mk' | ||
118 | @echo ' SHOW_COMMENTS=yes #For proofread. Unhide <remark>..</remark> comments Only PDF' | ||
119 | @echo ' BOOKVERBOSE=yes #Verbose info building books' | ||
120 | @echo ' DOCBOOK_OLINKS=no #Avoid the olink database in Makefile (in book not using it)' | ||
121 | @echo ' DOCBOOK_OLINK_TARGETDB=only #Build a target db for this book (for links into it)' | ||
122 | @echo ' DOCBOOK_OLINK_TARGETDB=yes #Build a target db AND build the book' | ||
123 | @echo ' #Master olinkdb defined in this Makefile, one per generated format, is:' | ||
124 | @echo ' $(DOCBOOKOLINKDB_BASE)_*.db' | ||
125 | @echo ' Typical examples:' | ||
126 | @echo ' make doc Creates all books, all formats' | ||
127 | @echo ' make doc COMP=book-xxxx FORMAT=html' | ||
128 | @echo ' make doc COMP=book-xxxx FORMAT=pdf' | ||
129 | @echo ' make doc BL_LABEL="Version 1.2.3" Creates all with version in footers and front' | ||
130 | @echo '' | ||
131 | @echo ' Requires docbook-xsl-1.76.1 or later, docbook-xml 4.2, svg1.1, fop-1.0 + fop-hyph.jar' | ||
132 | @echo ' fop + the separate fop-hyph can be found together in package "libfop-java"' | ||
133 | @echo ' otherwise fetch fop-hyph.jar and place in same place as fop.jar' | ||
134 | @echo ' Requires libxml2-2.7.8 or later, libxslt-1.1.26 or later' | ||
135 | @echo ' Requires java machine to run fop (creating PDF). jar for optional FORMAT=eclipse' | ||
136 | @echo ' Without jar, the optional EclipseHelp format can not be built' | ||
137 | @echo ' tools_book_standalone.mk => libxml2, libxslt, and fop (and to catalog-el.xml)' | ||
138 | @echo ' catalog-el.xml => svg, docbook-xml, docbook-xsl' | ||
139 | ifeq ($(DOCBOOK_TOOLS_VERSIONS),yes) | ||
140 | $(VERB)$(MAKE) -f $(DOCBOOKMAKE)/tools_book_standalone.mk book_tools_versions | ||
141 | endif | ||
142 | |||
143 | # We rely on make doing these in order left to right | ||
144 | init: initbuild initcommon initmanifest initpardoc initbuildboot initpkgdiff initissues | ||
145 | pullall: pullbuild | ||
146 | |||
147 | # If no COMP, iterate over books-* in COMPONENTS with make doc | ||
148 | ifeq ($(COMP),) | ||
149 | doc: | ||
150 | ifneq ($(filter book-%, $(COMPONENTS)),) | ||
151 | $(VERB)for comp in $(filter book-%, $(COMPONENTS)); do \ | ||
152 | $(MAKE) doc COMP=$$comp; \ | ||
153 | done | ||
154 | endif | ||
155 | |||
156 | else | ||
157 | include $(SUBSYSROOT)/$(COMP)/swcomp.mk | ||
158 | |||
159 | doc: books | ||
160 | @# | ||
161 | endif | ||
162 | |||
163 | dist: doc | ||
164 | @echo "Copying resulting built documents to $(BOOK_DIST_DIR)" | ||
165 | $(VERB)if [ "$(BOOK_DIST_DIR)" = "" ]; then echo "ERROR: Missing BOOK_DIST_DIR parameter, typically shall be xxx/doc"; exit 10; fi | ||
166 | $(VERB)if [ ! -d "`dirname $(BOOK_DIST_DIR)`" ]; then echo "ERROR: Missing parent for BOOK_DIST_DIR"; exit 10; fi | ||
167 | $(VERB)if [ -f "$(BOOK_DIST_DIR)/Makefile" ]; then echo "ERROR: Wrong BOOK_DIST_DIR, contains a Makefile?"; exit 10; fi | ||
168 | $(VERB)if [ ! -d "$(BOOK_DIST_DIR)" ]; then mkdir -p "$(BOOK_DIST_DIR)" ; fi | ||
169 | $(VERB)for book in $(COMPONENTS); do \ | ||
170 | if ls -d $$book/book*.pdf >/dev/null 2>&1; then cp --preserve=timestamps $$book/book*.pdf "$(BOOK_DIST_DIR)" ; fi ; \ | ||
171 | if ls -d $$book/html >/dev/null 2>&1; then cp -r --preserve=timestamps $$book/html "$(BOOK_DIST_DIR)" ; fi ; \ | ||
172 | if [ "$(BOOK_DIST_ECLIPSE)" = "yes" ]; then \ | ||
173 | if ls -d $$book/eclipse >/dev/null 2>&1; then cp -r --preserve=timestamps $$book/eclipse "$(BOOK_DIST_DIR)" ; fi ; \ | ||
174 | fi ; \ | ||
175 | done | ||
176 | |||
177 | # Default FORMATs | ||
178 | ifeq ($(FORMAT),) | ||
179 | FORMAT=html pdf eclipse | ||
180 | endif | ||
181 | |||
182 | |||
183 | books: init | ||
184 | # BOOKPACKAGES is defined in all book-*/swcomp.mk | ||
185 | $(VERB)DISTRO_VERSION=`egrep '"EneaLinux_REL_VER"><phrase>' $(ELTF_PARAMS_UPDATED) | sed 's/.*<phrase>//;s/<\/phrase>.*//'` ; \ | ||
186 | BOOKVER="Profile $(PROFILE_NAME)-$$DISTRO_VERSION" ; \ | ||
187 | for book in $(BOOKPACKAGES); do \ | ||
188 | for format in $(FORMAT); do \ | ||
189 | $(MAKE) -f $(DOCBOOKMAKE)/make_docbook_standalone.mk BOOK=$$book FORMAT=$$format BOOK_VER="$$BOOKVER" books || exit 10; \ | ||
190 | if [ $$format = eclipse ]; then \ | ||
191 | if [ ! -f $$COMP/$$book.pdf ]; then \ | ||
192 | $(MAKE) -f $(DOCBOOKMAKE)/make_docbook_standalone.mk BOOK=$$book FORMAT=pdf BOOK_VER="$$BOOKVER" books || exit 10; \ | ||
193 | fi; \ | ||
194 | cp $$COMP/$$book.pdf $$COMP/eclipse/plugins/com.enea.doc.book-*/. ; \ | ||
195 | fi ; \ | ||
196 | done ; \ | ||
197 | done | ||
198 | ifeq ($(DOCBOOK_TO_BOOKDIR),yes) | ||
199 | $(VERB)rm -rf doc tmp | ||
200 | else | ||
201 | ifeq ($(DOCBOOK_CLEANTMP),yes) | ||
202 | # keep only doc/pdf/book-*.pdf doc/eclipse/plugins/com.enea.doc.book-* but delete doc/eclipse/plugins/com.enea.doc.book-*/done* | ||
203 | $(VERB)rm -rf tmp 2>/dev/null ; rm -rf doc/pdf/book-*/ ; rm -rf doc/eclipse/plugins/com.enea.doc.book-*/done* 2>/dev/null | ||
204 | endif | ||
205 | endif | ||
206 | |||
207 | # cleaninit cleans ALL tmpcommon and all s_* | ||
208 | clean: cleaninit cleanbuildboot cleanpkgdiff cleanissues cleanmanifest | ||
209 | @echo "Cleaning build results and temporary files" | ||
210 | $(VERB)rm -rf doc tmp 2>/dev/null | ||
211 | ifneq ($(filter book-%, $(COMPONENTS)),) | ||
212 | $(VERB)for comp in $(filter book-%, $(COMPONENTS)); do \ | ||
213 | rm -rf $$comp/book*.pdf $$comp/html $$comp/eclipse 2>/dev/null; \ | ||
214 | done | ||
215 | $(VERB)rm -rf doc tmp 2>/dev/null | ||
216 | endif | ||
217 | |||
218 | |||
219 | # ****************************************************************** | ||
220 | # ****************** SUPPORT FOR TARGETS *************************** | ||
221 | initmanifest: s_manifest | ||
222 | |||
223 | |||
224 | # ----------------------------------------- | ||
225 | # We only clone the manifest to be able to autodetect which targets are in it | ||
226 | # git clone requires only the tag string e.g. EL6, not the entire ref/tags/EL6 that repo requires | ||
227 | # git clone -b hashvalue is not supported. We must first clone, then git checkout hashvalue | ||
228 | # These steps work also for a tag so we could use the same stepwise code | ||
229 | |||
230 | s_manifest: $(TMPCLONEROOT_MANIFEST) | ||
231 | $(VERB)rm s_manifest 2>/dev/null; ln -s $(TMPCLONEROOT_MANIFEST) s_manifest | ||
232 | |||
233 | cleanmanifest: | ||
234 | @echo "Cleaning generated manifest files" | ||
235 | $(VERB)rm -f $(MACHINE_LIST_XML) 2>/dev/null | ||
236 | $(VERB)rm -rf "$(TMPCLONEROOT_MANIFEST)" s_manifest 2>/dev/null | ||
237 | |||
238 | $(TMPCLONEROOT_MANIFEST): | ||
239 | $(VERB)if [ ! -d "$(TMPCLONEROOT)" ] ; then mkdir -p "$(TMPCLONEROOT)" ; fi | ||
240 | $(VERB)if [ ! -d "$(TMPCLONEROOT_MANIFEST)" ]; then mkdir -p "$(TMPCLONEROOT_MANIFEST)" ; fi | ||
241 | $(VERB) MBRANCH=`echo "$(MANIFESTHASH)" | sed 's/.*\///'`; \ | ||
242 | echo "**** Cloning manifest version $$MBRANCH of $(MANIFESTURL) in $(TMPCLONEROOT_MANIFEST)" ; \ | ||
243 | cd "$(TMPCLONEROOT_MANIFEST)"; git clone $(MANIFESTURL) ; cd $(MANIFESTDIR) ; git checkout $(MANIFESTHASH) | ||
244 | $(VERB)if [ ! -d "$(TMPCLONEROOT_MANIFEST)/$(MANIFESTDIR)" ]; then echo "ERROR: Missing $(TMPCLONEROOT_MANIFEST)/$(MANIFESTDIR)"; exit 10 ; fi ; \ | ||
245 | TARGETDEFAULTXMLS=`cd $(TMPCLONEROOT_MANIFEST)/$(MANIFESTDIR); ls -1 */default.xml 2>/dev/null` ; \ | ||
246 | TARGET_LIST=`echo "$$TARGETDEFAULTXMLS" | sed 's/\/default.xml//;s/^/# export MACHINE=/'` ; \ | ||
247 | echo "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>" >$(MACHINE_LIST_XML) ; \ | ||
248 | echo "<!DOCTYPE para PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\"" >>$(MACHINE_LIST_XML) ; \ | ||
249 | echo "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\">" >>$(MACHINE_LIST_XML) ; \ | ||
250 | echo "<para id=\"machine-list\">" >>$(MACHINE_LIST_XML) ; \ | ||
251 | echo "<programlisting># Set MACHINE to ONE of the targets in this release!" >>$(MACHINE_LIST_XML) ; \ | ||
252 | echo "$$TARGET_LIST</programlisting>" >>$(MACHINE_LIST_XML) ; \ | ||
253 | echo "</para>" >>$(MACHINE_LIST_XML) | ||
254 | |||
255 | |||
256 | # **************************************************************************** | ||
257 | # ******************** SUPPORT FOR dynamic pardoc with added parameters ****** | ||
258 | # pardoc-distro can contain MAJOR.MINOR-xxxxx keeping -xxxx when replacing MINOR.MINOR from enea.conf | ||
259 | |||
260 | PATH_DOCSRC_COMMON = $(SUBSYSROOT)/s_docsrc_common | ||
261 | NAME_DOCSRC_COMMON = docsrc_common | ||
262 | TMPCLONEROOT_DOCSRC_COMMON := $(TMPCLONEROOT)/$(NAME_DOCSRC_COMMON) | ||
263 | TMPPARDOC := $(TMPCLONEROOT_DOCSRC_COMMON)/pardoc-distro.xml | ||
264 | |||
265 | initpardoc: s_docsrc_common | ||
266 | |||
267 | cleanpardoc: | ||
268 | @echo "Cleaning dynamic parameters" | ||
269 | $(VERB)rm -rf $(TMPCLONEROOT_DOCSRC_COMMON) ; rm s_docsrc_common | ||
270 | |||
271 | |||
272 | s_docsrc_common: $(TMPCLONEROOT_DOCSRC_COMMON) | ||
273 | $(VERB)rm s_docsrc_common 2>/dev/null; ln -s $(TMPCLONEROOT_DOCSRC_COMMON) s_docsrc_common | ||
274 | |||
275 | $(TMPCLONEROOT_DOCSRC_COMMON): | ||
276 | $(VERB)if [ ! -d "$(TMPCLONEROOT)" ] ; then mkdir -p "$(TMPCLONEROOT)" ; fi | ||
277 | $(VERB)if [ ! -d $(TMPCLONEROOT_DOCSRC_COMMON) ]; then mkdir -p $(TMPCLONEROOT_DOCSRC_COMMON) ; fi | ||
278 | @echo "**** Copy docsrc_common/ files to $(TMPCLONEROOT_DOCSRC_COMMON)" | ||
279 | $(VERB)cat docsrc_common/pardoc-distro.xml >$(TMPPARDOC) | ||
280 | |||
281 | # **************************************************************************** | ||
282 | # ***** Create XML chapter with build/boot commands from all README files in manifest | ||
283 | |||
284 | initbuildboot: $(BUILDBOOT_XML) | ||
285 | |||
286 | cleanbuildboot: | ||
287 | @echo "Cleaning generated build-boot command document file" | ||
288 | $(VERB)rm -f $(BUILDBOOT_XML) 2>/dev/null | ||
289 | |||
290 | |||
291 | $(BUILDBOOT_XML): $(BUILDBOOT_TEMPLATE) | ||
292 | @echo "**** Creating $(BUILDBOOT_XML) from READMEs" | ||
293 | $(VERB)INITBB_CMD=initbuildboot.sh ; \ | ||
294 | if [ -f "$$INITBB_CMD" ]; then \ | ||
295 | sh "$$INITBB_CMD" -xml $(BUILDBOOT_XML) -template $(BUILDBOOT_TEMPLATE) -readmebasedir s_manifest/$(MANIFESTDIR); \ | ||
296 | else \ | ||
297 | echo "ERROR: Missing $$INITBB_CMD, can not create $(BUILDBOOT_XML)"; exit 10; \ | ||
298 | fi | ||
299 | |||
300 | # **************************************************************************** | ||
301 | # ***** Create Package DIFF XML section | ||
302 | |||
303 | initpkgdiff: $(PKGDIFF_GEN_XML) | ||
304 | |||
305 | cleanpkgdiff: | ||
306 | @echo "Cleaning generated package diff document file" | ||
307 | $(VERB)rm -f $(PKGDIFF_GEN_XML) 2>/dev/null | ||
308 | |||
309 | $(PKGDIFF_GEN_XML): | ||
310 | $(VERB)PREVIOUS_BL=`egrep '"prev_baseline"' docsrc_common/pardoc-distro.xml | sed 's/^.*<phrase>//;s/<\/phrase>.*$$//'` ; \ | ||
311 | echo "**** Generating $(PKGDIFF_GEN_XML) compared to $$PREVIOUS_BL, using gen_pkgdiff.py" ; \ | ||
312 | python gen_pkgdiff.py >$(PKGDIFF_GEN_XML) | ||
313 | |||
314 | |||
315 | # **************************************************************************** | ||
316 | # ***** Create Jira Issues XML section for the known bugs chapter | ||
317 | |||
318 | .PHONY: $(JIRA_ISSUES_GEN_XML) | ||
319 | # We want new issue list to be generated also at build, not only at init | ||
320 | |||
321 | initissues: $(JIRA_ISSUES_GEN_XML) | ||
322 | |||
323 | |||
324 | cleanissues: | ||
325 | @echo "Cleaning generated known issues document file" | ||
326 | $(VERB)rm -f $(JIRA_ISSUES_GEN_XML) 2>/dev/null | ||
327 | |||
328 | $(JIRA_ISSUES_GEN_XML): | ||
329 | @echo "**** Generating $(JIRA_ISSUES_GEN_XML), fetching from Jira using gen_known_issues.py" | ||
330 | $(VERB)python gen_known_issues.py >$(JIRA_ISSUES_GEN_XML) | ||
331 | |||
332 | # **************************************************************************** | ||
333 | |||
334 | # | ||
335 | # All ELTF_ variables names only has upper case, underline and digits | ||
336 | eltf: | ||
337 | @echo "# make eltf extracts and displays all ELTF_ variables found here" | ||
338 | @echo "# in $(SUBSYSROOT)/$(ELTF_PARAMS_TEMPLATE)" | ||
339 | @echo "# Replace all variables, creating a new eltf*updated.xml file from the eltf*template.xml" | ||
340 | @echo "#" | ||
341 | @echo "# Only replace + push the result file $(ELTF_PARAMS_UPDATED), IF IT WILL BE CHANGED." | ||
342 | @echo "#" | ||
343 | @echo "# IMPORTANT: See eltf_params_updated_template_how_to_use.txt for requirements and details!" | ||
344 | @echo "# Below is only a summary!" | ||
345 | @echo "#" | ||
346 | @echo "# ELTF_ variables must be UNIQUE, e.g. a variable must not be a part of another variable" | ||
347 | @echo "#" | ||
348 | @echo "# ELTF_PL_* and ELTF_T_PL_* shall have the format for programlisting and are often multiline - see below." | ||
349 | @echo "#" | ||
350 | @echo "# ELTF_*_URL and ELTF_*_TXTURL are the URL part and TXT part of ulink; those shall be exactly identical," | ||
351 | @echo "# unless the URL is very very long." | ||
352 | @echo "#" | ||
353 | @echo "# ELTF_T_* are target (MACHINE) variables in one subsection, replace with machine specific strings." | ||
354 | @echo "#" | ||
355 | @echo "# Append more target subsections to *updated.xml, if more than one target is in a release!" | ||
356 | @echo "# Replace the line <!-- ELTFADD_MORE_TARGET_SECTIONS_BELOW_IF_NEEDED --> with appended" | ||
357 | @echo "# complete target section elements copied before the variables are replaced." | ||
358 | @echo "# In each target section, replace the ELTF_T* variables with machine dependent strings" | ||
359 | @echo "# Append final lines seen after <!-- ELTFADD_MORE_TARGET_SECTIONS_BELOW_IF_NEEDED -->" | ||
360 | @echo "# but that would often only be two final </section> </section> lines" | ||
361 | @echo "#" | ||
362 | @echo "# ELTF_ Variables: Replace each variable with a string, for ELTF_*PL* it can be multiline" | ||
363 | @echo "# DO NOT use any leading or trailing spaces and DO NOT use TABs" | ||
364 | @echo "#" | ||
365 | @echo "# ELTF_ Everywhere: Only 7-bit ASCII inside the string replacing a variable. Translate characters" | ||
366 | @echo "# like & < > to & < > etc." | ||
367 | @echo "# unless real XML shall be inserted like when entire sections are appended." | ||
368 | @echo "#" | ||
369 | @echo "# ELTF_ programlisting, variables with PL in the name: Max line length < 80 char." | ||
370 | @echo "# Use backslash + indent-leading-spaces for continuation lines." | ||
371 | @echo "# Multiline. No trailing spaces on any line inside the programlisting." | ||
372 | @echo "#" | ||
373 | @echo "# The following variables shall be replaced with suitable contents (egrep from the template):" | ||
374 | @echo "# Again: See details in eltf_params_updated_template_how_to_use.txt" | ||
375 | @echo "# including also examples of contents of each variable!" | ||
376 | @echo "#" | ||
377 | $(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 | ||
378 | @echo "# The make eltf also here extracts any left-over ELTF variables from $(ELTF_PARAMS_UPDATED)" | ||
379 | @echo "# It should not be any left here:" | ||
380 | $(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 | ||
381 | @echo "# If you see any left-over above, something is wrong" | ||