From a3afcff92485b6a696e40359a7d0300d4661e9c1 Mon Sep 17 00:00:00 2001 From: Lars Thorsen Date: Fri, 13 May 2016 08:04:51 +0200 Subject: Make it possible to run xmllint target in system documentation --- lib/erl_docgen/priv/dtd/common.dtd | 5 +++-- lib/erl_docgen/priv/xsl/db_html.xsl | 12 ++++++------ lib/erl_docgen/priv/xsl/db_man.xsl | 12 ++++++------ lib/erl_docgen/priv/xsl/db_pdf.xsl | 12 ++++++------ make/otp_release_targets.mk | 2 +- system/doc/system_principles/versions.xml | 4 ++-- system/doc/top/Makefile | 1 + 7 files changed, 25 insertions(+), 23 deletions(-) diff --git a/lib/erl_docgen/priv/dtd/common.dtd b/lib/erl_docgen/priv/dtd/common.dtd index 961bcd3fc2..945924fe79 100644 --- a/lib/erl_docgen/priv/dtd/common.dtd +++ b/lib/erl_docgen/priv/dtd/common.dtd @@ -12,7 +12,7 @@ limitations under the License. The Initial Developer of the Original Code is Ericsson AB. - Portions created by Ericsson are Copyright 1999-2007, Ericsson AB. + Portions created by Ericsson are Copyright 1999-2016, Ericsson AB. All Rights Reserved.'' $Id$ @@ -24,7 +24,7 @@ - @@ -40,6 +40,7 @@ + diff --git a/lib/erl_docgen/priv/xsl/db_html.xsl b/lib/erl_docgen/priv/xsl/db_html.xsl index c2d7d40446..fa5c15cfa8 100644 --- a/lib/erl_docgen/priv/xsl/db_html.xsl +++ b/lib/erl_docgen/priv/xsl/db_html.xsl @@ -989,10 +989,6 @@ - - - - @@ -1009,6 +1005,10 @@ + + + + @@ -1095,11 +1095,11 @@ - Figure +

Figure .:   - +

diff --git a/lib/erl_docgen/priv/xsl/db_man.xsl b/lib/erl_docgen/priv/xsl/db_man.xsl index f75615c105..03b6b0691d 100644 --- a/lib/erl_docgen/priv/xsl/db_man.xsl +++ b/lib/erl_docgen/priv/xsl/db_man.xsl @@ -589,12 +589,6 @@ - - \fB - - \fR\& - - \fI @@ -622,6 +616,12 @@ \fI \fR\& + + \fB + + \fR\& + + diff --git a/lib/erl_docgen/priv/xsl/db_pdf.xsl b/lib/erl_docgen/priv/xsl/db_pdf.xsl index e5e624ac4c..2f7b363b67 100644 --- a/lib/erl_docgen/priv/xsl/db_pdf.xsl +++ b/lib/erl_docgen/priv/xsl/db_pdf.xsl @@ -1180,12 +1180,6 @@ - - - - - - @@ -1208,6 +1202,12 @@ + + + + + + diff --git a/make/otp_release_targets.mk b/make/otp_release_targets.mk index e104b68991..13b54645ad 100644 --- a/make/otp_release_targets.mk +++ b/make/otp_release_targets.mk @@ -120,7 +120,7 @@ xmllint: $(XML_FILES) echo Checking $$i; \ xmllint --noout --valid --nodefdtd --loaddtd --path $(DOCGEN)/priv/dtd:$(DOCGEN)/priv/dtd_html_entities $$i; \ else\ - awk -F\" '/xi:include/ {print "echo Checking " $$2 ;print "xmllint --noout --valid --nodefdtd --loaddtd --path $(DOCGEN)/priv/dtd:$(DOCGEN)/priv/dtd_html_entities " $$2}' $$i |sh; \ + awk -F\" '/xi:include/ {print "echo Checking " $$2 ;print "xmllint --noout --valid --nodefdtd --loaddtd --path $(DOCGEN)/priv/dtd:$(DOCGEN)/priv/dtd_html_entities:$(XMLLINT_SRCDIRS) " $$2}' $$i |sh; \ fi \ done diff --git a/system/doc/system_principles/versions.xml b/system/doc/system_principles/versions.xml index 3772d773fc..b9f7fa4bf6 100644 --- a/system/doc/system_principles/versions.xml +++ b/system/doc/system_principles/versions.xml @@ -57,11 +57,11 @@

