diff options
author | Lars Thorsen <[email protected]> | 2010-09-28 09:46:32 +0200 |
---|---|---|
committer | Lars Thorsen <[email protected]> | 2010-12-01 12:10:51 +0100 |
commit | f11f263bade1738009d6aa8678b4ae381d2d47df (patch) | |
tree | 4700752e882c76cba1fd5029fbc3cecb07bc58fb | |
parent | 9c37a5e56076c85e583848b02400e900a279ac5b (diff) | |
download | otp-f11f263bade1738009d6aa8678b4ae381d2d47df.tar.gz otp-f11f263bade1738009d6aa8678b4ae381d2d47df.tar.bz2 otp-f11f263bade1738009d6aa8678b4ae381d2d47df.zip |
Fix format_man_pages so it handles all man sections and remove warnings/errors in man pages
-rw-r--r-- | erts/etc/unix/format_man_pages | 31 | ||||
-rw-r--r-- | lib/erl_docgen/priv/dtd_man_entities/xhtml-lat1.ent | 128 | ||||
-rw-r--r-- | lib/erl_docgen/priv/xsl/db_man.xsl | 21 | ||||
-rw-r--r-- | lib/eunit/doc/src/Makefile | 2 | ||||
-rw-r--r-- | lib/eunit/src/eunit.erl | 2 | ||||
-rw-r--r-- | lib/eunit/src/eunit_surefire.erl | 2 | ||||
-rw-r--r-- | lib/inets/doc/src/ftp.xml | 2 | ||||
-rw-r--r-- | lib/xmerl/src/xmerl_scan.erl | 2 | ||||
-rw-r--r-- | lib/xmerl/src/xmerl_xpath.erl | 4 | ||||
-rw-r--r-- | lib/xmerl/src/xmerl_xsd.erl | 3 |
10 files changed, 104 insertions, 93 deletions
diff --git a/erts/etc/unix/format_man_pages b/erts/etc/unix/format_man_pages index 2c4f6eee4f..93dcdcd8fa 100644 --- a/erts/etc/unix/format_man_pages +++ b/erts/etc/unix/format_man_pages @@ -3,7 +3,7 @@ # # %CopyrightBegin% # -# Copyright Ericsson AB 1996-2009. All Rights Reserved. +# Copyright Ericsson AB 1996-2010. 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 @@ -59,34 +59,21 @@ esac # Create the 'cat' directories (probably not needed) # -cd $ERL_ROOT +cd $ERL_ROOT/man -if [ ! -d man/cat1 ] -then - mkdir man/cat1 -fi +for d in 0 1 2 3 4 5 6 7 8 9 +do + if [ ! -d cat$d ] + then + mkdir cat$d + fi -if [ ! -d man/cat3 ] -then - mkdir man/cat3 -fi - -if [ ! -d man/cat4 ] -then - mkdir man/cat4 -fi - -if [ ! -d man/cat6 ] -then - mkdir man/cat6 -fi +done # # Cleanup old formatting # -cd $ERL_ROOT/man - rm -f whatis windex # Remove old cat files diff --git a/lib/erl_docgen/priv/dtd_man_entities/xhtml-lat1.ent b/lib/erl_docgen/priv/dtd_man_entities/xhtml-lat1.ent index 3df9970a43..7a07e2c406 100644 --- a/lib/erl_docgen/priv/dtd_man_entities/xhtml-lat1.ent +++ b/lib/erl_docgen/priv/dtd_man_entities/xhtml-lat1.ent @@ -21,26 +21,26 @@ <!ENTITY sect "§"> <!-- section sign, U+00A7 ISOnum --> <!ENTITY uml "¨"> <!-- diaeresis = spacing diaeresis, U+00A8 ISOdia --> -<!ENTITY copy "©"> <!-- copyright sign, U+00A9 ISOnum --> +<!ENTITY copy "(C)"> <!-- copyright sign, U+00A9 ISOnum --> <!ENTITY ordf "ª"> <!-- feminine ordinal indicator, U+00AA ISOnum --> -<!ENTITY laquo "«"> <!-- left-pointing double angle quotation mark - = left pointing guillemet, U+00AB ISOnum --> +<!ENTITY laquo """> <!-- left-pointing double angle quotation mark + = left pointing guillemetn = " in man pages, U+00AB ISOnum --> <!ENTITY not "¬"> <!-- not sign = discretionary hyphen, U+00AC ISOnum --> -<!ENTITY shy "­"> <!-- soft hyphen = discretionary hyphen, +<!ENTITY shy ""> <!-- soft hyphen = discretionary hyphen, U+00AD ISOnum --> -<!ENTITY reg "®"> <!-- registered sign = registered trade mark sign, +<!ENTITY reg "(R)"> <!-- registered sign = registered trade mark sign, U+00AE ISOnum --> <!ENTITY macr "¯"> <!-- macron = spacing macron = overline = APL overbar, U+00AF ISOdia --> <!ENTITY deg "°"> <!-- degree sign, U+00B0 ISOnum --> -<!ENTITY plusmn "±"> <!-- plus-minus sign = plus-or-minus sign, +<!ENTITY plusmn "+/-"> <!-- plus-minus sign = plus-or-minus sign, U+00B1 ISOnum --> <!ENTITY sup2 "²"> <!-- superscript two = superscript digit two = squared, U+00B2 ISOnum --> <!ENTITY sup3 "³"> <!-- superscript three = superscript digit three = cubed, U+00B3 ISOnum --> -<!ENTITY acute "´"> <!-- acute accent = spacing acute, +<!ENTITY acute "'"> <!-- acute accent = spacing acute, U+00B4 ISOdia --> <!ENTITY micro "µ"> <!-- micro sign, U+00B5 ISOnum --> <!ENTITY para "¶"> <!-- pilcrow sign = paragraph sign, @@ -62,134 +62,134 @@ = fraction three quarters, U+00BE ISOnum --> <!ENTITY iquest "¿"> <!-- inverted question mark = turned question mark, U+00BF ISOnum --> -<!ENTITY Agrave "À"> <!-- latin capital letter A with grave +<!ENTITY Agrave "A"> <!-- latin capital letter A with grave = latin capital letter A grave, U+00C0 ISOlat1 --> -<!ENTITY Aacute "Á"> <!-- latin capital letter A with acute, +<!ENTITY Aacute "A"> <!-- latin capital letter A with acute, U+00C1 ISOlat1 --> -<!ENTITY Acirc "Â"> <!-- latin capital letter A with circumflex, +<!ENTITY Acirc "A"> <!-- latin capital letter A with circumflex, U+00C2 ISOlat1 --> -<!ENTITY Atilde "Ã"> <!-- latin capital letter A with tilde, +<!ENTITY Atilde "A"> <!-- latin capital letter A with tilde, U+00C3 ISOlat1 --> -<!ENTITY Auml "Ä"> <!-- latin capital letter A with diaeresis, +<!ENTITY Auml "A"> <!-- latin capital letter A with diaeresis, U+00C4 ISOlat1 --> -<!ENTITY Aring "Å"> <!-- latin capital letter A with ring above +<!ENTITY Aring "A"> <!-- latin capital letter A with ring above = latin capital letter A ring, U+00C5 ISOlat1 --> -<!ENTITY AElig "Æ"> <!-- latin capital letter AE +<!ENTITY AElig "AE"> <!-- latin capital letter AE = latin capital ligature AE, U+00C6 ISOlat1 --> -<!ENTITY Ccedil "Ç"> <!-- latin capital letter C with cedilla, +<!ENTITY Ccedil "C"> <!-- latin capital letter C with cedilla, U+00C7 ISOlat1 --> -<!ENTITY Egrave "È"> <!-- latin capital letter E with grave, +<!ENTITY Egrave "E"> <!-- latin capital letter E with grave, U+00C8 ISOlat1 --> -<!ENTITY Eacute "É"> <!-- latin capital letter E with acute, +<!ENTITY Eacute "E"> <!-- latin capital letter E with acute, U+00C9 ISOlat1 --> -<!ENTITY Ecirc "Ê"> <!-- latin capital letter E with circumflex, +<!ENTITY Ecirc "E"> <!-- latin capital letter E with circumflex, U+00CA ISOlat1 --> -<!ENTITY Euml "Ë"> <!-- latin capital letter E with diaeresis, +<!ENTITY Euml "E"> <!-- latin capital letter E with diaeresis, U+00CB ISOlat1 --> -<!ENTITY Igrave "Ì"> <!-- latin capital letter I with grave, +<!ENTITY Igrave "I"> <!-- latin capital letter I with grave, U+00CC ISOlat1 --> -<!ENTITY Iacute "Í"> <!-- latin capital letter I with acute, +<!ENTITY Iacute "I"> <!-- latin capital letter I with acute, U+00CD ISOlat1 --> -<!ENTITY Icirc "Î"> <!-- latin capital letter I with circumflex, +<!ENTITY Icirc "I"> <!-- latin capital letter I with circumflex, U+00CE ISOlat1 --> -<!ENTITY Iuml "Ï"> <!-- latin capital letter I with diaeresis, +<!ENTITY Iuml "I"> <!-- latin capital letter I with diaeresis, U+00CF ISOlat1 --> <!ENTITY ETH "Ð"> <!-- latin capital letter ETH, U+00D0 ISOlat1 --> -<!ENTITY Ntilde "Ñ"> <!-- latin capital letter N with tilde, +<!ENTITY Ntilde "N"> <!-- latin capital letter N with tilde, U+00D1 ISOlat1 --> -<!ENTITY Ograve "Ò"> <!-- latin capital letter O with grave, +<!ENTITY Ograve "O"> <!-- latin capital letter O with grave, U+00D2 ISOlat1 --> -<!ENTITY Oacute "Ó"> <!-- latin capital letter O with acute, +<!ENTITY Oacute "O"> <!-- latin capital letter O with acute, U+00D3 ISOlat1 --> -<!ENTITY Ocirc "Ô"> <!-- latin capital letter O with circumflex, +<!ENTITY Ocirc "O"> <!-- latin capital letter O with circumflex, U+00D4 ISOlat1 --> -<!ENTITY Otilde "Õ"> <!-- latin capital letter O with tilde, +<!ENTITY Otilde "O"> <!-- latin capital letter O with tilde, U+00D5 ISOlat1 --> -<!ENTITY Ouml "Ö"> <!-- latin capital letter O with diaeresis, +<!ENTITY Ouml "O"> <!-- latin capital letter O with diaeresis, U+00D6 ISOlat1 --> -<!ENTITY times "×"> <!-- multiplication sign, U+00D7 ISOnum --> +<!ENTITY times "x"> <!-- multiplication sign, U+00D7 ISOnum --> <!ENTITY Oslash "Ø"> <!-- latin capital letter O with stroke = latin capital letter O slash, U+00D8 ISOlat1 --> -<!ENTITY Ugrave "Ù"> <!-- latin capital letter U with grave, +<!ENTITY Ugrave "U"> <!-- latin capital letter U with grave, U+00D9 ISOlat1 --> -<!ENTITY Uacute "Ú"> <!-- latin capital letter U with acute, +<!ENTITY Uacute "U"> <!-- latin capital letter U with acute, U+00DA ISOlat1 --> -<!ENTITY Ucirc "Û"> <!-- latin capital letter U with circumflex, +<!ENTITY Ucirc "U"> <!-- latin capital letter U with circumflex, U+00DB ISOlat1 --> -<!ENTITY Uuml "Ü"> <!-- latin capital letter U with diaeresis, +<!ENTITY Uuml "U"> <!-- latin capital letter U with diaeresis, U+00DC ISOlat1 --> -<!ENTITY Yacute "Ý"> <!-- latin capital letter Y with acute, +<!ENTITY Yacute "Y"> <!-- latin capital letter Y with acute, U+00DD ISOlat1 --> <!ENTITY THORN "Þ"> <!-- latin capital letter THORN, U+00DE ISOlat1 --> <!ENTITY szlig "ß"> <!-- latin small letter sharp s = ess-zed, U+00DF ISOlat1 --> -<!ENTITY agrave "à"> <!-- latin small letter a with grave +<!ENTITY agrave "a"> <!-- latin small letter a with grave = latin small letter a grave, U+00E0 ISOlat1 --> -<!ENTITY aacute "á"> <!-- latin small letter a with acute, +<!ENTITY aacute "a"> <!-- latin small letter a with acute, U+00E1 ISOlat1 --> -<!ENTITY acirc "â"> <!-- latin small letter a with circumflex, +<!ENTITY acirc "a"> <!-- latin small letter a with circumflex, U+00E2 ISOlat1 --> -<!ENTITY atilde "ã"> <!-- latin small letter a with tilde, +<!ENTITY atilde "a"> <!-- latin small letter a with tilde, U+00E3 ISOlat1 --> -<!ENTITY auml "ä"> <!-- latin small letter a with diaeresis, +<!ENTITY auml "a"> <!-- latin small letter a with diaeresis, U+00E4 ISOlat1 --> -<!ENTITY aring "å"> <!-- latin small letter a with ring above +<!ENTITY aring "a"> <!-- latin small letter a with ring above = latin small letter a ring, U+00E5 ISOlat1 --> -<!ENTITY aelig "æ"> <!-- latin small letter ae +<!ENTITY aelig "ae"> <!-- latin small letter ae = latin small ligature ae, U+00E6 ISOlat1 --> -<!ENTITY ccedil "ç"> <!-- latin small letter c with cedilla, +<!ENTITY ccedil "c"> <!-- latin small letter c with cedilla, U+00E7 ISOlat1 --> -<!ENTITY egrave "è"> <!-- latin small letter e with grave, +<!ENTITY egrave "e"> <!-- latin small letter e with grave, U+00E8 ISOlat1 --> -<!ENTITY eacute "é"> <!-- latin small letter e with acute, +<!ENTITY eacute "e"> <!-- latin small letter e with acute, U+00E9 ISOlat1 --> -<!ENTITY ecirc "ê"> <!-- latin small letter e with circumflex, +<!ENTITY ecirc "e"> <!-- latin small letter e with circumflex, U+00EA ISOlat1 --> -<!ENTITY euml "ë"> <!-- latin small letter e with diaeresis, +<!ENTITY euml "e"> <!-- latin small letter e with diaeresis, U+00EB ISOlat1 --> -<!ENTITY igrave "ì"> <!-- latin small letter i with grave, +<!ENTITY igrave "i"> <!-- latin small letter i with grave, U+00EC ISOlat1 --> -<!ENTITY iacute "í"> <!-- latin small letter i with acute, +<!ENTITY iacute "i"> <!-- latin small letter i with acute, U+00ED ISOlat1 --> -<!ENTITY icirc "î"> <!-- latin small letter i with circumflex, +<!ENTITY icirc "i"> <!-- latin small letter i with circumflex, U+00EE ISOlat1 --> -<!ENTITY iuml "ï"> <!-- latin small letter i with diaeresis, +<!ENTITY iuml "i"> <!-- latin small letter i with diaeresis, U+00EF ISOlat1 --> <!ENTITY eth "ð"> <!-- latin small letter eth, U+00F0 ISOlat1 --> -<!ENTITY ntilde "ñ"> <!-- latin small letter n with tilde, +<!ENTITY ntilde "n"> <!-- latin small letter n with tilde, U+00F1 ISOlat1 --> -<!ENTITY ograve "ò"> <!-- latin small letter o with grave, +<!ENTITY ograve "o"> <!-- latin small letter o with grave, U+00F2 ISOlat1 --> -<!ENTITY oacute "ó"> <!-- latin small letter o with acute, +<!ENTITY oacute "o"> <!-- latin small letter o with acute, U+00F3 ISOlat1 --> -<!ENTITY ocirc "ô"> <!-- latin small letter o with circumflex, +<!ENTITY ocirc "o"> <!-- latin small letter o with circumflex, U+00F4 ISOlat1 --> -<!ENTITY otilde "õ"> <!-- latin small letter o with tilde, +<!ENTITY otilde "o"> <!-- latin small letter o with tilde, U+00F5 ISOlat1 --> -<!ENTITY ouml "ö"> <!-- latin small letter o with diaeresis, +<!ENTITY ouml "o"> <!-- latin small letter o with diaeresis, U+00F6 ISOlat1 --> <!ENTITY divide "÷"> <!-- division sign, U+00F7 ISOnum --> -<!ENTITY oslash "ø"> <!-- latin small letter o with stroke, +<!ENTITY oslash "o"> <!-- latin small letter o with stroke, = latin small letter o slash, U+00F8 ISOlat1 --> -<!ENTITY ugrave "ù"> <!-- latin small letter u with grave, +<!ENTITY ugrave "u"> <!-- latin small letter u with grave, U+00F9 ISOlat1 --> -<!ENTITY uacute "ú"> <!-- latin small letter u with acute, +<!ENTITY uacute "u"> <!-- latin small letter u with acute, U+00FA ISOlat1 --> -<!ENTITY ucirc "û"> <!-- latin small letter u with circumflex, +<!ENTITY ucirc "u"> <!-- latin small letter u with circumflex, U+00FB ISOlat1 --> -<!ENTITY uuml "ü"> <!-- latin small letter u with diaeresis, +<!ENTITY uuml "u"> <!-- latin small letter u with diaeresis, U+00FC ISOlat1 --> -<!ENTITY yacute "ý"> <!-- latin small letter y with acute, +<!ENTITY yacute "y"> <!-- latin small letter y with acute, U+00FD ISOlat1 --> <!ENTITY thorn "þ"> <!-- latin small letter thorn with, U+00FE ISOlat1 --> -<!ENTITY yuml "ÿ"> <!-- latin small letter y with diaeresis, +<!ENTITY yuml "y"> <!-- latin small letter y with diaeresis, U+00FF ISOlat1 --> diff --git a/lib/erl_docgen/priv/xsl/db_man.xsl b/lib/erl_docgen/priv/xsl/db_man.xsl index 2ed0d95c6d..2a8fb9fe3e 100644 --- a/lib/erl_docgen/priv/xsl/db_man.xsl +++ b/lib/erl_docgen/priv/xsl/db_man.xsl @@ -323,7 +323,7 @@ <xsl:template match="list"> <xsl:text> .RS 2</xsl:text> <xsl:apply-templates/> - <xsl:text> .RE</xsl:text> + <xsl:text> .RE </xsl:text> </xsl:template> <xsl:template match="list/item"> @@ -336,7 +336,7 @@ <xsl:template match="taglist"> <xsl:text> .RS 2</xsl:text> <xsl:apply-templates select="tag|item"/> - <xsl:text> .RE</xsl:text> + <xsl:text> .RE </xsl:text> </xsl:template> <xsl:template match="taglist/tag"> @@ -622,6 +622,23 @@ <xsl:text>></xsl:text> </xsl:template> + <!-- Do not noramlize any text within pre and code tags. --> + <xsl:template match="pre/text()"> + <xsl:call-template name="replace-string"> + <xsl:with-param name="text" select="." /> + <xsl:with-param name="replace" select=""\"" /> + <xsl:with-param name="with" select=""\\"" /> + </xsl:call-template> + </xsl:template> + + <xsl:template match="code/text()"> + <xsl:call-template name="replace-string"> + <xsl:with-param name="text" select="." /> + <xsl:with-param name="replace" select=""\"" /> + <xsl:with-param name="with" select=""\\"" /> + </xsl:call-template> + </xsl:template> + <!-- Replace ' by \&' ans . by \&. --> <xsl:template match="text()"> <xsl:variable name="startstring"> diff --git a/lib/eunit/doc/src/Makefile b/lib/eunit/doc/src/Makefile index 19be96d763..2cdc579275 100644 --- a/lib/eunit/doc/src/Makefile +++ b/lib/eunit/doc/src/Makefile @@ -146,7 +146,7 @@ debug opt: clean clean_docs: rm -rf $(HTMLDIR)/* rm -f $(MAN3DIR)/* - rm -f $(XML_CHAPTER_FILES) *.html + rm -f $(XML_REF3_FILES) $(XML_CHAPTER_FILES) *.html rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) rm -f errs core *~ diff --git a/lib/eunit/src/eunit.erl b/lib/eunit/src/eunit.erl index 59084a52fb..4a86a108cf 100644 --- a/lib/eunit/src/eunit.erl +++ b/lib/eunit/src/eunit.erl @@ -16,7 +16,7 @@ %% $Id: eunit.erl 339 2009-04-05 14:10:47Z rcarlsson $ %% %% @copyright 2004-2009 Micka�l R�mond, Richard Carlsson -%% @author Micka�l R�mond <[email protected]> +%% @author Mickaël Rémond <[email protected]> %% [http://www.process-one.net/] %% @author Richard Carlsson <[email protected]> %% [http://user.it.uu.se/~richardc/] diff --git a/lib/eunit/src/eunit_surefire.erl b/lib/eunit/src/eunit_surefire.erl index aeda31d251..eb994a990a 100644 --- a/lib/eunit/src/eunit_surefire.erl +++ b/lib/eunit/src/eunit_surefire.erl @@ -15,7 +15,7 @@ %% %% $Id: $ %% -%% @author Micka�l R�mond <[email protected]> +%% @author Mickaël Rémond <[email protected]> %% @copyright 2009 Micka�l R�mond, Paul Guyot %% @see eunit %% @doc Surefire reports for EUnit (Format used by Maven and Atlassian diff --git a/lib/inets/doc/src/ftp.xml b/lib/inets/doc/src/ftp.xml index 25dfe716fc..ca902d8d9d 100644 --- a/lib/inets/doc/src/ftp.xml +++ b/lib/inets/doc/src/ftp.xml @@ -107,7 +107,7 @@ <tag>{mode, Mode}</tag> <item> <marker id="mode"></marker> - <p>Mode = <c>active | passive</c> </p>> + <p>Mode = <c>active | passive</c> </p> <p>Default is <c>passive</c>. </p> </item> diff --git a/lib/xmerl/src/xmerl_scan.erl b/lib/xmerl/src/xmerl_scan.erl index e2e6f95c4a..e07d495fc7 100644 --- a/lib/xmerl/src/xmerl_scan.erl +++ b/lib/xmerl/src/xmerl_scan.erl @@ -34,7 +34,9 @@ %% See also <a href="xmerl_examples.html">tutorial</a> on customization %% functions. %% </p> +%% <p> %% Possible options are: +%% </p> %% <dl> %% <dt><code>{acc_fun, Fun}</code></dt> %% <dd>Call back function to accumulate contents of entity.</dd> diff --git a/lib/xmerl/src/xmerl_xpath.erl b/lib/xmerl/src/xmerl_xpath.erl index 182a186d2c..e654a8ef1d 100644 --- a/lib/xmerl/src/xmerl_xpath.erl +++ b/lib/xmerl/src/xmerl_xpath.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2003-2009. All Rights Reserved. +%% Copyright Ericsson AB 2003-2010. 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 @@ -57,7 +57,9 @@ %% @type option_list(). <p>Options allows to customize the behaviour of the %% XPath scanner. %% </p> +%% <p> %% Possible options are: +%% </p> %% <dl> %% <dt><code>{namespace, #xmlNamespace}</code></dt> %% <dd>Set namespace nodes, from XmlNamspace, in xmlContext</dd> diff --git a/lib/xmerl/src/xmerl_xsd.erl b/lib/xmerl/src/xmerl_xsd.erl index 1aedc9e270..c0923520c2 100644 --- a/lib/xmerl/src/xmerl_xsd.erl +++ b/lib/xmerl/src/xmerl_xsd.erl @@ -29,7 +29,9 @@ %% @type option_list(). <p>Options allow to customize the behaviour of the %% validation. %% </p> +%% <p> %% Possible options are : +%% </p> %% <dl> %% <dt><code>{tab2file,boolean()}</code></dt> %% <dd>Enables saving of abstract structure on file for debugging @@ -46,6 +48,7 @@ %% <dd>It is possible by this option to provide a state with process %% information from an earlier validation.</dd> %% </dl> +%% @end %%%------------------------------------------------------------------- -module(xmerl_xsd). |