From 00298ad9d8c9da42f338ecd0c6b3a7b737d387ee Mon Sep 17 00:00:00 2001
From: Tom Lane <tgl@sss.pgh.pa.us>
Date: Sat, 23 Mar 2013 14:06:37 -0400
Subject: [PATCH] Don't put <indexterm> before <term> in <varlistentry> items.
Doing that results in a broken index entry in PDF output. We had only
a few like that, which is probably why nobody noticed before.
Standardize on putting the <term> first.
Josh Kupershmidt
---
doc/src/sgml/config.sgml | 20 ++++++++------------
doc/src/sgml/libpq.sgml | 2 +-
2 files changed, 9 insertions(+), 13 deletions(-)
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index a3113081008..3d0d55b47d6 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -1592,10 +1592,10 @@ SET ENABLE_SEQSCAN TO OFF;
</varlistentry>
<varlistentry id="guc-fsync" xreflabel="fsync">
+ <term><varname>fsync</varname> (<type>boolean</type>)</term>
<indexterm>
<primary><varname>fsync</> configuration parameter</primary>
</indexterm>
- <term><varname>fsync</varname> (<type>boolean</type>)</term>
<listitem>
<para>
If this parameter is on, the <productname>PostgreSQL</> server
@@ -1768,10 +1768,10 @@ SET ENABLE_SEQSCAN TO OFF;
</varlistentry>
<varlistentry id="guc-full-page-writes" xreflabel="full_page_writes">
+ <term><varname>full_page_writes</varname> (<type>boolean</type>)</term>
<indexterm>
<primary><varname>full_page_writes</> configuration parameter</primary>
</indexterm>
- <term><varname>full_page_writes</varname> (<type>boolean</type>)</term>
<listitem>
<para>
When this parameter is on, the <productname>PostgreSQL</> server
@@ -2832,6 +2832,7 @@ SET ENABLE_SEQSCAN TO OFF;
<variablelist>
<varlistentry id="guc-geqo" xreflabel="geqo">
+ <term><varname>geqo</varname> (<type>boolean</type>)</term>
<indexterm>
<primary>genetic query optimization</primary>
</indexterm>
@@ -2842,7 +2843,6 @@ SET ENABLE_SEQSCAN TO OFF;
<indexterm>
<primary><varname>geqo</> configuration parameter</primary>
</indexterm>
- <term><varname>geqo</varname> (<type>boolean</type>)</term>
<listitem>
<para>
Enables or disables genetic query optimization.
@@ -4884,6 +4884,7 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
</varlistentry>
<varlistentry id="guc-default-transaction-isolation" xreflabel="default_transaction_isolation">
+ <term><varname>default_transaction_isolation</varname> (<type>enum</type>)</term>
<indexterm>
<primary>transaction isolation level</primary>
<secondary>setting default</secondary>
@@ -4891,7 +4892,6 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
<indexterm>
<primary><varname>default_transaction_isolation</> configuration parameter</primary>
</indexterm>
- <term><varname>default_transaction_isolation</varname> (<type>enum</type>)</term>
<listitem>
<para>
Each SQL transaction has an isolation level, which can be
@@ -4910,6 +4910,7 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
</varlistentry>
<varlistentry id="guc-default-transaction-read-only" xreflabel="default_transaction_read_only">
+ <term><varname>default_transaction_read_only</varname> (<type>boolean</type>)</term>
<indexterm>
<primary>read-only transaction</primary>
<secondary>setting default</secondary>
@@ -4917,8 +4918,6 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
<indexterm>
<primary><varname>default_transaction_read_only</> configuration parameter</primary>
</indexterm>
-
- <term><varname>default_transaction_read_only</varname> (<type>boolean</type>)</term>
<listitem>
<para>
A read-only SQL transaction cannot alter non-temporary tables.
@@ -4933,6 +4932,7 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
</varlistentry>
<varlistentry id="guc-default-transaction-deferrable" xreflabel="default_transaction_deferrable">
+ <term><varname>default_transaction_deferrable</varname> (<type>boolean</type>)</term>
<indexterm>
<primary>deferrable transaction</primary>
<secondary>setting default</secondary>
@@ -4940,8 +4940,6 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
<indexterm>
<primary><varname>default_transaction_deferrable</> configuration parameter</primary>
</indexterm>
-
- <term><varname>default_transaction_deferrable</varname> (<type>boolean</type>)</term>
<listitem>
<para>
When running at the <literal>serializable</> isolation level,
@@ -5225,6 +5223,7 @@ SET XML OPTION { DOCUMENT | CONTENT };
</varlistentry>
<varlistentry id="guc-extra-float-digits" xreflabel="extra_float_digits">
+ <term><varname>extra_float_digits</varname> (<type>integer</type>)</term>
<indexterm>
<primary>significant digits</primary>
</indexterm>
@@ -5235,8 +5234,6 @@ SET XML OPTION { DOCUMENT | CONTENT };
<indexterm>
<primary><varname>extra_float_digits</> configuration parameter</primary>
</indexterm>
-
- <term><varname>extra_float_digits</varname> (<type>integer</type>)</term>
<listitem>
<para>
This parameter adjusts the number of digits displayed for
@@ -5512,6 +5509,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
<variablelist>
<varlistentry id="guc-deadlock-timeout" xreflabel="deadlock_timeout">
+ <term><varname>deadlock_timeout</varname> (<type>integer</type>)</term>
<indexterm>
<primary>deadlock</primary>
<secondary>timeout during</secondary>
@@ -5523,8 +5521,6 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
<indexterm>
<primary><varname>deadlock_timeout</> configuration parameter</primary>
</indexterm>
-
- <term><varname>deadlock_timeout</varname> (<type>integer</type>)</term>
<listitem>
<para>
This is the amount of time, in milliseconds, to wait on a lock
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index 255c5c1abb8..0a6fbcf056f 100644
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -2554,11 +2554,11 @@ char *PQresultErrorField(const PGresult *res, int fieldcode);
</varlistentry>
<varlistentry id="libpq-pg-diag-sqlstate">
+ <term><symbol>PG_DIAG_SQLSTATE</></term>
<indexterm>
<primary>error codes</primary>
<secondary>libpq</secondary>
</indexterm>
- <term><symbol>PG_DIAG_SQLSTATE</></term>
<listitem>
<para>
The SQLSTATE code for the error. The SQLSTATE code identifies
--
GitLab