erl_docgen: Add ghlink step for all non-generated doc xml files

In order to get line numbers into the ghlink we have to add a post
processing step for all xml files.

1 files changed, 42 insertions, 20 deletions

diff --git a/make/otp_release_targets.mk b/make/otp_release_targets.mk
index 23b4416963..9a6384af59 100644
--- a/make/otp_release_targets.mk
+++ b/make/otp_release_targets.mk
@@ -33,9 +33,20 @@ ifneq ($(wildcard $(MOD2APP)),)
 MOD2APP_PARAM = --stringparam mod2app_file "$(MOD2APP)"
 endif
 
+# -------------------------------------------------------
+# Take the XML files and add the github link info to them
+# -------------------------------------------------------
+_create_xml_dirs := $(shell mkdir -p $(XMLDIR))
+
+XML_GEN_FILES+=$(patsubst %.xml,$(XMLDIR)/%.xml,$(XML_FILES))
+$(XMLDIR)/%.xml: %.xml
+	$(gen_verbose)escript $(DOCGEN)/priv/bin/github_link.escript $^ \
+	"$(subst $(ERL_TOP)/,,$(CURDIR)/$^)" "$(shell git rev-parse HEAD)" $@
+
 ifeq ($(TOPDOC),)
-$(HTMLDIR)/index.html: $(XML_FILES) $(SPECS_FILES)
-	date=`date +"%B %e, %Y"`; \
+
+$(HTMLDIR)/index.html: $(XML_GEN_FILES) $(SPECS_FILES)
+	$(gen_verbose)date=`date +"%B %e, %Y"`; \
 	$(XSLTPROC) --noout \
           --stringparam outdir $(HTMLDIR) \
           --stringparam docgen "$(DOCGEN)" \
@@ -50,14 +61,15 @@ $(HTMLDIR)/index.html: $(XML_FILES) $(SPECS_FILES)
 	  --stringparam winprefix "$(WINPREFIX)" \
 	  --stringparam logo "$(HTMLLOGO_FILE)" \
 	  --stringparam pdfname "$(PDFNAME)" \
+          -path . \
           -path $(DOCGEN)/priv/dtd \
           -path $(DOCGEN)/priv/dtd_html_entities \
-            $(DOCGEN)/priv/xsl/db_html.xsl book.xml
+            $(DOCGEN)/priv/xsl/db_html.xsl $(XMLDIR)/book.xml
 
 endif
 
-$(HTMLDIR)/users_guide.html: $(XML_FILES)
-	date=`date +"%B %e, %Y"`; \
+$(HTMLDIR)/users_guide.html: $(XML_GEN_FILES)
+	$(gen_verbose)date=`date +"%B %e, %Y"`; \
 	$(XSLTPROC) --noout  \
 		--stringparam outdir  $(HTMLDIR)  \
 		--stringparam docgen "$(DOCGEN)"  \
@@ -72,12 +84,13 @@ $(HTMLDIR)/users_guide.html: $(XML_FILES)
 		--stringparam logo "$(HTMLLOGO_FILE)" \
 		--stringparam pdfname "$(PDFNAME)" \
 	        --xinclude  \
+		-path . \
 		-path $(DOCGEN)/priv/dtd \
 	        -path $(DOCGEN)/priv/dtd_html_entities \
-	        $(DOCGEN)/priv/xsl/db_html.xsl book.xml
+	        $(DOCGEN)/priv/xsl/db_html.xsl $(XMLDIR)/book.xml
 
-%.fo: $(XML_FILES) $(SPECS_FILES)
-	date=`date +"%B %e, %Y"`; \
+%.fo: $(XML_GEN_FILES) $(SPECS_FILES)
+	$(gen_verbose)date=`date +"%B %e, %Y"`; \
 	$(XSLTPROC) \
          --stringparam docgen "$(DOCGEN)" \
          --stringparam gendate "$$date" \
@@ -87,9 +100,10 @@ $(HTMLDIR)/users_guide.html: $(XML_FILES)
 	 --stringparam logo "$(PDFLOGO_FILE)" \
 	 --stringparam pdfcolor "$(PDFCOLOR)" \
          --xinclude $(TOP_SPECS_PARAM) \
+	 -path . \
          -path $(DOCGEN)/priv/dtd \
          -path $(DOCGEN)/priv/dtd_html_entities \
-           $(DOCGEN)/priv/xsl/db_pdf.xsl book.xml > $@
+           $(DOCGEN)/priv/xsl/db_pdf.xsl $(XMLDIR)/book.xml > $@
 
 # ------------------------------------------------------------------------
 # The following targets just exist in the documentation directory
@@ -101,16 +115,17 @@ ifneq ($(XML_FILES),)
 # ----------------------------------------------------
 # Generation of application index data
 # ----------------------------------------------------