In an OTP source code tree, the OTP version can be read from the text file <OTP source root>/OTP_VERSION. The absolute path to the file can be constructed by calling - filename:join([code:root_dir(), "OTP_VERSION"]).

+ filename:join([code:root_dir(), "OTP_VERSION"]).

In an installed OTP development system, the OTP version can be read from the text file <OTP installation root>/releases/<OTP release number>/OTP_VERSION. The absolute path to the file can by constructed by calling - filename:join([code:root_dir(), "releases", erlang:system_info(otp_release), "OTP_VERSION"]).

+ filename:join([code:root_dir(), "releases", erlang:system_info(otp_release), "OTP_VERSION"]).

If the version read from the OTP_VERSION file in a development system has a ** suffix, the system has been patched using the diff --git a/system/doc/top/Makefile b/system/doc/top/Makefile index caae19a8d1..6aa9d8d340 100644 --- a/system/doc/top/Makefile +++ b/system/doc/top/Makefile @@ -74,6 +74,7 @@ XML_FILES = \ BOOK_FILES = book.xml +XMLLINT_SRCDIRS= ../installation_guide:../system_principles:../embedded:../getting_started:../reference_manual:../programming_examples:../efficiency_guide:../tutorial:../design_principles:../oam HTMLDIR= ../html PDFREFDIR= pdf -- cgit v1.2.3 From 50f0293a843872b7982ad7631ac07fa652f4d16c Mon Sep 17 00:00:00 2001 From: Lars Thorsen Date: Fri, 13 May 2016 14:29:14 +0200 Subject: [erl_docgen] Add new formatting for header level 4 and below --- lib/erl_docgen/priv/xsl/db_html.xsl | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/lib/erl_docgen/priv/xsl/db_html.xsl b/lib/erl_docgen/priv/xsl/db_html.xsl index fa5c15cfa8..c7fdabfcf1 100644 --- a/lib/erl_docgen/priv/xsl/db_html.xsl +++ b/lib/erl_docgen/priv/xsl/db_html.xsl @@ -829,7 +829,7 @@ - + @@ -842,6 +842,19 @@ + + + + +

+ + +
+ + + + + @@ -873,7 +886,6 @@ -
    -- cgit v1.2.3 From 3664cd6ae6671c04217070e3c5e9d5938e0423bf Mon Sep 17 00:00:00 2001 From: Lars Thorsen Date: Tue, 17 May 2016 08:40:03 +0200 Subject: Correct usage of marker tag --- system/doc/design_principles/sup_princ.xml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/system/doc/design_principles/sup_princ.xml b/system/doc/design_principles/sup_princ.xml index a77b3964fc..0a24e97950 100644 --- a/system/doc/design_principles/sup_princ.xml +++ b/system/doc/design_principles/sup_princ.xml @@ -80,8 +80,8 @@ init(_Args) ->
    - Supervisor Flags + Supervisor Flags

    This is the type definition for the supervisor flags:

    strategy(), % optional @@ -106,9 +106,8 @@ sup_flags() = #{strategy => strategy(), % optional
    - + Restart Strategy -

    The restart strategy is specified by the strategy key in the supervisor flags map returned by the callback function init:

    -- cgit v1.2.3 From edec337e3c4361d87efdd48bcfe10ac382a7837c Mon Sep 17 00:00:00 2001 From: Lars Thorsen Date: Tue, 17 May 2016 08:41:19 +0200 Subject: [erl_docgen] Correct the handling of marker tags Corrected how the generated html anchor is placed so the section title is visible after jump to the anchor. --- lib/erl_docgen/priv/xsl/db_html.xsl | 60 ++++++++++++++++++++++--------------- 1 file changed, 36 insertions(+), 24 deletions(-) diff --git a/lib/erl_docgen/priv/xsl/db_html.xsl b/lib/erl_docgen/priv/xsl/db_html.xsl index c7fdabfcf1..57913e7168 100644 --- a/lib/erl_docgen/priv/xsl/db_html.xsl +++ b/lib/erl_docgen/priv/xsl/db_html.xsl @@ -785,39 +785,36 @@ - - - - + + + - + - + - - - - - - - - - - + + + + + - +

    + + + .  @@ -829,11 +826,14 @@ - +

    + + +

    @@ -842,11 +842,14 @@     - +
    + + +
    @@ -1298,9 +1301,7 @@ ref_man - -     @@ -2097,16 +2098,27 @@ -     - - + + + + + + + + + + + + + + diff --git a/lib/erl_docgen/priv/xsl/db_html.xsl b/lib/erl_docgen/priv/xsl/db_html.xsl index 57913e7168..2f8fb05da6 100644 --- a/lib/erl_docgen/priv/xsl/db_html.xsl +++ b/lib/erl_docgen/priv/xsl/db_html.xsl @@ -996,6 +996,18 @@ + + + +
    +

    + + + +

    +
    +     +

    diff --git a/lib/erl_docgen/priv/xsl/db_pdf.xsl b/lib/erl_docgen/priv/xsl/db_pdf.xsl index 2f7b363b67..99263847fb 100644 --- a/lib/erl_docgen/priv/xsl/db_pdf.xsl +++ b/lib/erl_docgen/priv/xsl/db_pdf.xsl @@ -1171,6 +1171,16 @@ + + + + + + + + + + @@ -1181,7 +1191,7 @@ - + @@ -1197,7 +1207,7 @@ - + -- cgit v1.2.3 From ac4db4074d33ecb86f433e032b8bcfc7883e8f36 Mon Sep 17 00:00:00 2001 From: Lars Thorsen Date: Wed, 25 May 2016 14:42:45 +0200 Subject: Remove usage of non dtd defined tag () --- system/doc/system_principles/create_target.xmlsrc | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/system/doc/system_principles/create_target.xmlsrc b/system/doc/system_principles/create_target.xmlsrc index 8a463076f5..f9b27ffc35 100644 --- a/system/doc/system_principles/create_target.xmlsrc +++ b/system/doc/system_principles/create_target.xmlsrc @@ -374,10 +374,10 @@ os> /usr/local/erl-target/bin/to_erl /tmp/erlang.pipe.1 

     2> release_handler:install_release(Vsn).
