Skip to content

Commit dca30da

Browse files
tglsfdctglsfdc
committed
Avoid extra whitespace in the arguments of <indexterm>.
As noted by Thom Brown, this confuses the DocBook index processor; it fails to merge entries that differ only in whitespace, and sorts them unexpectedly as well. Seems like a toolchain bug, but I'm not going to hold my breath waiting for a fix. Note: easiest way to find these is to look for double spaces in HTML.index.
1 parent 8ad5827 commit dca30da

File tree

12 files changed

+75
-50
lines changed

12 files changed

+75
-50
lines changed

‎doc/src/sgml/installation.sgml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1080,14 +1080,15 @@ su - postgres
10801080
pointed to works correctly with <productname>PostgreSQL</>.
10811081
</para>
10821082

1083+
<indexterm><primary>cross compilation</primary></indexterm>
1084+
10831085
<para>
10841086
This option is mainly aimed at binary package distributors
10851087
who know their target operating system well. The main
10861088
advantage of using this option is that the PostgreSQL package
10871089
won't need to be upgraded whenever any of the many local
10881090
daylight-saving time rules change. Another advantage is that
1089-
PostgreSQL can be cross-compiled<indexterm><primary>cross
1090-
compilation</primary></indexterm> more straightforwardly if the
1091+
PostgreSQL can be cross-compiled more straightforwardly if the
10911092
time zone database files do not need to be built during the
10921093
installation.
10931094
</para>

