From dec91697167c1b2ed5a3aa747fc2258675d294ce Mon Sep 17 00:00:00 2001 From: Thomas Lundström Date: Mon, 20 Jun 2016 14:21:00 +0200 Subject: Deleted the misplaced doc folder --- doc/Makefile | 315 ----------------------------------------------------------- 1 file changed, 315 deletions(-) delete mode 100644 doc/Makefile (limited to 'doc/Makefile') diff --git a/doc/Makefile b/doc/Makefile deleted file mode 100644 index a562a0a..0000000 --- a/doc/Makefile +++ /dev/null @@ -1,315 +0,0 @@ -#Path to this subsystem's root directory -SUBSYSROOT := $(shell pwd) - -MANIFEST_DIR = $(dir $(SUBSYSROOT)) -MANIFEST_NAME = $(lastword $(subst /, ,$(MANIFEST_DIR))) -MANIFEST_TAIL = $(word 2,$(subst -, ,$(MANIFEST_NAME))) - -# Generic docbuild.git auto-clone + s_docbuild symlink. -# Defines TMPCLONEROOT which optionally can be nondefault using BOOK_GLOBALCLONEROOT -include init.mk - -# ****************** SUPPORT FOR TARGETS *************************** -PATH_TARGETS = $(SUBSYSROOT)/s_targets -#Git repositories to be cloned -NAME_TARGETS := targets -#Path to the directory under which repos shall be cloned. -DOCBASEDIR=$(shell pwd) -REPODIR=$(DOCBASEDIR)/.. -TMPCLONEROOT_TARGETS := $(TMPCLONEROOT)/$(NAME_TARGETS) -TARGETDEFAULTXMLS := $(shell cd $(REPODIR); ls -1 */default.xml) -# URL and HASH of this manifest repository to be used by the repo tool -CURRENTHASH := $(shell git log -1 --pretty=format:%H 2>/dev/null) -CURRENTURL := $(shell git remote show origin | sed -n '/Fetch URL: /s/^.*URL: //p' 2>/dev/null) - -# ******************* AutoGenerated chapter from template and target READMEs ******* -BUILDBOOT_XML := book-enea-linux-release-info/doc/build_boot_generated.xml -BUILDBOOT_TEMPLATE := book-enea-linux-release-info/doc/build_boot_template.xml - -PKGDIFF_GEN_XML := book-enea-linux-release-info/doc/pkgdiff_generated.xml -JIRA_ISSUES_GEN_XML := book-enea-linux-release-info/doc/jiraissues_generated.xml - - -# ----------------------------------------------------- -#Path to DocBook make files and templates -DOCBOOKMAKE = $(SUBSYSROOT)/s_docbuild/docmake -DOCBOOKTEMPLATE = $(SUBSYSROOT)/s_docbuild/template - -#Path to the OLINK database including leading part of file name (will add -$(FORMAT).db) -DOCBOOKOLINKDB_BASE = $(SUBSYSROOT)/s_docbuild/olinkdb/olink-targetdb-master - -DOCBOOK_OLINKS ?= yes -DOCBOOK_FO_USEFOP ?= yes -DOCBOOK_TO_BOOKDIR ?= yes -DOCBOOK_CLEANTMP ?= yes - -#Components (books) in this subsystem -# COMPONENTS := book-enea-linux-release-info book-enea-linux-open-source -# COMPONENTS += book-enea-linux-eclipse-open-source -COMPONENTS := $(shell ls -d book-enea* ) - -# -------------------------------------------------------------- -ifeq ($(VERBOSE),yes) -VERB := -else -VERB := @ -endif -MAKEFLAGS += --no-print-directory -MAKEFLAGS += --directory $(SUBSYSROOT) -MAKEFLAGS += --no-builtin-rules --no-builting-variables - -# Skip xml validation to make it possible to include xml files with unresolved -# links from book-enea-linux-users-guide -VALIDATE = no - -# BL_LABEL is either given on make command line or using BOOK_VER or defaults to a timestamp - -# ****************************************************************** - -# Export all parameters including those on the command line -export - -.PHONY: doc books docusage init initbuild inittargets initpardoc initbuildboot dist - - -docusage: - @echo 'make docusage #Shows this help text' - @echo ' DOCBOOK_TOOLS_VERSIONS=yes #Displays DocBook tools versions in this machine' - @echo 'make doc #Builds the userdoc, does autoinit if needed' - @echo 'make dist BOOK_DIST_DIR=xx/doc #Builds all and copies results to BOOK_DIST_DIR' - @echo ' #Does not work with DOCBOOK_TO_BOOKDIR or BOOK_BUILD_DIR' - @echo ' #Currently EclipseHelp formated doc will not be in BOOK_DIST_DIR' - @echo ' # unless BOOK_DIST_ECLIPSE is set to yes' - @echo 'make init #Init all needed init* below' - @echo 'make initbuild #Init s_docbuild Docbook build system and central files' - @echo 'make inittargets #Init s_targets using repo tool Targets in this distro with poky' - @echo 'make initpardoc #Init s_docsrc_common using info from poky/' - @echo 'make initbuildboot #Init build_boot chapter from READMEs and template in release info' - @echo ' DOCBOOK_CLEANTMP=no #Option to keep temp files in doc/ and tmp/' - @echo ' BOOK_GLOBALCLONEROOT=yes #Option for all init above to clone all outside the doc directory' - @echo ' BOOK_GLOBALCLONEROOT=otherpath #Option for all init above to clone all' - @echo 'make pullbuild #git pull in s_docbuild' - @echo 'make pulltargets #git pull in s_targets. You need also initpardoc initbuildboot' - @echo 'make clean #Clean. Also clean s_* but not any external clones' - @echo '' - @echo 'Optional parameters for make doc:' - @echo ' COMP= #Component (book) to build. Book component names are book-*' - @echo ' #Default component/s:' - @echo ' $(COMPONENTS)' - @echo ' FORMAT= #One of: pdf, html, or eclipse (Default all are built)' - @echo ' BL_LABEL= #Becomes footer in book (default: from poky enea.conf MAJORMINOR)' - @echo ' DOCBOOK_TO_BOOKDIR=no #(default yes) Avoid moving result to book directory' - @echo ' # and avoid erasing common doc and tmp directories' - @echo ' BOOKFORCE=yes #Force rebuilding (ignore dependency on file times or BL_LABEL)' - @echo ' # Dependency only works if common doc directory is kept' - @echo ' BOOKCONDITION="xx;yy;.." #Include XML elements with condition any of xx or yy' - @echo ' # (if rebuilding, BOOKFORCE=yes may be needed)' - @echo ' # Empty=only default. none=none, all=everything.' - @echo ' BOOKDEFAULTCONDITION #Default conditions, if no BOOKCONDITION. Used in book-*/swcomp.mk' - @echo ' SHOW_COMMENTS=yes #For proofread. Unhide .. comments Only PDF' - @echo ' BOOKVERBOSE=yes #Verbose info building books' - @echo ' DOCBOOK_OLINKS=no #Avoid the olink database in Makefile (in book not using it)' - @echo ' DOCBOOK_OLINK_TARGETDB=only #Build a target db for this book (for links into it)' - @echo ' DOCBOOK_OLINK_TARGETDB=yes #Build a target db AND build the book' - @echo ' #Master olinkdb defined in this Makefile, one per generated format, is:' - @echo ' $(DOCBOOKOLINKDB_BASE)_*.db' - @echo ' Typical examples:' - @echo ' make doc Creates all books, all formats' - @echo ' make doc COMP=book-xxxx FORMAT=html' - @echo ' make doc COMP=book-xxxx FORMAT=pdf' - @echo ' make doc BL_LABEL="Version 1.2.3" Creates all with version in footers and front' - - @echo ' Requires docbook-xsl-1.76.1 or later, docbook-xml 4.2, svg1.1, fop-1.0 + fop-hyph.jar' - @echo ' fop + the separate fop-hyph can be found together in package "libfop-java"' - @echo ' otherwise fetch fop-hyph.jar and place in same place as fop.jar' - @echo ' Requires libxml2-2.7.8 or later, libxslt-1.1.26 or later' - @echo ' Requires java machine to run fop (creating PDF). jar for optional FORMAT=eclipse' - @echo ' Without jar, the optional EclipseHelp format can not be built' - @echo ' tools_book_standalone.mk => libxml2, libxslt, and fop (and to catalog-el.xml)' - @echo ' catalog-el.xml => svg, docbook-xml, docbook-xsl' -ifeq ($(DOCBOOK_TOOLS_VERSIONS),yes) - $(VERB)$(MAKE) -f $(DOCBOOKMAKE)/tools_book_standalone.mk book_tools_versions -endif - -# We rely on make doing these in order left to right -init: initbuild inittargets initpardoc initbuildboot initpkgdiff initissues -pullall: pullbuild pulltargets - -# If no COMP, iterate over books-* in COMPONENTS with make doc -ifeq ($(COMP),) -doc: -ifneq ($(filter book-%, $(COMPONENTS)),) - $(VERB)for comp in $(filter book-%, $(COMPONENTS)); do \ - $(MAKE) doc COMP=$$comp; \ - done -endif - -else -include $(SUBSYSROOT)/$(COMP)/swcomp.mk - -doc: books - @# -endif - -dist: doc - @echo "Copying resulting built documents to $(BOOK_DIST_DIR)" - $(VERB)if [ "$(BOOK_DIST_DIR)" = "" ]; then echo "ERROR: Missing BOOK_DIST_DIR parameter, typically shall be xxx/doc"; exit 10; fi - $(VERB)if [ ! -d "`dirname $(BOOK_DIST_DIR)`" ]; then echo "ERROR: Missing parent for BOOK_DIST_DIR"; exit 10; fi - $(VERB)if [ -f "$(BOOK_DIST_DIR)/Makefile" ]; then echo "ERROR: Wrong BOOK_DIST_DIR, contains a Makefile?"; exit 10; fi - $(VERB)if [ ! -d "$(BOOK_DIST_DIR)" ]; then mkdir -p "$(BOOK_DIST_DIR)" ; fi - $(VERB)for book in $(COMPONENTS); do \ - if ls -d $$book/book*.pdf >/dev/null 2>&1; then cp --preserve=timestamps $$book/book*.pdf "$(BOOK_DIST_DIR)" ; fi ; \ - if ls -d $$book/html >/dev/null 2>&1; then cp -r --preserve=timestamps $$book/html "$(BOOK_DIST_DIR)" ; fi ; \ - if [ "$(BOOK_DIST_ECLIPSE)" = "yes" ]; then \ - if ls -d $$book/eclipse >/dev/null 2>&1; then cp -r --preserve=timestamps $$book/eclipse "$(BOOK_DIST_DIR)" ; fi ; \ - fi ; \ - done - -# Default FORMATs -ifeq ($(FORMAT),) -FORMAT=html pdf eclipse -endif - - -books: init -# BOOKPACKAGES is defined in all book-*/swcomp.mk - $(VERB)DISTRO_VERSION_MAJOR=`egrep '"EneaLinux_DISTRO_VERSION_MAJOR"' s_docsrc_common/pardoc-distro.xml | sed 's/.*//;s/<\/phrase>.*//'` ; \ - DISTRO_VERSION_MINOR=`egrep '"EneaLinux_DISTRO_VERSION_MINOR"' s_docsrc_common/pardoc-distro.xml | sed 's/.*//;s/<\/phrase>.*//'` ; \ - BOOKVER="Profile $(MANIFEST_TAIL)-$$DISTRO_VERSION_MAJOR$$DISTRO_VERSION_MINOR" ; \ - for book in $(BOOKPACKAGES); do \ - for format in $(FORMAT); do \ - $(MAKE) -f $(DOCBOOKMAKE)/make_docbook_standalone.mk BOOK=$$book FORMAT=$$format BOOK_VER="$$BOOKVER" books || exit 10; \ - done ; \ - done -ifeq ($(DOCBOOK_TO_BOOKDIR),yes) - $(VERB)rm -rf doc tmp -else -ifeq ($(DOCBOOK_CLEANTMP),yes) -# keep only doc/pdf/book-*.pdf doc/eclipse/plugins/com.enea.doc.book-* but delete doc/eclipse/plugins/com.enea.doc.book-*/done* - $(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 -endif -endif - -# cleaninit cleans ALL tmpcommon and all s_* and generated build_boot chapter xml -clean: cleaninit cleanbuildboot cleanpkgdiff cleanissues - $(VERB)rm -rf doc tmp 2>/dev/null -ifneq ($(filter book-%, $(COMPONENTS)),) - $(VERB)for comp in $(filter book-%, $(COMPONENTS)); do \ - rm -rf $$comp/book*.pdf $$comp/html $$comp/eclipse 2>/dev/null; \ - done - $(VERB)rm -rf doc tmp 2>/dev/null -endif - - -# ****************************************************************** -# ****************** SUPPORT FOR TARGETS *************************** -inittargets: s_targets -pulltargets: - $(VERB)if [ ! -d s_targets ]; then echo "ERROR: No s_targets exists?" ; exit 10 ; fi - $(VERB)cd s_targets; for targ in *; do ( cd $targ ; git pull ) - - -# ----------------------------------------- - -# Use repo to auto-clone each target separately - VERY LARGE if there are many targets (5 targets => about 1.3 Gytes) - -s_targets: $(TMPCLONEROOT_TARGETS) - $(VERB)rm s_targets 2>/dev/null; ln -s $(TMPCLONEROOT_TARGETS) s_targets - - -$(TMPCLONEROOT_TARGETS): - $(VERB)if [ ! -d "$(TMPCLONEROOT)" ] ; then mkdir -p "$(TMPCLONEROOT)" ; fi - $(VERB)if [ ! -d $(TMPCLONEROOT_TARGETS) ]; then mkdir -p $(TMPCLONEROOT_TARGETS) ; fi - @echo "Cloning all targets using repo tool into $(TMPCLONEROOT_TARGETS)" - @echo "TARGETDEFAULTXMLS is <$(TARGETDEFAULTXMLS)>" - $(VERB)for target_default_xml in $(TARGETDEFAULTXMLS); \ - do \ - TARGDIR=$(TMPCLONEROOT_TARGETS)/`dirname $$target_default_xml` ; \ - echo "TARGDIR=<$$TARGDIR>" ; \ - if [ ! -d $$TARGDIR ]; then mkdir -p $$TARGDIR ; fi ; \ - ( cd $$TARGDIR ; \ - echo "*** Doing repo init -u $(CURRENTURL) -b $(CURRENTHASH) -m $$target_default_xml ; repo sync"; \ - repo init -u $(CURRENTURL) -b $(CURRENTHASH) -m $$target_default_xml ; repo sync ; \ - ) ; \ - done - -# **************************************************************************** -# ******************** SUPPORT FOR dynamic pardoc with added parameters ****** -# pardoc-distro can contain MAJOR.MINOR-xxxxx keeping -xxxx when replacing MINOR.MINOR from enea.conf - -PATH_DOCSRC_COMMON = $(SUBSYSROOT)/s_docsrc_common -NAME_DOCSRC_COMMON = docsrc_common -TMPCLONEROOT_DOCSRC_COMMON := $(TMPCLONEROOT)/$(NAME_DOCSRC_COMMON) -TMPPARDOC := $(TMPCLONEROOT_DOCSRC_COMMON)/pardoc-distro.xml - -initpardoc: s_docsrc_common - -cleanpardoc: - $(VERB)rm -rf $(TMPCLONEROOT_DOCSRC_COMMON) ; rm s_docsrc_common - -s_docsrc_common: $(TMPCLONEROOT_DOCSRC_COMMON) - $(VERB)rm s_docsrc_common 2>/dev/null; ln -s $(TMPCLONEROOT_DOCSRC_COMMON) s_docsrc_common - -$(TMPCLONEROOT_DOCSRC_COMMON): s_targets - $(VERB)if [ ! -d "$(TMPCLONEROOT)" ] ; then mkdir -p "$(TMPCLONEROOT)" ; fi - $(VERB)if [ ! -d $(TMPCLONEROOT_DOCSRC_COMMON) ]; then mkdir -p $(TMPCLONEROOT_DOCSRC_COMMON) ; fi - @echo "Copy and patch docsrc_common/ files to $(TMPCLONEROOT_DOCSRC_COMMON)" - $(VERB)FIRSTTARGET=`ls -1 s_targets/ | head -1`; \ - ENEACONF=s_targets/$$FIRSTTARGET/poky/meta-el-common/conf/distro/enea.conf ; \ - DISTRO_VERSION_MAJOR=`egrep '^DISTRO_VERSION_MAJOR' $$ENEACONF | sed 's/^[^"]*"//;s/".*//'` ; \ - DISTRO_VERSION_MINOR=`egrep '^DISTRO_VERSION_MINOR' $$ENEACONF | sed 's/^[^"]*"//;s/".*//'` ; \ - cat docsrc_common/pardoc-distro.xml | sed '/<\/section>/d' | \ - sed '/$(TMPPARDOC) ; \ - echo "$$DISTRO_VERSION_MAJOR" >>$(TMPPARDOC) ; \ - echo "$$DISTRO_VERSION_MINOR" >>$(TMPPARDOC) ; \ - echo "" >>$(TMPPARDOC) - -# **************************************************************************** -# ***** Create XML chapter with build/boot commands from all README files in s_targets - -initbuildboot: $(BUILDBOOT_XML) - -cleanbuildboot: - $(VERB)rm -f $(BUILDBOOT_XML) 2>/dev/null - - -$(BUILDBOOT_XML): s_targets $(BUILDBOOT_TEMPLATE) - @echo "Creating $(BUILDBOOT_XML) from READMEs" - $(VERB)INITBB_CMD=initbuildboot.sh ; \ - if [ -f "$$INITBB_CMD" ]; then \ - sh "$$INITBB_CMD" -xml $(BUILDBOOT_XML) -template $(BUILDBOOT_TEMPLATE) ; \ - else \ - echo "ERROR: Missing $$INITBB_CMD, can not create $(BUILDBOOT_XML)"; exit 10; \ - fi - -# **************************************************************************** -# ***** Create Package DIFF XML section - -initpkgdiff: $(PKGDIFF_GEN_XML) - -cleanpkgdiff: - $(VERB)rm -f $(PKGDIFF_GEN_XML) 2>/dev/null - -$(PKGDIFF_GEN_XML): - $(VERB)PREVIOUS_BL=`egrep '"prev_baseline"' docsrc_common/pardoc-distro.xml | sed 's/^.*//;s/<\/phrase>.*$$//'` ; \ - echo "Generating $(PKGDIFF_GEN_XML) compared to $$PREVIOUS_BL, using gen_pkgdiff.py" ; \ - python gen_pkgdiff.py >$(PKGDIFF_GEN_XML) - - -# **************************************************************************** -# ***** Create Jira Issues XML section for the known bugs chapter - -.PHONY: $(JIRA_ISSUES_GEN_XML) -# We want new issue list to be generated also at build, not only at init - -initissues: $(JIRA_ISSUES_GEN_XML) - -cleanissues: - $(VERB)rm -f $(JIRA_ISSUES_GEN_XML) 2>/dev/null - -$(JIRA_ISSUES_GEN_XML): - @echo "Generating $(JIRA_ISSUES_GEN_XML), fetching from Jira using gen_known_issues.py" - $(VERB)python gen_known_issues.py >$(JIRA_ISSUES_GEN_XML) - -# **************************************************************************** -- cgit v1.2.3-54-g00ecf