Correct XML files

blackberry · Sep 26, 2011 · ee205b2 · ee205b2
1 parent 5606322
commit ee205b2
Show file tree

Hide file tree

Showing 32 changed files with 136 additions and 193 deletions.
diff --git a/erts/doc/src/erl_prim_loader.xml b/erts/doc/src/erl_prim_loader.xml
@@ -101,7 +101,7 @@
           <c><anno>Bin</anno></c> is the contents of the file as a binary.</p>
 
 	  <p>The <c><anno>Filename</anno></c> can also be a file in an archive. For example
-          <c>/otp/root/lib/mnesia-4.4.7.ez/mnesia-4.4.7/ebin/mnesia_backup.beam</c>.
+          <c>$OTPROOT/lib/</c><c>mnesia-4.4.7.ez/mnesia-4.4.7/ebin/</c><c>mnesia.beam</c>.
           See <seealso marker="kernel:code">code(3)</seealso> about archive files.</p>
       </desc>
     </func>
@@ -124,7 +124,7 @@
           the names of all the files in the directory. The names are
           not sorted.</p>
 	  <p>The <c><anno>Dir</anno></c> can also be a directory in an archive. For example
-          <c>/otp/root/lib/mnesia-4.4.7.ez/mnesia-4.4.7/ebin</c>.
+          <c>$OTPROOT/lib/</c><c>mnesia-4.4.7.ez/mnesia-4.4.7/ebin</c>.
            See <seealso marker="kernel:code">code(3)</seealso> about archive files.</p>
       </desc>
     </func>
@@ -143,7 +143,7 @@
         <p>See <seealso marker="kernel:file">file(3)</seealso> for more info about
           the record <c>file_info</c>.</p>
 	<p>The <c><anno>Filename</anno></c> can also be a file in an archive. For example
-          <c>/otp/root/lib/mnesia-4.4.7.ez/mnesia-4.4.7/ebin/mnesia_backup.beam</c>.
+          <c>$OTPROOT/lib/</c><c>mnesia-4.4.7.ez/mnesia-4.4.7/ebin/</c><c>mnesia</c>.
           See <seealso marker="kernel:code">code(3)</seealso> about archive files.</p>
       </desc>
     </func>

diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
@@ -2898,11 +2898,11 @@ os_prompt%</pre>
 	      <seealso marker="stdlib:unicode_usage">stdlib users guide
 	      </seealso> for details.</p>
 
-	      <note>The characters in the name (if given as a list)
+	      <note><p>The characters in the name (if given as a list)
 	      can only be &gt; 255 if the Erlang VM is started in
 	      Unicode file name translation mode, otherwise the name
 	      of the executable is limited to the ISO-latin-1
-	      character set.</note>
+	      character set.</p></note>
 
 	      <p>If the <c>Command</c> cannot be run, an error
 	      exception, with the posix error code as the reason, is
@@ -3015,11 +3015,11 @@ os_prompt%</pre>
 	    Unicode translation of arguments, they can be supplied as
 	    binaries in whatever encoding is deemed appropriate.</p>
 
