Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit bb4eefe

Browse files
peterepetere
committed
doc: Improve DocBook XML validity
DocBook XML is superficially compatible with DocBook SGML but has a slightly stricter DTD that we have been violating in a few cases. Although XSLT doesn't care whether the document is valid, the style sheets don't necessarily process invalid documents correctly, so we need to work toward fixing this. This first commit moves the indexterms in refentry elements to an allowed position. It has no impact on the output.
1 parent 769065c commit bb4eefe

File tree

194 files changed

+1009
-1009
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

194 files changed

+1009
-1009
lines changed

‎doc/src/sgml/dblink.sgml

+76-76
Large diffs are not rendered by default.

‎doc/src/sgml/oid2name.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
<!-- doc/src/sgml/oid2name.sgml -->
22

33
<refentry id="oid2name">
4+
<indexterm zone="oid2name">
5+
<primary>oid2name</primary>
6+
</indexterm>
7+
48
<refmeta>
59
<refentrytitle>oid2name</refentrytitle>
610
<manvolnum>1</manvolnum>
@@ -12,10 +16,6 @@
1216
<refpurpose>resolve OIDs and file nodes in a <productname>PostgreSQL</productname> data directory</refpurpose>
1317
</refnamediv>
1418

15-
<indexterm zone="oid2name">
16-
<primary>oid2name</primary>
17-
</indexterm>
18-
1919
<refsynopsisdiv>
2020
<cmdsynopsis>
2121
<command>oid2name</command>

‎doc/src/sgml/pg_xlogdump.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ PostgreSQL documentation
44
-->
55

66
<refentry id="pgxlogdump">
7+
<indexterm zone="pgxlogdump">
8+
<primary>pg_xlogdump</primary>
9+
</indexterm>
10+
711
<refmeta>
812
<refentrytitle><application>pg_xlogdump</application></refentrytitle>
913
<manvolnum>1</manvolnum>
@@ -15,10 +19,6 @@ PostgreSQL documentation
1519
<refpurpose>Display a human-readable rendering of the write-ahead log of a <productname>PostgreSQL</productname> database cluster</refpurpose>
1620
</refnamediv>
1721

18-
<indexterm zone="pgxlogdump">
19-
<primary>pg_xlogdump</primary>
20-
</indexterm>
21-
2222
<refsynopsisdiv>
2323
<cmdsynopsis>
2424
<command>pg_xlogdump</command>

‎doc/src/sgml/pgarchivecleanup.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
<!-- doc/src/sgml/pgarchivecleanup.sgml -->
22

33
<refentry id="pgarchivecleanup">
4+
<indexterm zone="pgarchivecleanup">
5+
<primary>pg_archivecleanup</primary>
6+
</indexterm>
7+
48
<refmeta>
59
<refentrytitle><application>pg_archivecleanup</application></refentrytitle>
610
<manvolnum>1</manvolnum>
@@ -12,10 +16,6 @@
1216
<refpurpose>clean up <productname>PostgreSQL</productname> WAL archive files</refpurpose>
1317
</refnamediv>
1418

15-
<indexterm zone="pgarchivecleanup">
16-
<primary>pg_archivecleanup</primary>
17-
</indexterm>
18-
1919
<refsynopsisdiv>
2020
<cmdsynopsis>
2121
<command>pg_archivecleanup</command>

‎doc/src/sgml/pgbench.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
<!-- doc/src/sgml/pgbench.sgml -->
22

33
<refentry id="pgbench">
4+
<indexterm zone="pgbench">
5+
<primary>pgbench</primary>
6+
</indexterm>
7+
48
<refmeta>
59
<refentrytitle><application>pgbench</application></refentrytitle>
610
<manvolnum>1</manvolnum>
@@ -12,10 +16,6 @@
1216
<refpurpose>run a benchmark test on <productname>PostgreSQL</productname></refpurpose>
1317
</refnamediv>
1418

15-
<indexterm zone="pgbench">
16-
<primary>pgbench</primary>
17-
</indexterm>
18-
1919
<refsynopsisdiv>
2020
<cmdsynopsis>
2121
<command>pgbench</command>

‎doc/src/sgml/pgstandby.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
<!-- doc/src/sgml/pgstandby.sgml -->
22

