Fri Dec 2 22:54:36 PST 2005
- Previous message: [Slony1-commit] By cbbrowne: Change references to pgbench to refer to &pgbench; to have
- Next message: [Slony1-commit] By cbbrowne: Fix some issues with tagging of new ENTITYs in slony.sgml
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
Log Message:
-----------
Revise man.sgml / slony.sgml to have a set of ENTITY values defined
so as to allow man.sgml to omit all references to the schema document.
In man.sgml, references to schema objects are turned into simple
literals (or <function> entities). In slony.sgml, those references
have the 'more sophisticated' references to objects in schemadoc.xml
The point here is to have man.sgml be a feasible totally-valid SGML
document that we can use to generate manual pages.
Modified Files:
--------------
slony1-engine/doc/adminguide:
locking.sgml (r1.3 -> r1.4)
man.sgml (r1.1 -> r1.2)
slon.sgml (r1.18 -> r1.19)
slonik_ref.sgml (r1.33 -> r1.34)
slony.sgml (r1.23 -> r1.24)
-------------- next part --------------
Index: slon.sgml
===================================================================
RCS file: /usr/local/cvsroot/slony1/slony1-engine/doc/adminguide/slon.sgml,v
retrieving revision 1.18
retrieving revision 1.19
diff -Ldoc/adminguide/slon.sgml -Ldoc/adminguide/slon.sgml -u -w -r1.18 -r1.19
--- doc/adminguide/slon.sgml
+++ doc/adminguide/slon.sgml
@@ -298,7 +298,7 @@
<para>
<envar>archive_dir</envar> indicates a directory in which to
place a sequence of <command>SYNC</command> archive files for
- use in <link linkend="logshipping"> log shipping</link> mode.
+ use in &logship; mode.
</para>
</listitem>
</varlistentry>
Index: man.sgml
===================================================================
RCS file: /usr/local/cvsroot/slony1/slony1-engine/doc/adminguide/man.sgml,v
retrieving revision 1.1
retrieving revision 1.2
diff -Ldoc/adminguide/man.sgml -Ldoc/adminguide/man.sgml -u -w -r1.1 -r1.2
--- doc/adminguide/man.sgml
+++ doc/adminguide/man.sgml
@@ -9,6 +9,40 @@
<!ENTITY slony1 "<PRODUCTNAME>Slony-I</PRODUCTNAME>">
<!ENTITY postgres "<PRODUCTNAME>PostgreSQL</PRODUCTNAME>">
<!ENTITY windows "<trademark>Windows</trademark>">
+ <!ENTITY logship "log shipping">
+ <!ENTITY rlocking " locking ">
+ <!ENTITY rddlchanges "distribution documentation on DDL changes">
+ <!ENTITY rplainpaths "distribution documentation on plain paths">
+ <!ENTITY rlistenpaths "distribution documentation on listen paths">
+ <!ENTITY rmissingoids "error messages indicating missing OIDs">
+ <!ENTITY fundroplisten "<function>droplisten(integer,integer,integer)</function>">
+ <!ENTITY fundropset " <function>dropset(integer)</function>">
+ <!ENTITY funmergeset "<function>mergeset(integer,integer)</function> ">
+ <!ENTITY funsetdroptable " <function>setdroptable(integer)</function> ">
+ <!ENTITY funstorelisten " <function>storelisten(integer,integer,integer)</function> ">
+ <!ENTITY funstorepath " <function>storepath(integer,integer,text,integer)</function> ">
+ <!ENTITY funstoreset " <function>storeset(integer,text)</function>">
+ <!ENTITY funtableaddkey " <function>tableaddkey(text)</function>">
+ <!ENTITY funsetaddtable "<function>setaddtable(integer,integer,text,name,text)">
+ <!ENTITY funsetaddsequence "<function>setaddsequence(integer,integer,text,text)">
+ <!ENTITY funsetdropsequence "<function>setdropsequence(integer)">
+ <!ENTITY funsetmovetable "<function>setmovetable(integer,integer)">
+ <!ENTITY funddlscript "<function>ddlscript(integer,text,integer)</function>">
+ <!ENTITY fundropnode "<function>dropnode(integer)</function>">
+ <!ENTITY funenablenode "<function>enablenode(integer)</function>">
+ <!ENTITY fundroptrigger "<function>droptrigger(integer,name)</function>">
+ <!ENTITY funfailednode "<function>failednode(integer,integer)</function>">
+ <!ENTITY funinitializelocalnode "<function>initializelocalnode(integer,text)</function>">
+ <!ENTITY funlockset "<function>lockset(integer)</function>">
+ <!ENTITY funmoveset "<function>moveset(integer,integer)</function>">
+ <!ENTITY fununlockset "<function>unlockset(integer)</function>">
+ <!ENTITY fununsubscribeset "<function>unsubscribeset(integer,integer)</function>">
+ <!ENTITY fununinstallnode "<function>uninstallnode()</function>">
+ <!ENTITY funsetmovesequence "<function>setmovesequence(integer,integer)</function>">
+ <!ENTITY funstoretrigger "<function>storetrigger(integer,name)</function>">
+ <!ENTITY funsubscribeset "<function>subscribeset(integer,integer,integer,boolean)</function>">
+ <!ENTITY slnode "<envar>sl_node</envar>">
+ <!ENTITY slconfirm "<envar>sl_confirm</envar>">
]>
<book id="slony">
@@ -26,6 +60,7 @@
&slon;
&slonconf;
&slonik;
+ &slonikref;
</part>
</book>
Index: slonik_ref.sgml
===================================================================
RCS file: /usr/local/cvsroot/slony1/slony1-engine/doc/adminguide/slonik_ref.sgml,v
retrieving revision 1.33
retrieving revision 1.34
diff -Ldoc/adminguide/slonik_ref.sgml -Ldoc/adminguide/slonik_ref.sgml -u -w -r1.33 -r1.34
--- doc/adminguide/slonik_ref.sgml
+++ doc/adminguide/slonik_ref.sgml
@@ -303,7 +303,7 @@
</note>
<para> For more details on the distinction between this and <xref
- linkend="stmtstorepath">, see <xref linkend="plainpaths">.</para>
+ linkend="stmtstorepath">, see &rplainpaths;.</para>
</Refsect1>
<Refsect1><Title>Example</Title>
@@ -392,13 +392,11 @@
<refsect1>
<title>Description</title>
- <para> Initialize the first node in a new
- &slony1; replication cluster. The
- initialization process consists of creating the cluster namespace,
- loading all the base tables, functions, procedures and
- initializing the node, using <xref
- linkend="function.initializelocalnode-integer-text"> and <xref
- linkend= "function.enablenode-integer">.
+ <para> Initialize the first node in a new &slony1; replication
+ cluster. The initialization process consists of creating the
+ cluster namespace, loading all the base tables, functions,
+ procedures and initializing the node, using
+ &funinitializelocalnode; and &funenablenode;.
<variablelist>
<varlistentry><term><literal>ID</literal></term>
@@ -407,7 +405,7 @@
<varlistentry><term><literal>COMMENT = 'comment
text'</literal></term> <listitem><para> A descriptive text added
- to the node entry in the table <xref linkend="table.sl-node">.
+ to the node entry in the table &slnode;.
</para></listitem>
</varlistentry>
</variablelist>
@@ -473,15 +471,16 @@
</varlistentry>
<varlistentry><term><literal> COMMENT = 'description' </literal></term>
- <listitem><para> A descriptive text added to the node entry in the table <xref linkend="table.sl-node"></para></listitem>
+ <listitem><para> A descriptive text added to the node entry in the table &slnode;</para></listitem>
</varlistentry>
<varlistentry><term><literal> SPOOLNODE = boolean </literal></term>
<listitem><para>Specifies that the new node is a virtual spool
- node for file archiving of replication log. If true
- <application>slonik</application> will not attempt to initialize a database
- with the replication schema.</para></listitem>
+ node for file archiving of replication log. If true,
+ <application>slonik</application> will not attempt to
+ initialize a database with the replication
+ schema.</para></listitem>
</varlistentry>
<varlistentry><term><literal> EVENT NODE = ival </literal></term>
@@ -493,9 +492,7 @@
</variablelist>
</para>
- <para> This uses <xref linkend=
- "function.initializelocalnode-integer-text"> and <xref linkend=
- "function.enablenode-integer">. </para>
+ <para> This uses &funinitializelocalnode; and &funenablenode;. </para>
</Refsect1>
<Refsect1><Title>Example</Title>
@@ -536,8 +533,7 @@
</variablelist>
</para>
- <para> This uses <xref linkend=
- "function.dropnode-integer">. </para>
+ <para> This uses &fundropnode;. </para>
<para> When you invoke <command>DROP NODE</command>, one of the
steps is to run <command>UNINSTALL NODE</command>.</para>
@@ -546,8 +542,7 @@
(this is particularly common for Java application frameworks with
connection pools), the connections may cache query plans that
include the pre-<command>DROP NODE</command> state of things, and
- you will get <link linkend="missingoids"> error messages indicating
- missing OIDs</link>.</para>
+ you will get &rmissingoids;.</para>
<para>After dropping a node, you may also need to recycle
connections in your application.</para></warning>
@@ -588,7 +583,7 @@
</variablelist>
</para>
- <para> This uses <xref linkend= "function.uninstallnode">. </para>
+ <para> This uses &fununinstallnode;. </para>
<para> The difference between <command>UNINSTALL NODE</command>
and <command>DROP NODE</command> is that all <command>UNINSTALL
@@ -599,8 +594,7 @@
(this is particularly common for Java application frameworks with
connection pools), the connections may cache query plans that
include the pre-<command>UNINSTALL NODE</command> state of things,
- and you will get <link linkend="missingoids"> error messages
- indicating missing OIDs</link>.</para>
+ and you will get &rmissingoids;.</para>
<para>After dropping a node, you may also need to recycle
connections in your application.</para></warning>
@@ -708,7 +702,7 @@
</varlistentry>
</variablelist>
</para>
- <para> This uses <xref linkend= "function.storepath-integer-integer-text-integer">. </para>
+ <para> This uses &funstorepath;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -814,8 +808,8 @@
</varlistentry>
</variablelist>
- <para> This uses <xref linkend= "function.storelisten-integer-integer-integer">. </para>
- <para> For more details, see <xref linkend="listenpaths">.</para>
+ <para> This uses &funstorelisten;. </para>
+ <para> For more details, see &rlistenpaths;.</para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -856,7 +850,7 @@
</varlistentry>
</variablelist>
- <para> This uses <xref linkend= "function.droplisten-integer-integer-integer">. </para>
+ <para> This uses &fundroplisten;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -919,7 +913,7 @@
we can't see there being terribly much interest in replicating
tables that contain no application data.</para> </note>
- <para> This uses <xref linkend= "function.tableaddkey-text">. </para>
+ <para> This uses &funtableaddkey;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -978,7 +972,7 @@
</varlistentry>
</variablelist>
- <para> This uses <xref linkend= "function.storeset-integer-text">. </para>
+ <para> This uses &funstoreset;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -1023,7 +1017,7 @@
</varlistentry>
</variablelist>
- <para> This uses <xref linkend= "function.dropset-integer">. </para>
+ <para> This uses &fundropset;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -1074,7 +1068,7 @@
</varlistentry>
</variablelist>
- <para> This uses <xref linkend= "function.mergeset-integer-integer">. </para>
+ <para> This uses &funmergeset;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -1152,7 +1146,7 @@
</varlistentry>
</variablelist>
</para>
- <para> This uses <xref linkend= "function.setaddtable-integer-integer-text-name-text">. </para>
+ <para> This uses &funsetaddtable;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -1219,7 +1213,7 @@
</varlistentry>
</variablelist>
</para>
- <para> This uses <xref linkend= "function.setaddsequence-integer-integer-text-text">. </para>
+ <para> This uses &funsetaddsequence;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -1270,7 +1264,7 @@
<listitem><para> Unique ID of the table.</para></listitem></varlistentry>
</variablelist>
</para>
- <para> This uses <xref linkend= "function.setdroptable-integer">. </para>
+ <para> This uses &funsetdroptable;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -1314,7 +1308,7 @@
</varlistentry>
</variablelist>
</para>
- <para> This uses <xref linkend= "function.setdropsequence-integer">. </para>
+ <para> This uses &funsetdropsequence;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -1369,7 +1363,7 @@
<listitem><para> Unique ID of the set to which the table should be added.</para></listitem></varlistentry>
</variablelist>
</para>
- <para> This uses <xref linkend= "function.setmovetable-integer-integer">. </para>
+ <para> This uses &funsetmovetable;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -1430,7 +1424,7 @@
</varlistentry>
</variablelist>
</para>
- <para> This uses <xref linkend= "function.setmovesequence-integer-integer">. </para>
+ <para> This uses &funsetmovesequence;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -1487,7 +1481,7 @@
</varlistentry>
</variablelist>
</para>
- <para> This uses <xref linkend= "function.storetrigger-integer-name">. </para>
+ <para> This uses &funstoretrigger;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -1539,7 +1533,7 @@
</varlistentry>
</variablelist>
</para>
- <para> This uses <xref linkend= "function.droptrigger-integer-name">. </para>
+ <para> This uses &fundroptrigger;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -1635,7 +1629,7 @@
</varlistentry>
</variablelist>
</para>
- <para> This uses <xref linkend= "function.subscribeset-integer-integer-integer-boolean">. </para>
+ <para> This uses &funsubscribeset;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -1688,7 +1682,7 @@
</varlistentry>
</variablelist>
</para>
- <para> This uses <xref linkend= "function.unsubscribeset-integer-integer">. </para>
+ <para> This uses &fununsubscribeset;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -1730,9 +1724,8 @@
transaction to the same database itself since this would result in
blocking itself forever.</para>
- <para> Note that this is a <link linkend="locking"> locking
- operation, </link> which means that it can get stuck behind other
- database activity.</para>
+ <para> Note that this is a &rlocking; operation, which means that
+ it can get stuck behind other database activity.</para>
<para> The operation waits for transaction IDs to advance in order
that data is not missed on the new origin. Thus, if you have
@@ -1755,7 +1748,7 @@
</varlistentry>
</variablelist>
</para>
- <para> This uses <xref linkend= "function.lockset-integer">. </para>
+ <para> This uses &funlockset;. </para>
</Refsect1>
<Refsect1><Title>Example</Title>
<Programlisting>
@@ -1797,7 +1790,7 @@
</varlistentry>
</variablelist>
</para>
- <para> This uses <xref linkend= "function.unlockset-integer">. </para>
+ <para> This uses &fununlockset;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -1848,9 +1841,8 @@
<command>FAILOVER</command> winds up discarding the old origin
node as being corrupted.</para>
- <para> Note that this is a <link linkend="locking"> locking
- operation, </link> which means that it can get stuck behind other
- database activity.
+ <para> Note that this is a &rlocking; operation, which means that
+ it can get stuck behind other database activity.
<variablelist>
<varlistentry><term><literal> ID = ival </literal></term>
@@ -1869,7 +1861,7 @@
</varlistentry>
</variablelist>
</para>
- <para> This uses <xref linkend= "function.moveset-integer-integer">. </para>
+ <para> This uses &funmoveset;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -1938,7 +1930,7 @@
</varlistentry>
</variablelist>
- <para> This uses <xref linkend= "function.failednode-integer-integer">. </para>
+ <para> This uses &funfailednode;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -2010,11 +2002,10 @@
</varlistentry>
</variablelist>
- <para> See also the warnings in <xref linkend="ddlchanges">.</para>
+ <para> See also the warnings in &rddlchanges;.</para>
- <para> Note that this is a <link linkend="locking"> locking
- operation, </link> which means that it can get stuck behind other
- database activity.</para>
+ <para> Note that this is a &rlocking; operation, which means that
+ it can get stuck behind other database activity.</para>
<para> At the start of this event, all tables in the specified set
are unlocked via the function
@@ -2040,7 +2031,7 @@
It appears preferable to handle that sort of thing <quote>out of
band.</quote> </para>
- <para> This uses <xref linkend= "function.ddlscript-integer-text-integer">. </para>
+ <para> This uses &funddlscript;. </para>
</refsect1>
<refsect1><title>Example</title>
<programlisting>
@@ -2137,7 +2128,7 @@
</varlistentry>
<varlistentry><term><literal> WAIT ON = ival </literal></term>
- <listitem><para> The ID of the node where the <xref linkend="table.sl-confirm"> table
+ <listitem><para> The ID of the node where the &slconfirm; table
is to be checked. The default value is 1.</para></listitem>
</varlistentry>
Index: slony.sgml
===================================================================
RCS file: /usr/local/cvsroot/slony1/slony1-engine/doc/adminguide/slony.sgml,v
retrieving revision 1.23
retrieving revision 1.24
diff -Ldoc/adminguide/slony.sgml -Ldoc/adminguide/slony.sgml -u -w -r1.23 -r1.24
--- doc/adminguide/slony.sgml
+++ doc/adminguide/slony.sgml
@@ -9,6 +9,40 @@
<!ENTITY slony1 "<PRODUCTNAME>Slony-I</PRODUCTNAME>">
<!ENTITY postgres "<PRODUCTNAME>PostgreSQL</PRODUCTNAME>">
<!ENTITY windows "<trademark>Windows</trademark>">
+ <!ENTITY logship "<link linkend=\"logshipping\"> log shipping </link>">
+ <!ENTITY rlocking "<link linkend=\"locking\"> locking </link>">
+ <!ENTITY rddlchanges "<xref linkend=\"ddlchanges\">">
+ <!ENTITY fundroplisten "<xref linkend=\"function.droplisten-integer-integer-integer\">">
+ <!ENTITY fundropset "<xref linkend= \"function.dropset-integer\">">
+ <!ENTITY funmergeset "<xref linkend= \"function.mergeset-integer-integer\">">
+ <!ENTITY funsetdroptable "<xref linkend= \"function.setdroptable-integer\">">
+ <!ENTITY funstorelisten "<xref linkend= \"function.storelisten-integer-integer-integer\">">
+ <!ENTITY funstorepath "<xref linkend=\"function.storepath-integer-integer-text-integer\">">
+ <!ENTITY funstoreset "<xref linkend= \"function.storeset-integer-text\">"
+ <!ENTITY funtableaddkey "<xref linkend= \"function.tableaddkey-text\">">
+ <!ENTITY funsetaddtable "<xref linkend= \"function.setaddtable-integer-integer-text-name-text\">">
+ <!ENTITY funsetaddsequence "<xref linkend= \"function.setaddsequence-integer-integer-text-text\">">
+ <!ENTITY funsetdropsequence "<xref linkend= \"function.setdropsequence-integer\">">
+ <!ENTITY funsetmovetable "<xref linkend= \"function.setmovetable-integer-integer\">">
+<!ENTITY fundroptrigger "<xref linkend=\"function.droptrigger-integer-name\">">
+<!ENTITY funddlscript "<xref linkend=\"function.ddlscript-integer-text-integer\">">
+<!ENTITY fundropnode "<xref linkend=\"function.dropnode-integer\">">
+<!ENTITY funenablenode "<xref linkend=\"function.enablenode-integer\">">
+<!ENTITY funfailednode "<xref linkend=\"function.failednode-integer-integer\">">
+<!ENTITY funinitializelocalnode "<xref linkend=\"function.initializelocalnode-integer-text\">">
+<!ENTITY funlockset "<xref linkend=\"function.lockset-integer\">">
+<!ENTITY funmoveset "<xref linkend=\"function.moveset-integer-integer\">">
+<!ENTITY funsetmovesequence "<xref linkend=\"function.setmovesequence-integer-integer\">">
+<!ENTITY funstoretrigger "<xref linkend=\"function.storetrigger-integer-name\">">
+<!ENTITY funsubscribeset "<xref linkend=\"function.subscribeset-integer-integer-integer-boolean\">">
+<!ENTITY fununinstallnode "<xref linkend=\"function.uninstallnode\">">
+<!ENTITY fununlockset "<xref linkend=\"function.unlockset-integer\">">
+<!ENTITY fununsubscribeset "<xref linkend=\"function.unsubscribeset-integer-integer\">">
+ <!ENTITY rmissingoids "<link linkend=\"missingoids\">error messages indicating missing OIDs</link>">
+ <!ENTITY slconfirm "<xref linkend=\"table.sl-confirm\">">
+ <!ENTITY rplainpaths "<xref linkend=\"plainpaths\">">
+ <!ENTITY rlistenpaths "<xref linkend=\"listenpaths\">">
+
]>
<book id="slony">
Index: locking.sgml
===================================================================
RCS file: /usr/local/cvsroot/slony1/slony1-engine/doc/adminguide/locking.sgml,v
retrieving revision 1.3
retrieving revision 1.4
diff -Ldoc/adminguide/locking.sgml -Ldoc/adminguide/locking.sgml -u -w -r1.3 -r1.4
--- doc/adminguide/locking.sgml
+++ doc/adminguide/locking.sgml
@@ -147,11 +147,10 @@
</para>
</listitem>
-<listitem><para> The section on <link linkend="ddlchanges"> DDL
-Changes </link> suggests some additional techniques that may be
-useful, such as moving tables between replication sets in such a way
-that you minimize the set of tables that need to be
-locked. </para></listitem>
+<listitem><para> The section &rddlchanges; suggests some additional
+techniques that may be useful, such as moving tables between
+replication sets in such a way that you minimize the set of tables
+that need to be locked. </para></listitem>
</itemizedlist>
- Previous message: [Slony1-commit] By cbbrowne: Change references to pgbench to refer to &pgbench; to have
- Next message: [Slony1-commit] By cbbrowne: Fix some issues with tagging of new ENTITYs in slony.sgml
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
More information about the Slony1-commit mailing list