aboutsummaryrefslogtreecommitdiffstats
path: root/make
diff options
context:
space:
mode:
authorLars G Thorsen <[email protected]>2009-12-15 10:12:17 +0000
committerErlang/OTP <[email protected]>2009-12-15 10:12:17 +0000
commitf48453e7af9fdc5dc71824b69cfe979b173b9354 (patch)
treef16df57b4c7980d2806c7cd5a1df8673ec87a2bc /make
parent53c1f771aee097c8f2835aeb18b272ab7fb5991c (diff)
downloadotp-f48453e7af9fdc5dc71824b69cfe979b173b9354.tar.gz
otp-f48453e7af9fdc5dc71824b69cfe979b173b9354.tar.bz2
otp-f48453e7af9fdc5dc71824b69cfe979b173b9354.zip
OTP-8308 Added an xsl transform from OTP xml documentation to a file
(.eix) of erlang terms that can be read by the erldoc application. Erldoc handles the documentation search mechanism at erlang.org. Added generation of eix files to otp_release_targets.mk. Fixed a copyright date error in db_html.xsl .
Diffstat (limited to 'make')
-rw-r--r--make/otp_release_targets.mk44
-rw-r--r--make/otp_subdir.mk20
2 files changed, 41 insertions, 23 deletions
diff --git a/make/otp_release_targets.mk b/make/otp_release_targets.mk
index b6e1f4195e..2cba32e82c 100644
--- a/make/otp_release_targets.mk
+++ b/make/otp_release_targets.mk
@@ -1,24 +1,21 @@
-# ``The contents of this file are subject to the Erlang Public License,
+#
+# %CopyrightBegin%
+#
+# Copyright Ericsson AB 1997-2009. All Rights Reserved.
+#
+# The contents of this file are subject to the Erlang Public License,
# Version 1.1, (the "License"); you may not use this file except in
# compliance with the License. You should have received a copy of the
# Erlang Public License along with this software. If not, it can be
-# retrieved via the world wide web at http://www.erlang.org/.
+# retrieved online at http://www.erlang.org/.
#
# Software distributed under the License is distributed on an "AS IS"
# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
# the License for the specific language governing rights and limitations
# under the License.
#
-# The Initial Developer of the Original Code is Ericsson Utvecklings AB.
-# Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings
-# AB. All Rights Reserved.''
-#
-# $Id$
-
-# ----------------------------------------------------
-# Target for building only the files needed by the Book generation
-# ----------------------------------------------------
-#texmake: $(TEX_FILES) $(PSFIG_FILES)
+# %CopyrightEnd%
+#
# ----------------------------------------------------
# Targets for the new documentation support
@@ -48,6 +45,26 @@ $(HTMLDIR)/users_guide.html: $(XML_FILES)
-path $(DOCGEN)/priv/docbuilder_dtd -path $(DOCGEN)/priv/dtd_html_entities $(DOCGEN)/priv/xsl/db_pdf.xsl book.xml > $@
+
+# ------------------------------------------------------------------------
+# The following targets just exist in the documentation directory
+# ------------------------------------------------------------------------
+ifneq ($(XML_FILES),)
+
+# ----------------------------------------------------
+# Generation of application index data
+# ----------------------------------------------------
+$(HTMLDIR)/$(APPLICATION).eix: $(XML_FILES)
+ date=`date +"%B %e %Y"`; \
+ $(XSLTPROC) --stringparam docgen "$(DOCGEN)" \
+ --stringparam gendate "$$date" --stringparam appname "$(APPLICATION)" --stringparam appver "$(VSN)" --xinclude \
+ -path $(DOCGEN)/priv/docbuilder_dtd -path $(DOCGEN)/priv/dtd_html_entities $(DOCGEN)/priv/xsl/db_eix.xsl book.xml > $@
+
+docs: $(HTMLDIR)/$(APPLICATION).eix
+
+# ----------------------------------------------------
+# Local documentation target for testing
+# ----------------------------------------------------
local_docs: TOPDOCDIR=.
local_docs: docs
$(INSTALL) $(DOCGEN)/priv/css/otp_doc.css $(HTMLDIR)
@@ -59,6 +76,7 @@ local_docs: docs
$(DOCGEN)/priv/js/flipmenu/flip_static.gif \
$(DOCGEN)/priv/js/flipmenu/flipmenu.js $(HTMLDIR)/js/flipmenu
+endif
# ----------------------------------------------------
# Standard release target
@@ -73,6 +91,6 @@ release release_docs release_tests release_html:
else
release release_docs release_tests release_html:
- $(MAKE) $(MFLAGS) RELEASE_PATH=$(TESTROOT) $(TARGET_MAKEFILE) $@_spec
+ $(MAKE) $(MFLAGS) RELEASE_PATH=$(TESTROOT) $(TARGET_MAKEFILE) $@_spec
endif
diff --git a/make/otp_subdir.mk b/make/otp_subdir.mk
index 96b961c15d..bfbd9997a1 100644
--- a/make/otp_subdir.mk
+++ b/make/otp_subdir.mk
@@ -1,30 +1,30 @@
-# ``The contents of this file are subject to the Erlang Public License,
+#
+# %CopyrightBegin%
+#
+# Copyright Ericsson AB 1997-2009. All Rights Reserved.
+#
+# The contents of this file are subject to the Erlang Public License,
# Version 1.1, (the "License"); you may not use this file except in
# compliance with the License. You should have received a copy of the
# Erlang Public License along with this software. If not, it can be
-# retrieved via the world wide web at http://www.erlang.org/.
+# retrieved online at http://www.erlang.org/.
#
# Software distributed under the License is distributed on an "AS IS"
# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
# the License for the specific language governing rights and limitations
# under the License.
#
-# The Initial Developer of the Original Code is Ericsson Utvecklings AB.
-# Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings
-# AB. All Rights Reserved.''
-#
-# $Id$
-#
+# %CopyrightEnd%
#
# Make include file for otp
-.PHONY: debug opt release local_docs docs release_docs tests release_tests \
+.PHONY: debug opt release docs release_docs tests release_tests \
clean depend valgrind
#
# Targets that don't affect documentation directories
#
-opt debug release local_docs docs release_docs tests release_tests clean depend valgrind:
+opt debug release docs release_docs tests release_tests clean depend valgrind:
@set -e ; \
app_pwd=`pwd` ; \
if test -f vsn.mk; then \