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‎

Lines changed: 76 additions & 76 deletions
Large diffs are not rendered by default.

‎doc/src/sgml/oid2name.sgml‎

Lines changed: 4 additions & 4 deletions
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‎

Lines changed: 4 additions & 4 deletions
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‎

Lines changed: 4 additions & 4 deletions
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‎

Lines changed: 4 additions & 4 deletions
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‎

Lines changed: 4 additions & 4 deletions
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‎

Lines changed: 4 additions & 4 deletions
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‎

Lines changed: 4 additions & 4 deletions
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‎

Lines changed: 4 additions & 4 deletions
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‎

Lines changed: 4 additions & 4 deletions
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 ]

0 commit comments

Comments
 (0)