33
<refentry id="pgstandby">
4+
<indexterm zone="pgstandby">
5+
<primary>pg_standby</primary>
6+
</indexterm>
7+
48
<refmeta>
59
<refentrytitle><application>pg_standby</application></refentrytitle>
610
<manvolnum>1</manvolnum>
@@ -12,10 +16,6 @@
1216
<refpurpose>supports the creation of a <productname>PostgreSQL</productname> warm standby server</refpurpose>
1317
</refnamediv>
1418

15-
<indexterm zone="pgstandby">
16-
<primary>pg_standby</primary>
17-
</indexterm>
18-
1919
<refsynopsisdiv>
2020
<cmdsynopsis>
2121
<command>pg_standby</command>

‎doc/src/sgml/pgtestfsync.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
<!-- doc/src/sgml/pgtestfsync.sgml -->
22

33
<refentry id="pgtestfsync">
4+
<indexterm zone="pgtestfsync">
5+
<primary>pg_test_fsync</primary>
6+
</indexterm>
7+
48
<refmeta>
59
<refentrytitle><application>pg_test_fsync</application></refentrytitle>
610
<manvolnum>1</manvolnum>
@@ -12,10 +16,6 @@
1216
<refpurpose>determine fastest wal_sync_method for <productname>PostgreSQL</productname></refpurpose>
1317
</refnamediv>
1418

15-
<indexterm zone="pgtestfsync">
16-
<primary>pg_test_fsync</primary>
17-
</indexterm>
18-
1919
<refsynopsisdiv>
2020
<cmdsynopsis>
2121
<command>pg_test_fsync</command>

‎doc/src/sgml/pgtesttiming.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
<!-- doc/src/sgml/pgtesttiming.sgml -->
22

33
<refentry id="pgtesttiming">
4+
<indexterm zone="pgtesttiming">
5+
<primary>pg_test_timing</primary>
6+
</indexterm>
7+
48
<refmeta>
59
<refentrytitle><application>pg_test_timing</application></refentrytitle>
610
<manvolnum>1</manvolnum>
@@ -12,10 +16,6 @@
1216
<refpurpose>measure timing overhead</refpurpose>
1317
</refnamediv>
1418

15-
<indexterm zone="pgtesttiming">
16-
<primary>pg_test_timing</primary>
17-
</indexterm>
18-
1919
<refsynopsisdiv>
2020
<cmdsynopsis>
2121
<command>pg_test_timing</command>

‎doc/src/sgml/pgupgrade.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
<!-- doc/src/sgml/pgupgrade.sgml -->
22

33
<refentry id="pgupgrade">
4+
<indexterm zone="pgupgrade">
5+
<primary>pg_upgrade</primary>
6+
</indexterm>
7+
48
<refmeta>
59
<refentrytitle><application>pg_upgrade</application></refentrytitle>
610
<manvolnum>1</manvolnum>
@@ -12,10 +16,6 @@
1216
<refpurpose>upgrade a <productname>PostgreSQL</productname> server instance</refpurpose>
1317
</refnamediv>
1418

15-
<indexterm zone="pgupgrade">
16-
<primary>pg_upgrade</primary>
17-
</indexterm>
18-
1919
<refsynopsisdiv>
2020
<cmdsynopsis>
2121
<command>pg_upgrade</command>

‎doc/src/sgml/ref/abort.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ PostgreSQL documentation
44
-->
55

66
<refentry id="SQL-ABORT">
7+
<indexterm zone="sql-abort">
8+
<primary>ABORT</primary>
9+
</indexterm>
10+
711
<refmeta>
812
<refentrytitle>ABORT</refentrytitle>
913
<manvolnum>7</manvolnum>
@@ -15,10 +19,6 @@ PostgreSQL documentation
1519
<refpurpose>abort the current transaction</refpurpose>
1620
</refnamediv>
1721

18-
<indexterm zone="sql-abort">
19-
<primary>ABORT</primary>
20-
</indexterm>
21-
2222
<refsynopsisdiv>
2323
<synopsis>
2424
ABORT [ WORK | TRANSACTION ]

‎doc/src/sgml/ref/alter_aggregate.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ PostgreSQL documentation
44
-->
55