-$(HTMLDIR)/$(APPLICATION).eix: $(XML_FILES) $(SPECS_FILES)
-	date=`date +"%B %e, %Y"`; \
+$(HTMLDIR)/$(APPLICATION).eix: $(XML_GEN_FILES) $(SPECS_FILES)
+	$(gen_verbose)date=`date +"%B %e, %Y"`; \
 	$(XSLTPROC) --stringparam docgen "$(DOCGEN)" \
 		--stringparam gendate "$$date" \
 	        --stringparam appname "$(APPLICATION)" \
 	        --stringparam appver "$(VSN)" \
 	        -xinclude $(TOP_SPECS_PARAM)  \
+	        -path . \
 		-path $(DOCGEN)/priv/dtd \
 	        -path $(DOCGEN)/priv/dtd_html_entities \
-	        $(DOCGEN)/priv/xsl/db_eix.xsl book.xml >  $@
+	        $(DOCGEN)/priv/xsl/db_eix.xsl $(XMLDIR)/book.xml >  $@
 
 docs: $(HTMLDIR)/$(APPLICATION).eix
 
@@ -118,30 +133,37 @@ docs: $(HTMLDIR)/$(APPLICATION).eix
 ## Then we look into all those files check for xi:includes
 BOOK_XI_INC_FILES:=$(foreach file,$(BOOK_FILES),$(shell awk -F\" '/xi:include/ {print $$2}' $(file))) $(BOOK_FILES)
 ALL_XI_INC_FILES:=$(foreach file,$(BOOK_XI_INC_FILES),$(shell awk -F\" '/xi:include/ {if ("$(dir $(file))" != "./") printf "$(dir $(file))"; print $$2}' $(file))) $(BOOK_XI_INC_FILES)
+ifeq ($(TOPDOC), true)
+ALL_XI_INC_GEN_FILES:=$(filter-out book.xml,$(ALL_XI_INC_FILES)) $(BOOK_FILES:%=$(XMLDIR)/%)
+else
+ALL_XI_INC_GEN_FILES:=$(ALL_XI_INC_FILES:%=$(XMLDIR)/%)
+endif
+
 
 ## These are the patterns of file names that xmllint cannot currently parse
 XI_INC_FILES:=%user_man.xml %usersguide.xml %refman.xml %ref_man.xml %part.xml %book.xml
 
 ## These are the files that we should run the xmllint on
 LINT_XI_INC_FILES := $(filter-out $(XI_INC_FILES), $(ALL_XI_INC_FILES))
+LINT_XI_INC_GEN_FILES := $(filter-out $(XI_INC_FILES), $(ALL_XI_INC_GEN_FILES))
 
 EMPTY :=
 SPACE := $(EMPTY) $(EMPTY)
 XMLLINT_SRCDIRS:=$(subst $(SPACE),:,$(sort $(foreach file,$(XML_FILES),$(dir $(file)))))
 
-xmllint: $(ALL_XI_INC_FILES)
-## We verify that the $(XML_FILES) variable in the Makefile have exactly
+xmllint: $(ALL_XI_INC_GEN_FILES)
+## We verify that the $(XML_GEN_FILES) variable in the Makefile have exactly
 ## the same files as we found out by following xi:include.
-ifneq ($(filter-out $(filter %.xml,$(XML_FILES)),$(ALL_XI_INC_FILES)),)
-	$(error "$(filter-out $(filter %.xml,$(XML_FILES)),$(ALL_XI_INC_FILES)) in $$ALL_XI_INC_FILES but not in $$XML_FILES");
+ifneq ($(filter-out $(filter %.xml,$(XML_GEN_FILES)),$(ALL_XI_INC_GEN_FILES)),)
+	$(error "$(filter-out $(filter %.xml,$(XML_GEN_FILES)),$(ALL_XI_INC_GEN_FILES)) in $$ALL_XI_INC_FILES but not in $$XML_GEN_FILES");
 endif
-ifneq ($(filter-out $(ALL_XI_INC_FILES),$(filter %.xml,$(XML_FILES))),)
-	$(error "$(filter-out $(ALL_XI_INC_FILES),$(filter %.xml,$(XML_FILES))) in $$XML_FILES but not in $$ALL_XI_INC_FILES");
+ifneq ($(filter-out $(ALL_XI_INC_GEN_FILES),$(filter %.xml,$(XML_GEN_FILES))),)
+	$(error "$(filter-out $(ALL_XI_INC_GEN_FILES),$(filter %.xml,$(XML_GEN_FILES))) in $$XML_GEN_FILES but not in $$ALL_XI_INC_FILES");
 endif
-	@echo "xmllint $(LINT_XI_INC_FILES)"
+	@echo "xmllint $(LINT_XI_INC_GEN_FILES)"
 	@xmllint --noout --valid --nodefdtd --loaddtd --path \
 	$(DOCGEN)/priv/dtd:$(DOCGEN)/priv/dtd_html_entities:$(XMLLINT_SRCDIRS) \
-	$(LINT_XI_INC_FILES)
+	$(LINT_XI_INC_GEN_FILES)
 
 # ----------------------------------------------------
 # Local documentation target for testing