From 3b3251cb95001be2f911e16280fd99e7dd559620 Mon Sep 17 00:00:00 2001
From: Tom Lane <tgl@sss.pgh.pa.us>
Date: Sun, 2 Dec 2007 22:33:20 +0000
Subject: [PATCH] Ensure that all <sect1> and <refentry> tags have IDs. This
is needed to ensure that the resulting webpages have predictable URLs,
instead of ever-changing numeric IDs. The new contrib docs were the biggest
offender, but some old stuff had the problem too. Also, rename a couple of
new contrib sgml files for consistency's sake.
---
doc/src/sgml/adminpack.sgml | 8 ++-
doc/src/sgml/btree-gist.sgml | 13 ++--
doc/src/sgml/contrib.sgml | 10 +--
doc/src/sgml/datetime.sgml | 4 +-
doc/src/sgml/dblink.sgml | 69 ++++++++-----------
doc/src/sgml/filelist.sgml | 10 +--
doc/src/sgml/install-win32.sgml | 6 +-
.../{buffercache.sgml => pgbuffercache.sgml} | 7 +-
...{freespacemap.sgml => pgfreespacemap.sgml} | 7 +-
doc/src/sgml/{standby.sgml => pgstandby.sgml} | 4 +-
doc/src/sgml/{trgm.sgml => pgtrgm.sgml} | 3 +-
11 files changed, 61 insertions(+), 80 deletions(-)
rename doc/src/sgml/{buffercache.sgml => pgbuffercache.sgml} (96%)
rename doc/src/sgml/{freespacemap.sgml => pgfreespacemap.sgml} (98%)
rename doc/src/sgml/{standby.sgml => pgstandby.sgml} (99%)
rename doc/src/sgml/{trgm.sgml => pgtrgm.sgml} (99%)
diff --git a/doc/src/sgml/adminpack.sgml b/doc/src/sgml/adminpack.sgml
index 10816f5c24..bdbe44b4f9 100644
--- a/doc/src/sgml/adminpack.sgml
+++ b/doc/src/sgml/adminpack.sgml
@@ -1,5 +1,10 @@
-<sect1>
+<sect1 id="adminpack">
<title>adminpack</title>
+
+ <indexterm zone="adminpack">
+ <primary>adminpack</primary>
+ </indexterm>
+
<para>
adminpack is a PostgreSQL standard module that implements a number of
support functions which pgAdmin and other administration and management tools
@@ -29,4 +34,3 @@
</sect2>
</sect1>
-
diff --git a/doc/src/sgml/btree-gist.sgml b/doc/src/sgml/btree-gist.sgml
index 4e1126e33c..c545c6ce7b 100644
--- a/doc/src/sgml/btree-gist.sgml
+++ b/doc/src/sgml/btree-gist.sgml
@@ -1,14 +1,12 @@
-<sect1>
- <!--
+<sect1 id="btree-gist">
+ <title>btree_gist</title>
+
<indexterm zone="btree-gist">
- <primary>btree-gist</primary>
+ <primary>btree_gist</primary>
</indexterm>
- -->
-
- <title>btree-gist</title>
<para>
- btree-gist is a B-Tree implementation using GiST that supports the int2, int4,
+ btree_gist is a B-Tree implementation using GiST that supports the int2, int4,
int8, float4, float8 timestamp with/without time zone, time
with/without time zone, date, interval, oid, money, macaddr, char,
varchar/text, bytea, numeric, bit, varbit and inet/cidr types.
@@ -37,4 +35,3 @@
</sect2>
</sect1>
-
diff --git a/doc/src/sgml/contrib.sgml b/doc/src/sgml/contrib.sgml
index cf4495e3b8..f077e55bb8 100644
--- a/doc/src/sgml/contrib.sgml
+++ b/doc/src/sgml/contrib.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/contrib.sgml,v 1.5 2007/12/02 21:13:34 tgl Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/contrib.sgml,v 1.6 2007/12/02 22:33:20 tgl Exp $ -->
<appendix id="contrib">
<title>Additional Supplied Modules</title>
@@ -95,13 +95,13 @@ psql -d dbname -f <replaceable>SHAREDIR</>/contrib/<replaceable>module</>.sql
&oid2name;
&pageinspect;
&pgbench;
- &buffercache;
+ &pgbuffercache;
&pgcrypto;
- &freespacemap;
+ &pgfreespacemap;
&pgrowlocks;
- &standby;
+ &pgstandby;
&pgstattuple;
- &trgm;
+ &pgtrgm;
&seg;
&sslinfo;
&tablefunc;
diff --git a/doc/src/sgml/datetime.sgml b/doc/src/sgml/datetime.sgml
index cbdb673b71..364e1411cb 100644
--- a/doc/src/sgml/datetime.sgml
+++ b/doc/src/sgml/datetime.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/datetime.sgml,v 2.56 2007/01/31 20:56:16 momjian Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/datetime.sgml,v 2.57 2007/12/02 22:33:20 tgl Exp $ -->
<appendix id="datetime-appendix">
<title>Date/Time Support</title>
@@ -20,7 +20,7 @@
dates and times.
</para>
- <sect1>
+ <sect1 id="datetime-input-rules">
<title>Date/Time Input Interpretation</title>
<para>
diff --git a/doc/src/sgml/dblink.sgml b/doc/src/sgml/dblink.sgml
index 095d600099..cccde0bbbc 100644
--- a/doc/src/sgml/dblink.sgml
+++ b/doc/src/sgml/dblink.sgml
@@ -1,14 +1,16 @@
-<!-- <reference> -->
<sect1 id="dblink">
<title>dblink</title>
+
+ <indexterm zone="dblink">
+ <primary>dblink</primary>
+ </indexterm>
+
<para>
- dblink is a contrib module which allows connections with
+ <literal>dblink</> is a module which allows connections with
other databases.
</para>
- <!-- dblink_connect -->
-
- <refentry>
+ <refentry id="CONTRIB-DBLINK-CONNECT">
<refnamediv>
<refname>dblink_connect</refname>
<refpurpose>opens a persistent connection to a remote database</refpurpose>
@@ -68,8 +70,7 @@
</refsect1>
</refentry>
- <!-- dblink_disconnect -->
- <refentry>
+ <refentry id="CONTRIB-DBLINK-DISCONNECT">
<refnamediv>
<refname>dblink_disconnect</refname>
<refpurpose>closes a persistent connection to a remote database</refpurpose>
@@ -117,8 +118,7 @@
</refsect1>
</refentry>
- <!-- dblink_open -->
- <refentry>
+ <refentry id="CONTRIB-DBLINK-OPEN">
<refnamediv>
<refname>dblink_open</refname>
<refpurpose>opens a cursor on a remote database</refpurpose>
@@ -211,8 +211,7 @@
</refsect1>
</refentry>
- <!-- dblink_fetch -->
- <refentry>
+ <refentry id="CONTRIB-DBLINK-FETCH">
<refnamediv>
<refname>dblink_fetch</refname>
<refpurpose>returns a set from an open cursor on a remote database</refpurpose>
@@ -327,8 +326,7 @@
</refsect1>
</refentry>
- <!-- dblink_close -->
- <refentry>
+ <refentry id="CONTRIB-DBLINK-CLOSE">
<refnamediv>
<refname>dblink_close</refname>
<refpurpose>closes a cursor on a remote database</refpurpose>
@@ -425,8 +423,7 @@
</refsect1>
</refentry>
- <!-- dblink_exec -->
- <refentry>
+ <refentry id="CONTRIB-DBLINK-EXEC">
<refnamediv>
<refname>dblink_exec</refname>
<refpurpose>executes an UPDATE/INSERT/DELETE on a remote database</refpurpose>
@@ -527,8 +524,7 @@
</refsect1>
</refentry>
- <!-- dblink_current_query -->
- <refentry>
+ <refentry id="CONTRIB-DBLINK-CURRENT-QUERY">
<refnamediv>
<refname>dblink_current_query</refname>
<refpurpose>returns the current query string</refpurpose>
@@ -567,8 +563,7 @@
</refsect1>
</refentry>
- <!-- dblink_get_pkey -->
- <refentry>
+ <refentry id="CONTRIB-DBLINK-GET-PKEY">
<refnamediv>
<refname>dblink_get_pkey</refname>
<refpurpose>returns the position and field names of a relation's
@@ -618,8 +613,7 @@
</refsect1>
</refentry>
- <!-- dblink_build_sql_insert -->
- <refentry>
+ <refentry id="CONTRIB-DBLINK-BUILD-SQL-INSERT">
<refnamediv>
<refname>dblink_build_sql_insert</refname>
<refpurpose>
@@ -695,8 +689,7 @@
</refsect1>
</refentry>
- <!-- dblink_build_sql_delete -->
- <refentry>
+ <refentry id="CONTRIB-DBLINK-BUILD-SQL-DELETE">
<refnamediv>
<refname>dblink_build_sql_delete</refname>
<refpurpose>builds a delete statement using supplied values for selection
@@ -770,8 +763,7 @@
</refsect1>
</refentry>
- <!-- dblink_build_sql_update -->
- <refentry>
+ <refentry id="CONTRIB-DBLINK-BUILD-SQL-UPDATE">
<refnamediv>
<refname>dblink_build_sql_update</refname>
<refpurpose>builds an update statement using a local tuple, replacing
@@ -846,8 +838,7 @@
</refsect1>
</refentry>
- <!-- dblink_get_connections -->
- <refentry>
+ <refentry id="CONTRIB-DBLINK-GET-CONNECTIONS">
<refnamediv>
<refname>dblink_get_connections</refname>
<refpurpose>returns a text array of all active named dblink connections</refpurpose>
@@ -881,8 +872,7 @@
</refsect1>
</refentry>
- <!-- dblinkd_is_busy -->
- <refentry>
+ <refentry id="CONTRIB-DBLINK-IS-BUSY">
<refnamediv>
<refname>dblink_is_busy</refname>
<refpurpose>checks to see if named connection is busy with an async query</refpurpose>
@@ -922,8 +912,7 @@
</refsect1>
</refentry>
- <!-- dblink_cancel_query -->
- <refentry>
+ <refentry id="CONTRIB-DBLINK-CANCEL-QUERY">
<refnamediv>
<refname>dblink_cancel_query</refname>
<refpurpose>cancels any active query on the named connection</refpurpose>
@@ -961,8 +950,7 @@
</refsect1>
</refentry>
- <!-- dblink_error_message -->
- <refentry>
+ <refentry id="CONTRIB-DBLINK-ERROR-MESSAGE">
<refnamediv>
<refname>dblink_error_message</refname>
<refpurpose>gets last error message on the named connection</refpurpose>
@@ -1000,8 +988,7 @@
</refsect1>
</refentry>
- <!-- dblink -->
- <refentry>
+ <refentry id="CONTRIB-DBLINK">
<refnamediv>
<refname>dblink</refname>
<refpurpose>returns a set from a remote database</refpurpose>
@@ -1146,8 +1133,7 @@
</refsect1>
</refentry>
- <!-- dblink_send_query -->
- <refentry>
+ <refentry id="CONTRIB-DBLINK-SEND-QUERY">
<refnamediv>
<refname>dblink_send_query</refname>
<refpurpose>sends an async query to a remote database</refpurpose>
@@ -1192,14 +1178,13 @@
<literal>
SELECT dblink_connect('dtest1', 'dbname=contrib_regression');
SELECT * FROM
- dblink_send_query('dtest1', 'SELECT * FROM foo WHERE f1 < 3') AS t1;
+ dblink_send_query('dtest1', 'SELECT * FROM foo WHERE f1 < 3') AS t1;
</literal>
</para>
</refsect1>
</refentry>
- <!-- dblink_get_result -->
- <refentry>
+ <refentry id="CONTRIB-DBLINK-GET-RESULT">
<refnamediv>
<refname>dblink_get_result</refname>
<refpurpose>gets an async query result</refpurpose>
@@ -1259,7 +1244,7 @@
(1 row)
contrib_regression=# SELECT * from
- contrib_regression-# dblink_send_query('dtest1', 'select * from foo where f1 < 3') as t1;
+ contrib_regression-# dblink_send_query('dtest1', 'select * from foo where f1 < 3') as t1;
t1
----
1
@@ -1279,7 +1264,7 @@
(0 rows)
contrib_regression=# SELECT * from
- dblink_send_query('dtest1', 'select * from foo where f1 < 3; select * from foo where f1 > 6') as t1;
+ dblink_send_query('dtest1', 'select * from foo where f1 < 3; select * from foo where f1 > 6') as t1;
t1
----
1
diff --git a/doc/src/sgml/filelist.sgml b/doc/src/sgml/filelist.sgml
index 1a5064660b..4c229d1984 100644
--- a/doc/src/sgml/filelist.sgml
+++ b/doc/src/sgml/filelist.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/filelist.sgml,v 1.54 2007/12/02 21:13:34 tgl Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/filelist.sgml,v 1.55 2007/12/02 22:33:20 tgl Exp $ -->
<!entity history SYSTEM "history.sgml">
<!entity info SYSTEM "info.sgml">
@@ -109,13 +109,13 @@
<!entity oid2name SYSTEM "oid2name.sgml">
<!entity pageinspect SYSTEM "pageinspect.sgml">
<!entity pgbench SYSTEM "pgbench.sgml">
-<!entity buffercache SYSTEM "buffercache.sgml">
+<!entity pgbuffercache SYSTEM "pgbuffercache.sgml">
<!entity pgcrypto SYSTEM "pgcrypto.sgml">
-<!entity freespacemap SYSTEM "freespacemap.sgml">
+<!entity pgfreespacemap SYSTEM "pgfreespacemap.sgml">
<!entity pgrowlocks SYSTEM "pgrowlocks.sgml">
-<!entity standby SYSTEM "standby.sgml">
+<!entity pgstandby SYSTEM "pgstandby.sgml">
<!entity pgstattuple SYSTEM "pgstattuple.sgml">
-<!entity trgm SYSTEM "trgm.sgml">
+<!entity pgtrgm SYSTEM "pgtrgm.sgml">
<!entity seg SYSTEM "seg.sgml">
<!entity sslinfo SYSTEM "sslinfo.sgml">
<!entity tablefunc SYSTEM "tablefunc.sgml">
diff --git a/doc/src/sgml/install-win32.sgml b/doc/src/sgml/install-win32.sgml
index a87f52d5b7..a158841747 100644
--- a/doc/src/sgml/install-win32.sgml
+++ b/doc/src/sgml/install-win32.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/install-win32.sgml,v 1.42 2007/11/28 15:42:31 petere Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/install-win32.sgml,v 1.43 2007/12/02 22:33:20 tgl Exp $ -->
<chapter id="install-win32">
<title>Installation on <productname>Windows</productname></title>
@@ -40,7 +40,7 @@
<productname>Windows 98</productname>.
</para>
- <sect1>
+ <sect1 id="install-win32-full">
<title>Building with <productname>Visual C++ 2005</productname></title>
<para>
@@ -354,7 +354,7 @@
</sect1>
- <sect1>
+ <sect1 id="install-win32-libpq">
<title>Building <application>libpq</application> with
<productname>Visual C++</productname> or
<productname>Borland C++</productname></title>
diff --git a/doc/src/sgml/buffercache.sgml b/doc/src/sgml/pgbuffercache.sgml
similarity index 96%
rename from doc/src/sgml/buffercache.sgml
rename to doc/src/sgml/pgbuffercache.sgml
index 1347c75ba3..e4ecc8f78c 100644
--- a/doc/src/sgml/buffercache.sgml
+++ b/doc/src/sgml/pgbuffercache.sgml
@@ -1,12 +1,12 @@
-<sect1 id="buffercache">
+<sect1 id="pgbuffercache">
<title>pg_buffercache</title>
- <indexterm zone="buffercache">
+ <indexterm zone="pgbuffercache">
<primary>pg_buffercache</primary>
</indexterm>
<para>
- <literal>pg_buffercache</literal> module provides the means for examining
+ The <literal>pg_buffercache</literal> module provides a means for examining
what's happening to the buffercache at any given time without having to
restart or rebuild the server with debugging code added. The intent is to
do for the buffercache what pg_locks does for locks.
@@ -118,4 +118,3 @@
</sect2>
</sect1>
-
diff --git a/doc/src/sgml/freespacemap.sgml b/doc/src/sgml/pgfreespacemap.sgml
similarity index 98%
rename from doc/src/sgml/freespacemap.sgml
rename to doc/src/sgml/pgfreespacemap.sgml
index 70b2741552..66748c3ef4 100644
--- a/doc/src/sgml/freespacemap.sgml
+++ b/doc/src/sgml/pgfreespacemap.sgml
@@ -1,12 +1,12 @@
<sect1 id="pgfreespacemap">
- <title>pgfreespacemap</title>
+ <title>pg_freespacemap</title>
<indexterm zone="pgfreespacemap">
- <primary>pgfreespacemap</primary>
+ <primary>pg_freespacemap</primary>
</indexterm>
<para>
- This modules provides the means for examining the free space map (FSM). It
+ This module provides a means for examining the free space map (FSM). It
consists of two C functions: <literal>pg_freespacemap_relations()</literal>
and <literal>pg_freespacemap_pages()</literal> that return a set
of records, plus two views <literal>pg_freespacemap_relations</literal> and
@@ -240,4 +240,3 @@ regression=# SELECT c.relname, p.relblocknumber, p.bytes
</para>
</sect2>
</sect1>
-
diff --git a/doc/src/sgml/standby.sgml b/doc/src/sgml/pgstandby.sgml
similarity index 99%
rename from doc/src/sgml/standby.sgml
rename to doc/src/sgml/pgstandby.sgml
index 120fed4c2c..3aafa09dbc 100644
--- a/doc/src/sgml/standby.sgml
+++ b/doc/src/sgml/pgstandby.sgml
@@ -1,9 +1,8 @@
-
<sect1 id="pgstandby">
<title>pg_standby</title>
<indexterm zone="pgstandby">
- <primary>pgstandby</primary>
+ <primary>pg_standby</primary>
</indexterm>
<para>
@@ -246,4 +245,3 @@ restore_command = 'pg_standby -c -d -s 5 -w 0 -t C:\pgsql.trigger.5442
</sect2>
</sect1>
-
diff --git a/doc/src/sgml/trgm.sgml b/doc/src/sgml/pgtrgm.sgml
similarity index 99%
rename from doc/src/sgml/trgm.sgml
rename to doc/src/sgml/pgtrgm.sgml
index 63f677a647..b7061481a9 100644
--- a/doc/src/sgml/trgm.sgml
+++ b/doc/src/sgml/pgtrgm.sgml
@@ -2,7 +2,7 @@
<title>pg_trgm</title>
<indexterm zone="pgtrgm">
- <primary>pgtrgm</primary>
+ <primary>pg_trgm</primary>
</indexterm>
<para>
@@ -211,4 +211,3 @@ CREATE INDEX words_idx ON words USING gin(word gist_trgm_ops);
</sect2>
</sect1>
-
--
2.40.0