diff options
author | mrpa <miruna.paun@enea.com> | 2020-06-11 19:00:49 +0200 |
---|---|---|
committer | Miruna Paun <mrpa@enea.se> | 2020-06-16 14:25:31 +0200 |
commit | d13a165d784a8a669edca35efee6f5c98045a766 (patch) | |
tree | 2af81cbe60b126a215767926583190af1a24ad33 /doc/Makefile | |
parent | 20df9df706f2c35b37d623c569c6110fc2f402cb (diff) | |
download | nfv-access-documentation-d13a165d784a8a669edca35efee6f5c98045a766.tar.gz |
Updated the makefile and init.mk to point to gitlab2
Updated the makefile to reflect olinkdb changes
Updated the makefule to reflect removal of manifest_conf.mk
Updated rel notes with olinks and removing zip files no longer
included in releases.
Updated the ATFH OSR swcomp to include version variable.
Change-Id: I7b4decb707370acff90348361525f30bd8c20707
Signed-off-by: mrpa <miruna.paun@enea.com>
Diffstat (limited to 'doc/Makefile')
-rw-r--r-- | doc/Makefile | 79 |
1 files changed, 8 insertions, 71 deletions
diff --git a/doc/Makefile b/doc/Makefile index 80a93c7..404ad05 100644 --- a/doc/Makefile +++ b/doc/Makefile | |||
@@ -8,8 +8,8 @@ SUBSYSROOT := $(shell pwd) | |||
8 | 8 | ||
9 | # NOTE: MANIFESTHASH in manifest_conf.mk needs to be the final release tag before a release | 9 | # NOTE: MANIFESTHASH in manifest_conf.mk needs to be the final release tag before a release |
10 | # The manifest_conf.mk defines MANIFESTHASH and MANIFESTURL and PROFILE_NAME(on front+footers) | 10 | # The manifest_conf.mk defines MANIFESTHASH and MANIFESTURL and PROFILE_NAME(on front+footers) |
11 | include manifest_conf.mk | 11 | #include manifest_conf.mk |
12 | MANIFESTDIR := $(shell echo "$(MANIFESTURL)" | sed 's/.*\///;s/\.git//') | 12 | #MANIFESTDIR := $(shell echo "$(MANIFESTURL)" | sed 's/.*\///;s/\.git//') |
13 | 13 | ||
14 | # Further down we extract the list of target manifest file names from the manifest itself | 14 | # Further down we extract the list of target manifest file names from the manifest itself |
15 | 15 | ||
@@ -19,7 +19,7 @@ MANIFESTDIR := $(shell echo "$(MANIFESTURL)" | sed 's/.*\///;s/\.git//') | |||
19 | # This also defines TMPCLONEROOT which optionally can be nondefault using BOOK_GLOBALCLONEROOT=yes or a path | 19 | # This also defines TMPCLONEROOT which optionally can be nondefault using BOOK_GLOBALCLONEROOT=yes or a path |
20 | include init.mk | 20 | include init.mk |
21 | 21 | ||
22 | TMPCLONEROOT_MANIFEST := $(TMPCLONEROOT)/manifest | 22 | #TMPCLONEROOT_MANIFEST := $(TMPCLONEROOT)/manifest |
23 | 23 | ||
24 | 24 | ||
25 | # ******************* AutoGenerated chapters from template and target READMEs ******* | 25 | # ******************* AutoGenerated chapters from template and target READMEs ******* |
@@ -42,7 +42,7 @@ DOCBOOKMAKE = $(SUBSYSROOT)/s_docbuild/docmake | |||
42 | DOCBOOKTEMPLATE = $(SUBSYSROOT)/s_docbuild/template | 42 | DOCBOOKTEMPLATE = $(SUBSYSROOT)/s_docbuild/template |
43 | 43 | ||
44 | #Path to the OLINK database including leading part of file name (will add -$(FORMAT).db) | 44 | #Path to the OLINK database including leading part of file name (will add -$(FORMAT).db) |
45 | DOCBOOKOLINKDB_BASE = $(SUBSYSROOT)/s_docbuild/olinkdb/olink-targetdb-ose5-master | 45 | DOCBOOKOLINKDB_BASE = $(SUBSYSROOT)/s_docbuild/olinkdb/olink-targetdb-master |
46 | 46 | ||
47 | DOCBOOK_OLINKS ?= yes | 47 | DOCBOOK_OLINKS ?= yes |
48 | DOCBOOK_FO_USEFOP ?= yes | 48 | DOCBOOK_FO_USEFOP ?= yes |
@@ -51,16 +51,7 @@ DOCBOOK_CLEANTMP ?= yes | |||
51 | 51 | ||
52 | #Components (books) in this subsystem. Now use all books found here | 52 | #Components (books) in this subsystem. Now use all books found here |
53 | COMPONENTS := book-enea-nfv-access-auto-fw-th-open-source book-enea-nfv-access-auto-fw-th-user-guide book-enea-nfv-access-cmc-example-usecases book-enea-nfv-access-example-usecases book-enea-nfv-access-getting-started book-enea-nfv-access-open-source book-enea-nfv-access-release-info book-enea-nfv-access-system-test-specification book-enea-nfv-access-evalkit | 53 | COMPONENTS := book-enea-nfv-access-auto-fw-th-open-source book-enea-nfv-access-auto-fw-th-user-guide book-enea-nfv-access-cmc-example-usecases book-enea-nfv-access-example-usecases book-enea-nfv-access-getting-started book-enea-nfv-access-open-source book-enea-nfv-access-release-info book-enea-nfv-access-system-test-specification book-enea-nfv-access-evalkit |
54 | # COMPONENTS += | ||
55 | #book-enea-nfv-access-dev-hardening-guide | ||
56 | #book-enea-nfv-access-esdk-open-source | ||
57 | #book-enea-nfv-access-guide | ||
58 | #book-enea-nfv-access-reference-guide-intel | ||
59 | #book-enea-nfv-access-sdk-open-source | ||
60 | #book-enea-nfv-access-user-hardening-guide | ||
61 | #book-enea-nfv-access-vnf-onboarding-guide | ||
62 | 54 | ||
63 | #COMPONENTS := $(shell ls -d book-enea* ) | ||
64 | 55 | ||
65 | # -------------------------------------------------------------- | 56 | # -------------------------------------------------------------- |
66 | ifeq ($(VERBOSE),yes) | 57 | ifeq ($(VERBOSE),yes) |
@@ -82,7 +73,7 @@ VALIDATE = no | |||
82 | # Export all parameters including those on the command line | 73 | # Export all parameters including those on the command line |
83 | export | 74 | export |
84 | 75 | ||
85 | .PHONY: doc books docusage init initbuild initmanifest initpardoc initbuildboot dist | 76 | .PHONY: doc books docusage init initbuild initpardoc dist |
86 | 77 | ||
87 | 78 | ||
88 | docusage: | 79 | docusage: |
@@ -151,7 +142,7 @@ ifeq ($(DOCBOOK_TOOLS_VERSIONS),yes) | |||
151 | endif | 142 | endif |
152 | 143 | ||
153 | # We rely on make doing these in order left to right | 144 | # We rely on make doing these in order left to right |
154 | init: initbuild initcommon initmanifest initpardoc initbuildboot initpkgdiff initissues | 145 | init: initbuild initcommon initpardoc initpkgdiff initissues |
155 | pullall: pullbuild | 146 | pullall: pullbuild |
156 | 147 | ||
157 | # If no COMP, iterate over books-* in COMPONENTS with make doc | 148 | # If no COMP, iterate over books-* in COMPONENTS with make doc |
@@ -193,7 +184,7 @@ endif | |||
193 | books: init | 184 | books: init |
194 | # BOOKPACKAGES is defined in all book-*/swcomp.mk | 185 | # BOOKPACKAGES is defined in all book-*/swcomp.mk |
195 | $(VERB)DISTRO_VERSION=`egrep '"EneaLinux_REL_VER"><phrase>' $(ELTF_PARAMS_UPDATED) | sed 's/.*<phrase>//;s/<\/phrase>.*//'` ; \ | 186 | $(VERB)DISTRO_VERSION=`egrep '"EneaLinux_REL_VER"><phrase>' $(ELTF_PARAMS_UPDATED) | sed 's/.*<phrase>//;s/<\/phrase>.*//'` ; \ |
196 | BOOKVER="$(PROFILE_NAME)-$$DISTRO_VERSION"-$(shell date +"%Y.%m.%d"); \ | 187 | BOOKVER="Enea NFV Access-$$DISTRO_VERSION"-$(shell date +"%Y.%m.%d"); \ |
197 | for book in $(BOOKPACKAGES); do \ | 188 | for book in $(BOOKPACKAGES); do \ |
198 | for format in $(FORMAT); do \ | 189 | for format in $(FORMAT); do \ |
199 | $(MAKE) -f $(DOCBOOKMAKE)/make_docbook_standalone.mk BOOK=$$book FORMAT=$$format BOOK_VER="$$BOOKVER" books || exit 10; \ | 190 | $(MAKE) -f $(DOCBOOKMAKE)/make_docbook_standalone.mk BOOK=$$book FORMAT=$$format BOOK_VER="$$BOOKVER" books || exit 10; \ |
@@ -215,7 +206,7 @@ endif | |||
215 | endif | 206 | endif |
216 | 207 | ||
217 | # cleaninit cleans ALL tmpcommon and all s_* | 208 | # cleaninit cleans ALL tmpcommon and all s_* |
218 | clean: cleaninit cleanbuildboot cleanpkgdiff cleanissues cleanmanifest | 209 | clean: cleaninit cleanpkgdiff cleanissues |
219 | @echo "Cleaning build results and temporary files" | 210 | @echo "Cleaning build results and temporary files" |
220 | $(VERB)rm -rf doc tmp 2>/dev/null | 211 | $(VERB)rm -rf doc tmp 2>/dev/null |
221 | ifneq ($(filter book-%, $(COMPONENTS)),) | 212 | ifneq ($(filter book-%, $(COMPONENTS)),) |
@@ -226,42 +217,6 @@ ifneq ($(filter book-%, $(COMPONENTS)),) | |||
226 | endif | 217 | endif |
227 | 218 | ||
228 | 219 | ||
229 | # ****************************************************************** | ||
230 | # ****************** SUPPORT FOR TARGETS *************************** | ||
231 | initmanifest: s_manifest | ||
232 | |||
233 | |||
234 | # ----------------------------------------- | ||
235 | # We only clone the manifest to be able to autodetect which targets are in it | ||
236 | # git clone requires only the tag string e.g. EL6, not the entire ref/tags/EL6 that repo requires | ||
237 | # git clone -b hashvalue is not supported. We must first clone, then git checkout hashvalue | ||
238 | # These steps work also for a tag so we could use the same stepwise code | ||
239 | |||
240 | s_manifest: $(TMPCLONEROOT_MANIFEST) | ||
241 | $(VERB)rm s_manifest 2>/dev/null; ln -s $(TMPCLONEROOT_MANIFEST) s_manifest | ||
242 | |||
243 | cleanmanifest: | ||
244 | @echo "Cleaning generated manifest files" | ||
245 | $(VERB)rm -f $(MACHINE_LIST_XML) 2>/dev/null | ||
246 | $(VERB)rm -rf "$(TMPCLONEROOT_MANIFEST)" s_manifest 2>/dev/null | ||
247 | |||
248 | $(TMPCLONEROOT_MANIFEST): | ||
249 | $(VERB)if [ ! -d "$(TMPCLONEROOT)" ] ; then mkdir -p "$(TMPCLONEROOT)" ; fi | ||
250 | $(VERB)if [ ! -d "$(TMPCLONEROOT_MANIFEST)" ]; then mkdir -p "$(TMPCLONEROOT_MANIFEST)" ; fi | ||
251 | $(VERB) MBRANCH=`echo "$(MANIFESTHASH)" | sed 's/.*\///'`; \ | ||
252 | echo "**** Cloning manifest version $$MBRANCH of $(MANIFESTURL) in $(TMPCLONEROOT_MANIFEST)" ; \ | ||
253 | cd "$(TMPCLONEROOT_MANIFEST)"; git clone $(MANIFESTURL) ; cd $(MANIFESTDIR) ; git checkout $(MANIFESTHASH) | ||
254 | $(VERB)if [ ! -d "$(TMPCLONEROOT_MANIFEST)/$(MANIFESTDIR)" ]; then echo "ERROR: Missing $(TMPCLONEROOT_MANIFEST)/$(MANIFESTDIR)"; exit 10 ; fi ; \ | ||
255 | TARGETDEFAULTXMLS=`cd $(TMPCLONEROOT_MANIFEST)/$(MANIFESTDIR); ls -1 */default.xml 2>/dev/null` ; \ | ||
256 | TARGET_LIST=`echo "$$TARGETDEFAULTXMLS" | sed 's/\/default.xml//;s/^/# export MACHINE=/'` ; \ | ||
257 | echo "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>" >$(MACHINE_LIST_XML) ; \ | ||
258 | echo "<!DOCTYPE para PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\"" >>$(MACHINE_LIST_XML) ; \ | ||
259 | echo "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\">" >>$(MACHINE_LIST_XML) ; \ | ||
260 | echo "<para id=\"machine-list\">" >>$(MACHINE_LIST_XML) ; \ | ||
261 | echo "<programlisting># Set MACHINE to ONE of the targets in this release!" >>$(MACHINE_LIST_XML) ; \ | ||
262 | echo "$$TARGET_LIST</programlisting>" >>$(MACHINE_LIST_XML) ; \ | ||
263 | echo "</para>" >>$(MACHINE_LIST_XML) | ||
264 | |||
265 | 220 | ||
266 | # **************************************************************************** | 221 | # **************************************************************************** |
267 | # ******************** SUPPORT FOR dynamic pardoc with added parameters ****** | 222 | # ******************** SUPPORT FOR dynamic pardoc with added parameters ****** |
@@ -288,24 +243,6 @@ $(TMPCLONEROOT_DOCSRC_COMMON): | |||
288 | @echo "**** Copy docsrc_common/ files to $(TMPCLONEROOT_DOCSRC_COMMON)" | 243 | @echo "**** Copy docsrc_common/ files to $(TMPCLONEROOT_DOCSRC_COMMON)" |
289 | $(VERB)cat docsrc_common/pardoc-distro.xml >$(TMPPARDOC) | 244 | $(VERB)cat docsrc_common/pardoc-distro.xml >$(TMPPARDOC) |
290 | 245 | ||
291 | # **************************************************************************** | ||
292 | # ***** Create XML chapter with build/boot commands from all README files in manifest | ||
293 | |||
294 | initbuildboot: $(BUILDBOOT_XML) | ||
295 | |||
296 | cleanbuildboot: | ||
297 | @echo "Cleaning generated build-boot command document file" | ||
298 | $(VERB)rm -f $(BUILDBOOT_XML) 2>/dev/null | ||
299 | |||
300 | |||
301 | $(BUILDBOOT_XML): $(BUILDBOOT_TEMPLATE) | ||
302 | @echo "**** Creating $(BUILDBOOT_XML) from READMEs" | ||
303 | $(VERB)INITBB_CMD=initbuildboot.sh ; \ | ||
304 | if [ -f "$$INITBB_CMD" ]; then \ | ||
305 | sh "$$INITBB_CMD" -xml $(BUILDBOOT_XML) -template $(BUILDBOOT_TEMPLATE) -readmebasedir s_manifest/$(MANIFESTDIR); \ | ||
306 | else \ | ||
307 | echo "ERROR: Missing $$INITBB_CMD, can not create $(BUILDBOOT_XML)"; exit 10; \ | ||
308 | fi | ||
309 | 246 | ||
310 | # **************************************************************************** | 247 | # **************************************************************************** |
311 | # ***** Create Package DIFF XML section | 248 | # ***** Create Package DIFF XML section |