-	      <note>The characters in the arguments (if given as a
+	      <note><p>The characters in the arguments (if given as a
 	      list of characters) can only be &gt; 255 if the Erlang
 	      VM is started in Unicode file name mode,
 	      otherwise the arguments are limited to the
-	      ISO-latin-1 character set.</note>
+	      ISO-latin-1 character set.</p></note>
 
 	    <p>If one, for any reason, wants to explicitly set the
 	    program name in the argument vector, the <c>arg0</c>

diff --git a/erts/doc/src/erts_alloc.xml b/erts/doc/src/erts_alloc.xml
@@ -4,7 +4,7 @@
 <cref>
   <header>
     <copyright>
-      <year>2002</year><year>2010</year>
+      <year>2002</year><year>2011</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -126,9 +126,8 @@
       carrier". Main multiblock carriers are never deallocated. The
       size of the main multiblock carrier is determined by the value
       of the <seealso marker="#M_mmbcs">mmbcs</seealso> parameter.</p>
-    <p>      <marker id="mseg_mbc_sizes"></marker>
-
-      Sizes of multiblock carriers allocated via <c>mseg_alloc</c> are
+    <p><marker id="mseg_mbc_sizes"></marker>Sizes of multiblock carriers
+      allocated via <c>mseg_alloc</c> are
       decided based on the values of the largest multiblock carrier
       size (<seealso marker="#M_lmbcs">lmbcs</seealso>), the smallest
       multiblock carrier size (<seealso marker="#M_smbcs">smbcs</seealso>),
@@ -157,9 +156,8 @@
     <p>Coalescing of free blocks are always performed immediately.
       Boundary tags (headers and footers) in free blocks are used
       which makes the time complexity for coalescing constant.</p>
-    <p>      <marker id="strategy"></marker>
-
-      The memory allocation strategy used for multiblock carriers by an
+    <p><marker id="strategy"></marker>The memory allocation strategy
+      used for multiblock carriers by an
       allocator is configurable via the <seealso marker="#M_as">as</seealso>
       parameter. Currently the following strategies are available:</p>
     <taglist>
@@ -445,10 +443,10 @@
        in "the <c>alloc_util</c> framework" section.</item>
       <tag><marker id="M_t"><c><![CDATA[+M<S>t true|false|<amount>]]></c></marker></tag>
       <item>
-       Multiple, thread specific instances of the allocator.
-       This option will only have any effect on the runtime system
-       with SMP support. Default behaviour on the runtime system with
-       SMP support (<c>N</c> equals the number of scheduler threads):
+        <p>Multiple, thread specific instances of the allocator.
+           This option will only have any effect on the runtime system
+           with SMP support. Default behaviour on the runtime system with
+           SMP support (<c>N</c> equals the number of scheduler threads):</p>
        <taglist>
          <tag><c>temp_alloc</c></tag>
 	 <item><c>N + 1</c> instances.</item>
@@ -459,10 +457,10 @@
 	 <c>16</c>. <c>16</c> instances when <c>N</c> is greater than
 	 <c>16</c>.</item>
        </taglist>
-       <c>temp_alloc</c> will always use <c>N + 1</c> instances when
-       this option has been enabled regardless of the amount passed.
-       Other allocators will use the same amount of instances as the
-       amount passed as long as it isn't greater than <c>N</c>.       
+       <p><c>temp_alloc</c> will always use <c>N + 1</c> instances when
+          this option has been enabled regardless of the amount passed.
+          Other allocators will use the same amount of instances as the
+          amount passed as long as it isn't greater than <c>N</c>.</p>
       </item>
     </taglist>
     <p>Currently the following flags are available for configuration of

diff --git a/lib/cosFileTransfer/doc/src/CosFileTransfer_FileTransferSession.xml b/lib/cosFileTransfer/doc/src/CosFileTransfer_FileTransferSession.xml
@@ -159,7 +159,7 @@
     </func>
     <func>
       <name>insert(FTS, SourceFile, DestinationFile, Offset) -> Return</name>
-      <fsummary>Insert the <c>SourceFile</c>into the <c>DestinationFile</c><c>Offset</c>bytes from the start of the file</fsummary>
+      <fsummary>Insert the <c>SourceFile</c>into the <c>DestinationFile</c> <c>Offset</c>bytes from the start of the file</fsummary>
       <type>
         <v>FTS = SourceFile = DestinationFile = #objref</v>
         <v>Offset = long()</v>
@@ -168,7 +168,7 @@
       <desc>
         <p>This operation behaves almost like the <c>append/3</c> operation. The 
           difference is that the <c>SourceFile</c> will be inserted into the
-          <c>DestinationFile</c><c>Offset</c> bytes from the start of the file.</p>
+          <c>DestinationFile</c> <c>Offset</c> bytes from the start of the file.</p>
         <p>Currently, it is not possible to use this operation when the target 
           object represents FTP.</p>
       </desc>

diff --git a/lib/erl_interface/doc/src/erl_format.xml b/lib/erl_interface/doc/src/erl_format.xml
@@ -4,7 +4,7 @@
 <cref>
   <header>
     <copyright>
-      <year>1996</year><year>2009</year>
+      <year>1996</year><year>2011</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -105,7 +105,7 @@ erl_format("[{name,~a},{age,~i},{data,~w}]",
           values in <c><![CDATA[Term]]></c>. </p>
         <p>If <c><![CDATA[Term]]></c> and <c><![CDATA[Pattern]]></c> can be matched, the
           function returns a non-zero value and binds any unbound
-          variables in <c><![CDATA[Pattern]]></c>. If <c><![CDATA[Term]]></c><c><![CDATA[Pattern]]></c> do
+          variables in <c><![CDATA[Pattern]]></c>. If <c><![CDATA[Term]]></c> <c><![CDATA[Pattern]]></c> do
           not match, the function returns 0. For example:</p>
         <code type="none"><![CDATA[
 ETERM *term, *pattern, *pattern2;

diff --git a/lib/kernel/doc/src/app.xml b/lib/kernel/doc/src/app.xml
@@ -4,7 +4,7 @@
 <fileref>
   <header>
     <copyright>
-      <year>1997</year><year>2009</year>
+      <year>1997</year><year>2011</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -170,7 +170,6 @@ Phases       [{Phase,PhaseArgs}]  undefined
           start phase defined by the <c>start_phases</c> key, and only
           after this extended start procedure will
           <c>application:start(Application)</c> return.</p>
-        <p></p>
         <p>Start phases may be used to synchronize startup of an
           application and its included applications. In this case,
           the <c>mod</c> key must be specified as:</p>
@@ -182,7 +181,6 @@ Phases       [{Phase,PhaseArgs}]  undefined
           for the primary application) both for the primary application
           and for each of its included application, for which the start
           phase is defined.</p>
-        <p></p>
         <p>This implies that for an included application, the set of
           start phases must be a subset of the set of phases defined
           for the primary application. Refer to <em>OTP Design Principles</em> for more information.</p>

diff --git a/lib/kernel/doc/src/code.xml b/lib/kernel/doc/src/code.xml
@@ -177,9 +177,9 @@
      archives. But the functions in <c>erl_prim_loader</c> may also be
      used by other applications to read files from archives. For
      example, the call
-     <c>erl_prim_loader:list_dir("/otp/root/lib/mnesia-4.4.7.ez/mnesia-4.4.7/examples/bench)"</c>
+     <c>erl_prim_loader:list_dir( "/otp/root/lib/mnesia-4.4.7.ez/mnesia-4.4.7/examples/bench)"</c>
      would list the contents of a directory inside an archive.
-     See <seealso marker="erts:erl_prim_loader">erl_prim_loader(3)</seealso></p>
+     See <seealso marker="erts:erl_prim_loader">erl_prim_loader(3)</seealso></p>.
 
     <p>An application archive file and a regular application directory
      may coexist. This may be useful when there is a need of having

diff --git a/lib/kernel/doc/src/disk_log.xml b/lib/kernel/doc/src/disk_log.xml
@@ -475,8 +475,7 @@
       <fsummary>Close a disk log.</fsummary>
       <type name="close_error_rsn"/>
       <desc>
-        <p>          <marker id="close_1"></marker>
-The function <c>close/1</c> closes a
+        <p><marker id="close_1"></marker>The function <c>close/1</c> closes a
           local or distributed disk log properly. An internally
           formatted log must be closed before the Erlang system is
           stopped, otherwise the log is regarded as unclosed and the

diff --git a/lib/kernel/doc/src/erl_ddll.xml b/lib/kernel/doc/src/erl_ddll.xml
@@ -989,7 +989,7 @@
                       <c>{ok, pending_driver}</c> or <c>{ok, pending_process}</c>.</p>
                   </item>
                 </taglist>
-                <p>The <c>pending_driver</c><c>MonitorOption</c> is by far
+                <p>The <c>pending_driver</c> <c>MonitorOption</c> is by far
                   the most useful and it has to be used to ensure that the
                   driver has really been unloaded and the ports closed
                   whenever the <c>kill_ports</c> option is used or the

diff --git a/lib/kernel/doc/src/file.xml b/lib/kernel/doc/src/file.xml
@@ -60,11 +60,13 @@
     converted, why the Unicode mode for file names is not default on
     systems having completely transparent file naming.</p>
 
-    <note>As of R14B01, the most basic file handling modules
-    (<c>file</c>, <c>prim_file</c>, <c>filelib</c> and
-    <c>filename</c>) accept raw file names, but the rest of OTP is not
-    guaranteed to handle them, why Unicode file naming on systems
-    where it is not default is still considered experimental.</note>
+    <note>
+      <p>As of R14B01, the most basic file handling modules
+      (<c>file</c>, <c>prim_file</c>, <c>filelib</c> and
+      <c>filename</c>) accept raw file names, but the rest of OTP is not
+      guaranteed to handle them, why Unicode file naming on systems
+      where it is not default is still considered experimental.</p>
+    </note>
 
     <p>Raw file names is a new feature in OTP R14B01, which allows the
     user to supply completely uninterpreted file names to the
@@ -249,11 +251,9 @@
           </item>
         </taglist>
         <p>Example:</p>
-        <code type="none">
-f.txt:  {person, "kalle", 25}.
+<code type="none">f.txt:  {person, "kalle", 25}.
         {person, "pelle", 30}.</code>
-        <pre>
-1> <input>file:consult("f.txt").</input>
+<pre>1> <input>file:consult("f.txt").</input>
 {ok,[{person,"kalle",25},{person,"pelle",30}]}</pre>
       </desc>
     </func>
@@ -362,7 +362,6 @@ f.txt:  {person, "kalle", 25}.
           <p>In a future release, a bad type for the
             <c><anno>Filename</anno></c> argument will probably generate
             an exception.</p>
-          <p></p>
         </warning>
       </desc>
     </func>
@@ -1523,7 +1522,6 @@ f.txt:  {person, "kalle", 25}.
           <p>In a future release, a bad type for the
             <c><anno>Dir</anno></c>
             argument will probably generate an exception.</p>
-          <p></p>
         </warning>
       </desc>
     </func>