66
<refentry id="SQL-ALTERAGGREGATE">
7+
<indexterm zone="sql-alteraggregate">
8+
<primary>ALTER AGGREGATE</primary>
9+
</indexterm>
10+
711
<refmeta>
812
<refentrytitle>ALTER AGGREGATE</refentrytitle>
913
<manvolnum>7</manvolnum>
@@ -15,10 +19,6 @@ PostgreSQL documentation
1519
<refpurpose>change the definition of an aggregate function</refpurpose>
1620
</refnamediv>
1721

18-
<indexterm zone="sql-alteraggregate">
19-
<primary>ALTER AGGREGATE</primary>
20-
</indexterm>
21-
2222
<refsynopsisdiv>
2323
<synopsis>
2424
ALTER AGGREGATE <replaceable>name</replaceable> ( <replaceable>aggregate_signature</replaceable> ) RENAME TO <replaceable>new_name</replaceable>

‎doc/src/sgml/ref/alter_collation.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ PostgreSQL documentation
44
-->
55

66
<refentry id="SQL-ALTERCOLLATION">
7+
<indexterm zone="sql-altercollation">
8+
<primary>ALTER COLLATION</primary>
9+
</indexterm>
10+
711
<refmeta>
812
<refentrytitle>ALTER COLLATION</refentrytitle>
913
<manvolnum>7</manvolnum>
@@ -15,10 +19,6 @@ PostgreSQL documentation
1519
<refpurpose>change the definition of a collation</refpurpose>
1620
</refnamediv>
1721

18-
<indexterm zone="sql-altercollation">
19-
<primary>ALTER COLLATION</primary>
20-
</indexterm>
21-
2222
<refsynopsisdiv>
2323
<synopsis>
2424
ALTER COLLATION <replaceable>name</replaceable> RENAME TO <replaceable>new_name</replaceable>

‎doc/src/sgml/ref/alter_conversion.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ PostgreSQL documentation
44
-->
55

66
<refentry id="SQL-ALTERCONVERSION">
7+
<indexterm zone="sql-alterconversion">
8+
<primary>ALTER CONVERSION</primary>
9+
</indexterm>
10+
711
<refmeta>
812
<refentrytitle>ALTER CONVERSION</refentrytitle>
913
<manvolnum>7</manvolnum>
@@ -15,10 +19,6 @@ PostgreSQL documentation
1519
<refpurpose>change the definition of a conversion</refpurpose>
1620
</refnamediv>
1721

18-
<indexterm zone="sql-alterconversion">
19-
<primary>ALTER CONVERSION</primary>
20-
</indexterm>
21-
2222
<refsynopsisdiv>
2323
<synopsis>
2424
ALTER CONVERSION <replaceable>name</replaceable> RENAME TO <replaceable>new_name</replaceable>

‎doc/src/sgml/ref/alter_database.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ PostgreSQL documentation
44
-->
55

66
<refentry id="SQL-ALTERDATABASE">
7+
<indexterm zone="sql-alterdatabase">
8+
<primary>ALTER DATABASE</primary>
9+
</indexterm>
10+
711
<refmeta>
812
<refentrytitle>ALTER DATABASE</refentrytitle>
913
<manvolnum>7</manvolnum>
@@ -15,10 +19,6 @@ PostgreSQL documentation
1519
<refpurpose>change a database</refpurpose>
1620
</refnamediv>
1721

18-
<indexterm zone="sql-alterdatabase">
19-
<primary>ALTER DATABASE</primary>
20-
</indexterm>
21-
2222
<refsynopsisdiv>
2323
<synopsis>
2424
ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> [ [ WITH ] <replaceable class="PARAMETER">option</replaceable> [ ... ] ]

‎doc/src/sgml/ref/alter_default_privileges.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ PostgreSQL documentation
44
-->
55

66
<refentry id="SQL-ALTERDEFAULTPRIVILEGES">
7+
<indexterm zone="sql-alterdefaultprivileges">
8+
<primary>ALTER DEFAULT PRIVILEGES</primary>
9+
</indexterm>
10+
711
<refmeta>
812
<refentrytitle>ALTER DEFAULT PRIVILEGES</refentrytitle>
913
<manvolnum>7</manvolnum>
@@ -15,10 +19,6 @@ PostgreSQL documentation
1519
<refpurpose>define default access privileges</refpurpose>
1620
</refnamediv>
1721