‎doc/src/sgml/libpq.sgml

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ PGconn *PQconnectdbParams(const char **keywords, const char **values, int expand
188188
the value for <literal>hostaddr</> gives the server network address.
189189
The value for <literal>host</> is ignored unless the
190190
authentication method requires it, in which case it will be
191-
used as the host name.
191+
used as the host name.
192192
</para>
193193
</listitem>
194194
</itemizedlist>
@@ -1610,10 +1610,12 @@ int PQsocket(const PGconn *conn);
16101610
<term><function>PQbackendPID</function><indexterm><primary>PQbackendPID</></></term>
16111611
<listitem>
16121612
<para>
1613-
Returns the process <acronym>ID</acronym>
1614-
(PID)<indexterm><primary>PID</><secondary>determining PID of
1615-
server process</><tertiary>in libpq</></> of the backend
1616-
process handling this connection.
1613+
Returns the process <acronym>ID</acronym> (PID)<indexterm>
1614+
<primary>PID</>
1615+
<secondary>determining PID of server process</>
1616+
<tertiary>in libpq</>
1617+
</indexterm>
1618+
of the backend process handling this connection.
16171619

16181620
<synopsis>
16191621
int PQbackendPID(const PGconn *conn);
@@ -4201,7 +4203,7 @@ int PQcancel(PGcancel *cancel, char *errbuf, int errbufsize);
42014203
<listitem>
42024204
<para>
42034205
<function>PQrequestCancel</function> is a deprecated variant of
4204-
<function>PQcancel</function>.
4206+
<function>PQcancel</function>.
42054207
<synopsis>
42064208
int PQrequestCancel(PGconn *conn);
42074209
</synopsis>
@@ -5459,12 +5461,12 @@ int PQlibVersion(void);
54595461

54605462
<para>
54615463
The function <function>PQsetNoticeReceiver</function>
5462-
<indexterm><primary>notice
5463-
receiver</></><indexterm><primary>PQsetNoticeReceiver</></> sets or
5464+
<indexterm><primary>notice receiver</></>
5465+
<indexterm><primary>PQsetNoticeReceiver</></> sets or
54645466
examines the current notice receiver for a connection object.
54655467
Similarly, <function>PQsetNoticeProcessor</function>
5466-
<indexterm><primary>notice
5467-
processor</></><indexterm><primary>PQsetNoticeProcessor</></> sets or
5468+
<indexterm><primary>notice processor</></>
5469+
<indexterm><primary>PQsetNoticeProcessor</></> sets or
54685470
examines the current notice processor.
54695471

54705472
<synopsis>

‎doc/src/sgml/manage-ag.sgml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,8 @@ SELECT datname FROM pg_database;
7878
<sect1 id="manage-ag-createdb">
7979
<title>Creating a Database</title>
8080

81+
<indexterm><primary>CREATE DATABASE</></>
82+
8183
<para>
8284
In order to create a database, the <productname>PostgreSQL</>
8385
server must be up and running (see <xref
@@ -86,8 +88,7 @@ SELECT datname FROM pg_database;
8688

8789
<para>
8890
Databases are created with the SQL command
89-
<xref linkend="sql-createdatabase">:<indexterm><primary>CREATE
90-
DATABASE</></>
91+
<xref linkend="sql-createdatabase">:
9192
<synopsis>
9293
CREATE DATABASE <replaceable>name</>;
9394
</synopsis>

‎doc/src/sgml/plpgsql.sgml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3983,13 +3983,16 @@ $$ LANGUAGE plpgsql;
39833983
</para>
39843984

39853985
<para>
3986+
<indexterm>
3987+
<primary>preparing a query</>
3988+
<secondary>in PL/pgSQL</>
3989+
</indexterm>
39863990
As each expression and <acronym>SQL</acronym> command is first
39873991
executed in the function, the <application>PL/pgSQL</> interpreter
39883992
creates a prepared execution plan (using the
39893993
<acronym>SPI</acronym> manager's <function>SPI_prepare</function>
3990-
and <function>SPI_saveplan</function>
3991-
functions).<indexterm><primary>preparing a query</><secondary>in
3992-
PL/pgSQL</></> Subsequent visits to that expression or command
3994+
and <function>SPI_saveplan</function> functions).
3995+
Subsequent visits to that expression or command
39933996
reuse the prepared plan. Thus, a function with conditional code
39943997
that contains many statements for which execution plans might be
39953998
required will only prepare and save those plans that are really

‎doc/src/sgml/plpython.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,7 @@ $$ LANGUAGE plpythonu;
398398
<title>Null, None</title>
399399
<para>
400400
If an SQL null value<indexterm><primary>null value</primary><secondary
401-
sortas="PL/Python">PL/Python</secondary></indexterm> is passed to a
401+
sortas="PL/Python">in PL/Python</secondary></indexterm> is passed to a
402402
function, the argument value will appear as <symbol>None</symbol> in
403403
Python. The above function definition will return the wrong answer for null
404404
inputs. We could add <literal>STRICT</literal> to the function definition
@@ -716,8 +716,8 @@ SELECT * FROM multiout_simple_setof(3);
716716
data between function calls. This variable is private static data.
717717
The global dictionary <varname>GD</varname> is public data,
718718
available to all Python functions within a session. Use with
719-
care.<indexterm><primary>global data</><secondary>in
720-
PL/Python</></indexterm>
719+
care.<indexterm><primary>global data</>
720+
<secondary>in PL/Python</></indexterm>
721721
</para>
722722

723723
<para>

‎doc/src/sgml/pltcl.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,8 +344,8 @@ spi_exec -array C "SELECT * FROM pg_class" {
344344
<para>
345345
Prepares and saves a query plan for later execution. The
346346
saved plan will be retained for the life of the current
347-
session.<indexterm><primary>preparing a query</><secondary>in
348-
PL/Tcl</></>
347+
session.<indexterm><primary>preparing a query</>
348+
<secondary>in PL/Tcl</></>
349349
</para>
350350
<para>
351351
The query can use parameters, that is, placeholders for

‎doc/src/sgml/queries.sgml

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -895,16 +895,16 @@ SELECT product_id, p.name, (sum(s.units) * p.price) AS sales
895895
all sales of the product.
896896
</para>
897897

898+
<indexterm><primary>functional dependency</primary></indexterm>
899+
898900
<para>
899-
If the products table is set up so that,
900-
say, <literal>product_id</literal> is the primary key, then it
901-
would be enough to group by <literal>product_id</literal> in the
902-
above example, since name and price would
903-
be <firstterm>functionally
904-
dependent</firstterm><indexterm><primary>functional
905-
dependency</primary></indexterm> on the product ID, and so there
906-
would be no ambiguity about which name and price value to return
907-
for each product ID group.
901+
If the products table is set up so that, say,
902+
<literal>product_id</literal> is the primary key, then it would be
903+
enough to group by <literal>product_id</literal> in the above example,
904+
since name and price would be <firstterm>functionally
905+
dependent</firstterm> on the product ID, and so there would be no
906+
ambiguity about which name and price value to return for each product
907+
ID group.
908908
</para>
909909

910910
<para>
@@ -1170,9 +1170,12 @@ SELECT DISTINCT <replaceable>select_list</replaceable> ...
11701170
can be used to specify the default behavior of retaining all rows.)
11711171
</para>
11721172

1173+
<indexterm>
1174+
<primary>null value</>
1175+
<secondary sortas="DISTINCT">in DISTINCT</>
1176+
</indexterm>
1177+
11731178
<para>
1174-
<indexterm><primary>null value</><secondary sortas="DISTINCT">in
1175-
DISTINCT</></indexterm>
11761179
Obviously, two rows are considered distinct if they differ in at
11771180
least one column value. Null values are considered equal in this
11781181
comparison.

‎doc/src/sgml/runtime.sgml

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,11 @@ postgres$ <userinput>initdb -D /usr/local/pgsql/data</userinput>
142142
trust other local users, we recommend you use one of
143143
<command>initdb</command>'s <option>-W</option>, <option>--pwprompt</option>
144144
or <option>--pwfile</option> options to assign a password to the
145-
database superuser.<indexterm><primary>password</><secondary>of the
146-
superuser</></indexterm> Also, specify <option>-A md5</> or
145+
database superuser.<indexterm>
146+
<primary>password</>
147+
<secondary>of the superuser</>
148+
</indexterm>
149+
Also, specify <option>-A md5</> or
147150
<option>-A password</> so that the default <literal>trust</> authentication
148151
mode is not used; or modify the generated <filename>pg_hba.conf</filename>
149152
file after running <command>initdb</command>, but
@@ -264,8 +267,11 @@ pg_ctl start -l logfile
264267

265268
<para>
266269
Normally, you will want to start the database server when the
267-
computer boots.<indexterm><primary>booting</><secondary>starting
268-
the server during</></> Autostart scripts are operating-system-specific.
270+
computer boots.<indexterm>
271+
<primary>booting</>
272+
<secondary>starting the server during</>
273+
</indexterm>
274+
Autostart scripts are operating-system-specific.
269275
There are a few distributed with
270276
<productname>PostgreSQL</productname> in the
271277
<filename>contrib/start-scripts</> directory. Installing one will require

‎doc/src/sgml/spi.sgml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3188,9 +3188,12 @@ char * SPI_getnspname(Relation <parameter>rel</parameter>)
31883188
<title>Memory Management</title>
31893189

31903190
<para>
3191+
<indexterm>
3192+
<primary>memory context</primary>
3193+
<secondary>in SPI</secondary>
3194+
</indexterm>
31913195
<productname>PostgreSQL</productname> allocates memory within
3192-
<firstterm>memory contexts</firstterm><indexterm><primary>memory
3193-
context</primary><secondary>in SPI</secondary></indexterm>, which provide a convenient method of
3196+
<firstterm>memory contexts</firstterm>, which provide a convenient method of
31943197
managing allocations made in many different places that need to
31953198
live for differing amounts of time. Destroying a context releases
31963199
all the memory that was allocated in it. Thus, it is not necessary

‎doc/src/sgml/syntax.sgml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,9 +189,13 @@ UPDATE "my_table" SET "a" = 5;
189189
ampersands. The length limitation still applies.
190190
</para>
191191

192+
<indexterm>
193+
<primary>Unicode escape</primary>
194+
<secondary>in identifiers</secondary>
195+
</indexterm>
196+
192197
<para>
193-
<indexterm><primary>Unicode escape</primary><secondary>in
194-
identifiers</secondary></indexterm> A variant of quoted
198+
A variant of quoted
195199
identifiers allows including escaped Unicode characters identified
196200
by their code points. This variant starts
197201
with <literal>U&amp;</literal> (upper or lower case U followed by

‎doc/src/sgml/trigger.sgml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,9 +242,12 @@
242242
</para>
243243

244244
<para>
245+
<indexterm>
246+
<primary>trigger</>
247+
<secondary>arguments for trigger functions</>
248+
</indexterm>
245249
When a trigger is being defined, arguments can be specified for
246-
it.<indexterm><primary>trigger</><secondary>arguments for trigger
247-
functions</></indexterm> The purpose of including arguments in the
250+
it. The purpose of including arguments in the
248251
trigger definition is to allow different triggers with similar
249252
requirements to call the same function. As an example, there
250253
could be a generalized trigger function that takes as its

‎doc/src/sgml/xtypes.sgml

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,7 @@
3232
<indexterm>
3333
<primary>output function</primary>
3434
</indexterm>
35-
A user-defined type must always have input and output
36-
functions.<indexterm><primary>input function</primary><secondary>of
37-
a data type</secondary></indexterm><indexterm><primary>output
38-
function</primary><secondary>of a data type</secondary></indexterm>
35+
A user-defined type must always have input and output functions.
3936
These functions determine how the type appears in strings (for input
4037
by the user and output to the user) and how the type is organized in
4138
memory. The input function takes a null-terminated character string
@@ -218,11 +215,13 @@ CREATE TYPE complex (
218215
</para>
219216

220217
<para>
218+
<indexterm>
219+
<primary>array</primary>
220+
<secondary>of user-defined type</secondary>
221+
</indexterm>
221222
When you define a new base type,
222223
<productname>PostgreSQL</productname> automatically provides support
223-
for arrays of that
224-
type.<indexterm><primary>array</primary><secondary>of user-defined
225-
type</secondary></indexterm> The array type typically
224+
for arrays of that type. The array type typically
226225
has the same name as the base type with the underscore character
227226
(<literal>_</>) prepended.
228227
</para>

0 commit comments

Comments
 (0)