Docs improvements - Mailing list pgsql-patches

From Teodor Sigaev
Subject Docs improvements
Date
Msg-id 45BA17B8.9080507@sigaev.ru
Whole thread Raw
Responses Re: Docs improvements  (Alvaro Herrera <alvherre@commandprompt.com>)
Re: Docs improvements  (Bruce Momjian <bruce@momjian.us>)
Re: Docs improvements  (Bruce Momjian <bruce@momjian.us>)
List pgsql-patches
1)  mvcc.sgml.patch
Update comments about installation of DocBook on FreeBSD. DocBook v4.2 is
present in ports now.

2) docguide.sgml.patch
Table of compatibility of table-lock modes. IMHO, it's useful, clear for
understanding. Text view of the table is:
     |   AS  |   RS  |   RE  |   SUE |   S   |   SRE |   E   |   AE  |
----+-------+-------+-------+-------+-------+-------+-------+-------+
AS  |   O   |   O   |   O   |   O   |   O   |   O   |   O   |   X   |
----+-------+-------+-------+-------+-------+-------+-------+-------+
RS  |   O   |   O   |   O   |   O   |   O   |   O   |   X   |   X   |
----+-------+-------+-------+-------+-------+-------+-------+-------+
RE  |   O   |   O   |   O   |   O   |   X   |   X   |   X   |   X   |
----+-------+-------+-------+-------+-------+-------+-------+-------+
SUE |   O   |   O   |   O   |   X   |   X   |   X   |   X   |   X   |
----+-------+-------+-------+-------+-------+-------+-------+-------+
S   |   O   |   O   |   X   |   X   |   O   |   X   |   X   |   X   |
----+-------+-------+-------+-------+-------+-------+-------+-------+
SRE |   O   |   O   |   X   |   X   |   X   |   X   |   X   |   X   |
----+-------+-------+-------+-------+-------+-------+-------+-------+
E   |   O   |   X   |   X   |   X   |   X   |   X   |   X   |   X   |
----+-------+-------+-------+-------+-------+-------+-------+-------+
AE  |   X   |   X   |   X   |   X   |   X   |   X   |   X   |   X   |
----+-------+-------+-------+-------+-------+-------+-------+-------+

Upper row and left column contain abbreviation of lock modes by the first
characters( AS - ACCESS SHARE )
--
Teodor Sigaev                                   E-mail: teodor@sigaev.ru
                                                    WWW: http://www.sigaev.ru/
*** mvcc.sgml.orig    Fri Jan 26 16:27:27 2007
--- mvcc.sgml    Fri Jan 26 17:49:29 2007
***************
*** 741,746 ****
--- 741,863 ----
      releases locks acquired within it.
     </para>

+     <table tocentry="1" id="table-lock-compatibility">
+      <title> Compatibility of lock modes</title>
+      <tgroup cols="9">
+       <colspec colnum="1" colwidth="1*">
+       <colspec colnum="2" colwidth="1*">
+       <colspec colnum="3" colwidth="1*">
+       <colspec colnum="4" colwidth="1*">
+       <colspec colnum="5" colwidth="1*">
+       <colspec colnum="6" colwidth="1*">
+       <colspec colnum="7" colwidth="1*">
+       <colspec colnum="8" colwidth="1*">
+       <colspec colnum="9" colwidth="1*">
+       <thead>
+        <row>
+         <entry>Modes</entry>
+         <entry>AS</entry>
+         <entry>RS</entry>
+         <entry>RE</entry>
+         <entry>SUE</entry>
+         <entry>S</entry>
+         <entry>SRE</entry>
+         <entry>E</entry>
+         <entry>AE</entry>
+        </row>
+       </thead>
+       <tbody>
+        <row>
+         <entry>AS</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">N</entry>
+        </row>
+        <row>
+         <entry>RS</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+        </row>
+        <row>
+         <entry>RE</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+        </row>
+        <row>
+         <entry>SUE</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+        </row>
+        <row>
+         <entry>S</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+        </row>
+        <row>
+         <entry>SRE</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+        </row>
+        <row>
+         <entry>E</entry>
+         <entry align="center">Y</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+        </row>
+        <row>
+         <entry>AE</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+         <entry align="center">N</entry>
+        </row>
+       </tbody>
+      </tgroup>
+     </table>
     </sect2>

     <sect2 id="locking-rows">
*** docguide.sgml.orig    Fri Jan 26 15:59:29 2007
--- docguide.sgml    Fri Jan 26 16:08:58 2007
***************
*** 212,220 ****
       <listitem>
        <para><filename>textproc/dsssl-docbook-modular</filename></para>
       </listitem>
      </itemizedlist>
-     Apparently, there is no port for the DocBook V4.2 SGML DTD
-     available right now.  You will need to install it manually.
     </para>

     <para>
--- 212,221 ----
       <listitem>
        <para><filename>textproc/dsssl-docbook-modular</filename></para>
       </listitem>
+      <listitem>
+       <para><filename>textproc/docbook-420</filename></para>
+      </listitem>
      </itemizedlist>
     </para>

     <para>
***************
*** 225,234 ****

     <para>
      It's possible that the ports do not update the main catalog file
!     in <filename>/usr/local/share/sgml/catalog</filename>.  Be sure to
!     have the following line in there:
  <programlisting>
! CATALOG "/usr/local/share/sgml/docbook/4.2/docbook.cat"
  </programlisting>
      If you do not want to edit the file you can also set the
      environment variable <envar>SGML_CATALOG_FILES</envar> to a
--- 226,238 ----

     <para>
      It's possible that the ports do not update the main catalog file
!     in <filename>/usr/local/share/sgml/catalog.ports</filename> or order
!     isn't proper .  Be sure to have the following lines in begining of file:
  <programlisting>
! CATALOG "openjade/catalog"
! CATALOG "iso8879/catalog"
! CATALOG "docbook/dsssl/modular/catalog"
! CATALOG "docbook/4.2/catalog"
  </programlisting>
      If you do not want to edit the file you can also set the
      environment variable <envar>SGML_CATALOG_FILES</envar> to a

pgsql-patches by date:

Previous
From: "Greg Sabino Mullane"
Date:
Subject: Re: pg_dump pretty_print
Next
From: Alvaro Herrera
Date:
Subject: Re: Docs improvements