-{continue_after_restart,"FIRST",[]}
+{continue_after_restart,"FIRST",[]}
 heart: Tue Apr  1 12:15:10 2014: Erlang has closed.
 heart: Tue Apr  1 12:15:11 2014: Executed "/usr/local/erl-target/bin/start /usr/local/erl-target/releases/new_start_erl.data" -> 0. Terminating.
-[End]
    +[End]

    The above return value and output after the call to release_handler:install_release/1 means that the @@ -398,12 +398,12 @@ os> /usr/local/erl-target/bin/to_erl /tmp/erlang.pipe.2 

     1> release_handler:which_releases().
-[{"MYSYSTEM","SECOND",
+[{"MYSYSTEM","SECOND",
   ["kernel-3.0","stdlib-2.0","sasl-2.4","pea-2.0"],
   current},
  {"MYSYSTEM","FIRST",
   ["kernel-2.16.4","stdlib-1.19.4","sasl-2.3.4","pea-1.0"],
-  permanent}]
    + permanent}]

    Our new release, "SECOND", is now the current release, but we can also see that our "FIRST" release is still permanent. This @@ -420,12 +420,12 @@ os> /usr/local/erl-target/bin/to_erl /tmp/erlang.pipe.2 

     3> release_handler:which_releases().
-[{"MYSYSTEM","SECOND",
+[{"MYSYSTEM","SECOND",
   ["kernel-3.0","stdlib-2.0","sasl-2.4","pea-2.0"],
   permanent},
  {"MYSYSTEM","FIRST",
   ["kernel-2.16.4","stdlib-1.19.4","sasl-2.3.4","pea-1.0"],
-  old}]
    + old}]

    We see that the new release version is permanent, so it would be safe to restart the node.

    -- cgit v1.2.3 From bd52bd5e8082f358b84694ef45a8f44358d1a35c Mon Sep 17 00:00:00 2001 From: Lars Thorsen Date: Mon, 30 May 2016 10:27:50 +0200 Subject: [erl_docgen] Fix anchor bug for sections in ref manuals --- lib/erl_docgen/priv/xsl/db_html.xsl | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/erl_docgen/priv/xsl/db_html.xsl b/lib/erl_docgen/priv/xsl/db_html.xsl index 2f8fb05da6..89f743a90b 100644 --- a/lib/erl_docgen/priv/xsl/db_html.xsl +++ b/lib/erl_docgen/priv/xsl/db_html.xsl @@ -862,6 +862,9 @@

    + + + -- cgit v1.2.3