18-
<indexterm zone="sql-alterdefaultprivileges">
19-
<primary>ALTER DEFAULT PRIVILEGES</primary>
20-
</indexterm>
21-
2222
<refsynopsisdiv>
2323
<synopsis>
2424
ALTER DEFAULT PRIVILEGES

‎doc/src/sgml/ref/alter_domain.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ PostgreSQL documentation
44
-->
55

66
<refentry id="SQL-ALTERDOMAIN">
7+
<indexterm zone="sql-alterdomain">
8+
<primary>ALTER DOMAIN</primary>
9+
</indexterm>
10+
711
<refmeta>
812
<refentrytitle>ALTER DOMAIN</refentrytitle>
913
<manvolnum>7</manvolnum>
@@ -17,10 +21,6 @@ PostgreSQL documentation
1721
</refpurpose>
1822
</refnamediv>
1923

20-
<indexterm zone="sql-alterdomain">
21-
<primary>ALTER DOMAIN</primary>
22-
</indexterm>
23-
2424
<refsynopsisdiv>
2525
<synopsis>
2626
ALTER DOMAIN <replaceable class="PARAMETER">name</replaceable>

‎doc/src/sgml/ref/alter_event_trigger.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ PostgreSQL documentation
44
-->
55

66
<refentry id="SQL-ALTEREVENTTRIGGER">
7+
<indexterm zone="sql-altereventtrigger">
8+
<primary>ALTER EVENT TRIGGER</primary>
9+
</indexterm>
10+
711
<refmeta>
812
<refentrytitle>ALTER EVENT TRIGGER</refentrytitle>
913
<manvolnum>7</manvolnum>
@@ -15,10 +19,6 @@ PostgreSQL documentation
1519
<refpurpose>change the definition of an event trigger</refpurpose>
1620
</refnamediv>
1721

18-
<indexterm zone="sql-altereventtrigger">
19-
<primary>ALTER EVENT TRIGGER</primary>
20-
</indexterm>
21-
2222
<refsynopsisdiv>
2323
<synopsis>
2424
ALTER EVENT TRIGGER <replaceable class="PARAMETER">name</replaceable> DISABLE

‎doc/src/sgml/ref/alter_extension.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ PostgreSQL documentation
44
-->
55

66
<refentry id="SQL-ALTEREXTENSION">
7+
<indexterm zone="sql-alterextension">
8+
<primary>ALTER EXTENSION</primary>
9+
</indexterm>
10+
711
<refmeta>
812
<refentrytitle>ALTER EXTENSION</refentrytitle>
913
<manvolnum>7</manvolnum>
@@ -17,10 +21,6 @@ PostgreSQL documentation
1721
</refpurpose>
1822
</refnamediv>
1923

20-
<indexterm zone="sql-alterextension">
21-
<primary>ALTER EXTENSION</primary>
22-
</indexterm>
23-
2424
<refsynopsisdiv>
2525
<synopsis>
2626
ALTER EXTENSION <replaceable class="PARAMETER">name</replaceable> UPDATE [ TO <replaceable class="PARAMETER">new_version</replaceable> ]

‎doc/src/sgml/ref/alter_foreign_data_wrapper.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ PostgreSQL documentation
44
-->
55

66
<refentry id="SQL-ALTERFOREIGNDATAWRAPPER">
7+
<indexterm zone="sql-alterforeigndatawrapper">
8+
<primary>ALTER FOREIGN DATA WRAPPER</primary>
9+
</indexterm>
10+
711
<refmeta>
812
<refentrytitle>ALTER FOREIGN DATA WRAPPER</refentrytitle>
913
<manvolnum>7</manvolnum>
@@ -15,10 +19,6 @@ PostgreSQL documentation
1519
<refpurpose>change the definition of a foreign-data wrapper</refpurpose>
1620
</refnamediv>
1721

18-
<indexterm zone="sql-alterforeigndatawrapper">
19-
<primary>ALTER FOREIGN DATA WRAPPER</primary>
20-
</indexterm>
21-
2222
<refsynopsisdiv>
2323
<synopsis>
2424
ALTER FOREIGN DATA WRAPPER <replaceable class="parameter">name</replaceable>

0 commit comments

Comments
 (0)