diff options
author | Lars Thorsen <lars@erlang.org> | 2013-01-21 15:01:58 +0100 |
---|---|---|
committer | Lars Thorsen <lars@erlang.org> | 2013-01-21 15:01:58 +0100 |
commit | bb65d760aa2281c4a7bb216ec1c858813869759d (patch) | |
tree | a861d3632bd29106f9f2fe2f7dcd0f2de7ee8020 | |
parent | 043da0de9576732671fb61f560070932024dde87 (diff) | |
parent | fdd89ea15130484cb29c27b18b22c8835108f20f (diff) | |
download | otp-bb65d760aa2281c4a7bb216ec1c858813869759d.tar.gz otp-bb65d760aa2281c4a7bb216ec1c858813869759d.tar.bz2 otp-bb65d760aa2281c4a7bb216ec1c858813869759d.zip |
Merge branch 'lars/erl_docgen/indenterings-bug/OTP-10725'
* lars/erl_docgen/indenterings-bug/OTP-10725:
[erl_docgen] Fix include path to xmllint
[erl_docgen] Update vsn.mk
[erl_docgen] Add xmllint target for the documentation and fix some DTD errors
[erl_docgen] Fix dtd error for type_desc tag
[erl_docgen] Fix pdf indentation bug for tagged lists
-rw-r--r-- | erts/configure.in | 6 | ||||
-rw-r--r-- | lib/erl_docgen/priv/dtd/common.refs.dtd | 7 | ||||
-rw-r--r-- | lib/erl_docgen/priv/dtd/erlref.dtd | 3 | ||||
-rw-r--r-- | lib/erl_docgen/priv/xsl/db_pdf.xsl | 12 | ||||
-rw-r--r-- | lib/erl_docgen/vsn.mk | 3 | ||||
-rw-r--r-- | make/otp.mk.in | 1 | ||||
-rw-r--r-- | make/otp_release_targets.mk | 3 |
7 files changed, 26 insertions, 9 deletions
diff --git a/erts/configure.in b/erts/configure.in index 30bc1ef000..a0c5cab181 100644 --- a/erts/configure.in +++ b/erts/configure.in @@ -827,6 +827,12 @@ if test -z "$FOP"; then AC_MSG_WARN([No 'fop' command found: going to generate placeholder PDF files]) fi +AC_CHECK_PROGS(XMLLINT, xmllint) +if test -z "$XMLLINT"; then + echo "xmllint" >> doc/CONF_INFO + AC_MSG_WARN([No 'xmllint' command found: can't run the xmllint target for the documentation]) +fi + dnl dnl We can live with Solaris /usr/ucb/install dnl diff --git a/lib/erl_docgen/priv/dtd/common.refs.dtd b/lib/erl_docgen/priv/dtd/common.refs.dtd index c1237766e1..93592607df 100644 --- a/lib/erl_docgen/priv/dtd/common.refs.dtd +++ b/lib/erl_docgen/priv/dtd/common.refs.dtd @@ -26,10 +26,12 @@ <!ELEMENT description (%block;|quote|br|marker|warning|note)* > <!ELEMENT funcs (func)+ > -<!ELEMENT func (name+,type_desc+,fsummary,type?,desc?) > +<!ELEMENT func (name+,type_desc*,fsummary,type?,desc?) > <!-- ELEMENT name is defined in each ref dtd --> <!ELEMENT fsummary (#PCDATA|c|em)* > -<!ELEMENT type (v,d?)+ > +<!ELEMENT type (v,d?)* > +<!ATTLIST type variable CDATA #IMPLIED + name_i CDATA #IMPLIED> <!ELEMENT v (#PCDATA) > <!ELEMENT d (#PCDATA|c|em)* > <!ELEMENT desc (%block;|quote|br|marker|warning|note|anno)* > @@ -41,3 +43,4 @@ <!ELEMENT datatypes (datatype)+ > <!ELEMENT datatype (name+,desc?) > <!ELEMENT type_desc (#PCDATA) > +<!ATTLIST type_desc variable CDATA #REQUIRED> diff --git a/lib/erl_docgen/priv/dtd/erlref.dtd b/lib/erl_docgen/priv/dtd/erlref.dtd index 9905086ff4..0cc5cfa06d 100644 --- a/lib/erl_docgen/priv/dtd/erlref.dtd +++ b/lib/erl_docgen/priv/dtd/erlref.dtd @@ -29,3 +29,6 @@ <!-- `name' is used in common.refs.dtd and must therefore be defined in each *ref. dtd --> <!ELEMENT name (#PCDATA) > +<!ATTLIST name name CDATA #IMPLIED + arity CDATA #IMPLIED + clause_i CDATA #IMPLIED> diff --git a/lib/erl_docgen/priv/xsl/db_pdf.xsl b/lib/erl_docgen/priv/xsl/db_pdf.xsl index 7de5af2a49..c846bdbf34 100644 --- a/lib/erl_docgen/priv/xsl/db_pdf.xsl +++ b/lib/erl_docgen/priv/xsl/db_pdf.xsl @@ -1102,11 +1102,13 @@ <xsl:template match="taglist/item"> <xsl:param name="partnum"/> - <fo:block xsl:use-attribute-sets="tagitem"> - <xsl:apply-templates> - <xsl:with-param name="partnum" select="$partnum"/> - </xsl:apply-templates> - </fo:block> + <fo:block-container> + <fo:block xsl:use-attribute-sets="tagitem"> + <xsl:apply-templates> + <xsl:with-param name="partnum" select="$partnum"/> + </xsl:apply-templates> + </fo:block> + </fo:block-container> </xsl:template> diff --git a/lib/erl_docgen/vsn.mk b/lib/erl_docgen/vsn.mk index 2599dc0ff7..a2262198dc 100644 --- a/lib/erl_docgen/vsn.mk +++ b/lib/erl_docgen/vsn.mk @@ -1,2 +1 @@ -ERL_DOCGEN_VSN = 0.3.3 - +ERL_DOCGEN_VSN = 0.3.4 diff --git a/make/otp.mk.in b/make/otp.mk.in index 0e58a27016..fca9cf3cff 100644 --- a/make/otp.mk.in +++ b/make/otp.mk.in @@ -255,6 +255,7 @@ DEFAULT_GIF_FILES = $(HTMLDIR)/min_head.gif # XSLTPROC = @XSLTPROC@ FOP = @FOP@ +XMLLINT = @XMLLINT@ DOCGEN=$(ERL_TOP)/lib/erl_docgen FOP_CONFIG = $(DOCGEN)/priv/fop.xconf diff --git a/make/otp_release_targets.mk b/make/otp_release_targets.mk index 0be0a2de56..65a2e62979 100644 --- a/make/otp_release_targets.mk +++ b/make/otp_release_targets.mk @@ -106,6 +106,9 @@ $(HTMLDIR)/$(APPLICATION).eix: $(XML_FILES) $(SPECS_FILES) docs: $(HTMLDIR)/$(APPLICATION).eix +xmllint: $(XML_FILES) + $(XMLLINT) --noout --valid --nodefdtd --loaddtd --path $(DOCGEN)/priv/dtd:$(DOCGEN)/priv/dtd_html_entities $(XML_FILES) + # ---------------------------------------------------- # Local documentation target for testing # ---------------------------------------------------- |