Skip to content

Commit 3a9d430

Browse files
peterepetere
committed
doc: Fix DocBook XML validity
The main problem is that DocBook SGML allows indexterm elements just about everywhere, but DocBook XML is stricter. For example, this common pattern <varlistentry> <indexterm>...</indexterm> <term>...</term> ... </varlistentry> needs to be changed to something like <varlistentry> <term>...<indexterm>...</indexterm></term> ... </varlistentry> See also bb4eefe. There is currently nothing in the build system that enforces that things stay valid, because that requires additional tools and will receive separate consideration.
1 parent 84288a8 commit 3a9d430

24 files changed

+903
-578
lines changed

‎doc/src/sgml/auth-delay.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@
2828
<varlistentry>
2929
<term>
3030
<varname>auth_delay.milliseconds</varname> (<type>int</type>)
31+
<indexterm>
32+
<primary><varname>auth_delay.milliseconds</> configuration parameter</primary>
33+
</indexterm>
3134
</term>
32-
<indexterm>
33-
<primary><varname>auth_delay.milliseconds</> configuration parameter</primary>
34-
</indexterm>
3535
<listitem>
3636
<para>
3737
The number of milliseconds to wait before reporting an authentication

‎doc/src/sgml/auto-explain.sgml

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ LOAD 'auto_explain';
4646
<varlistentry>
4747
<term>
4848
<varname>auto_explain.log_min_duration</varname> (<type>integer</type>)
49+
<indexterm>
50+
<primary><varname>auto_explain.log_min_duration</> configuration parameter</primary>
51+
</indexterm>
4952
</term>
50-
<indexterm>
51-
<primary><varname>auto_explain.log_min_duration</> configuration parameter</primary>
52-
</indexterm>
5353
<listitem>
5454
<para>
5555
<varname>auto_explain.log_min_duration</varname> is the minimum statement
@@ -65,10 +65,10 @@ LOAD 'auto_explain';
6565
<varlistentry>
6666
<term>
6767
<varname>auto_explain.log_analyze</varname> (<type>boolean</type>)
68+
<indexterm>
69+
<primary><varname>auto_explain.log_analyze</> configuration parameter</primary>
70+
</indexterm>
6871
</term>
69-
<indexterm>
70-
<primary><varname>auto_explain.log_analyze</> configuration parameter</primary>
71-
</indexterm>
7272
<listitem>
7373
<para>
7474
<varname>auto_explain.log_analyze</varname> causes <command>EXPLAIN ANALYZE</>
@@ -89,10 +89,10 @@ LOAD 'auto_explain';
8989
<varlistentry>
9090
<term>
9191
<varname>auto_explain.log_verbose</varname> (<type>boolean</type>)
92+
<indexterm>
93+
<primary><varname>auto_explain.log_verbose</> configuration parameter</primary>
94+
</indexterm>
9295
</term>
93-
<indexterm>
94-
<primary><varname>auto_explain.log_verbose</> configuration parameter</primary>
95-
</indexterm>
9696
<listitem>
9797
<para>
9898
<varname>auto_explain.log_verbose</varname> causes <command>EXPLAIN VERBOSE</>
@@ -106,10 +106,10 @@ LOAD 'auto_explain';
106106
<varlistentry>
107107
<term>
108108
<varname>auto_explain.log_buffers</varname> (<type>boolean</type>)
109+
<indexterm>
110+
<primary><varname>auto_explain.log_buffers</> configuration parameter</primary>
111+
</indexterm>
109112
</term>
110-
<indexterm>
111-
<primary><varname>auto_explain.log_buffers</> configuration parameter</primary>
112-
</indexterm>
113113
<listitem>
114114
<para>
115115
<varname>auto_explain.log_buffers</varname> causes <command>EXPLAIN
@@ -125,10 +125,10 @@ LOAD 'auto_explain';
125125
<varlistentry>
126126
<term>
127127
<varname>auto_explain.log_triggers</varname> (<type>boolean</type>)
128+
<indexterm>
129+
<primary><varname>auto_explain.log_triggers</> configuration parameter</primary>
130+
</indexterm>
128131
</term>
129-
<indexterm>
130-
<primary><varname>auto_explain.log_triggers</> configuration parameter</primary>
131-
</indexterm>
132132
<listitem>
133133
<para>
134134
<varname>auto_explain.log_triggers</varname> causes trigger
@@ -143,10 +143,10 @@ LOAD 'auto_explain';
143143
<varlistentry>
144144
<term>
145145
<varname>auto_explain.log_format</varname> (<type>enum</type>)
146+
<indexterm>
147+
<primary><varname>auto_explain.log_format</> configuration parameter</primary>
148+
</indexterm>
146149
</term>
147-
<indexterm>
148-
<primary><varname>auto_explain.log_format</> configuration parameter</primary>
149-
</indexterm>
150150
<listitem>
151151
<para>
152152
<varname>auto_explain.log_format</varname> selects the
@@ -161,10 +161,10 @@ LOAD 'auto_explain';
161161
<varlistentry>
162162
<term>
163163
<varname>auto_explain.log_timing</varname> (<type>boolean</type>)
164+
<indexterm>
165+
<primary><varname>auto_explain.log_timing</> configuration parameter</primary>
166+
</indexterm>
164167
</term>
165-
<indexterm>
166-
<primary><varname>auto_explain.log_timing</> configuration parameter</primary>
167-
</indexterm>
168168
<listitem>
169169
<para>
170170
<varname>auto_explain.log_timing</varname> causes <command>EXPLAIN
@@ -182,10 +182,10 @@ LOAD 'auto_explain';
182182
<varlistentry>
183183
<term>
184184
<varname>auto_explain.log_nested_statements</varname> (<type>boolean</type>)
185+
<indexterm>
186+
<primary><varname>auto_explain.log_nested_statements</> configuration parameter</primary>
187+
</indexterm>
185188
</term>
186-
<indexterm>
187-
<primary><varname>auto_explain.log_nested_statements</> configuration parameter</primary>
188-
</indexterm>
189189
<listitem>
190190
<para>
191191
<varname>auto_explain.log_nested_statements</varname> causes nested

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy