Skip to content

Commit 6dcce39

Browse files
peterepetere
committed
Remove unnecessary xref endterm attributes and title ids
The endterm attribute is mainly useful when the toolchain does not support automatic link target text generation for a particular situation. In the past, this was required by the man page tools for all reference page links, but that is no longer the case, and it now actually gets in the way of proper automatic link text generation. The only remaining use cases are currently xrefs to refsects.
1 parent 7969145 commit 6dcce39

File tree

203 files changed

+1132
-1195
lines changed

Some content is hidden

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

203 files changed

+1132
-1195
lines changed

‎doc/src/sgml/advanced.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/advanced.sgml,v 1.59 2009/06/17 21:58:48 tgl Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/advanced.sgml,v 1.60 2010/04/03 07:22:52 petere Exp $ -->
22

33
<chapter id="tutorial-advanced">
44
<title>Advanced Features</title>
@@ -318,7 +318,7 @@ COMMIT;
318318

319319

320320
<sect1 id="tutorial-window">
321-
<title id="tutorial-window-title">Window Functions</title>
321+
<title>Window Functions</title>
322322

323323
<indexterm zone="tutorial-window">
324324
<primary>window function</primary>
@@ -555,7 +555,7 @@ SELECT sum(salary) OVER w, avg(salary) OVER w
555555
More details about window functions can be found in
556556
<xref linkend="syntax-window-functions">,
557557
<xref linkend="queries-window">, and the
558-
<xref linkend="sql-select" endterm="sql-select-title"> reference page.
558+
<xref linkend="sql-select"> reference page.
559559
</para>
560560
</sect1>
561561

‎doc/src/sgml/arch-dev.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/arch-dev.sgml,v 2.33 2009/10/10 01:43:45 tgl Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/arch-dev.sgml,v 2.34 2010/04/03 07:22:52 petere Exp $ -->
22

33
<chapter id="overview">
44
<title>Overview of PostgreSQL Internals</title>
@@ -346,8 +346,8 @@
346346
space. In particular, this occurs when executing queries
347347
involving large numbers of join operations. In order to determine
348348
a reasonable (not necessarily optimal) query plan in a reasonable amount
349-
of time, <productname>PostgreSQL</productname> uses a <xref
350-
linkend="geqo" endterm="geqo-title"> when the number of joins
349+
of time, <productname>PostgreSQL</productname> uses a <firstterm>Genetic
350+
Query Optimizer</firstterm> (see <xref linkend="geqo">) when the number of joins
351351
exceeds a threshold (see <xref linkend="guc-geqo-threshold">).
352352
</para>
353353
</note>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/auto-explain.sgml,v 1.7 2010/02/20 22:24:29 adunstan Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/auto-explain.sgml,v 1.8 2010/04/03 07:22:52 petere Exp $ -->
22

33
<sect1 id="auto-explain">
44
<title>auto_explain</title>
@@ -10,7 +10,7 @@
1010
<para>
1111
The <filename>auto_explain</filename> module provides a means for
1212
logging execution plans of slow statements automatically, without
13-
having to run <xref linkend="sql-explain" endterm="sql-explain-title">
13+
having to run <xref linkend="sql-explain">
1414
by hand. This is especially helpful for tracking down un-optimized queries
1515
in large applications.
1616
</para>

‎doc/src/sgml/backup.sgml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/backup.sgml,v 2.149 2010/04/01 13:52:56 momjian Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/backup.sgml,v 2.150 2010/04/03 07:22:52 petere Exp $ -->
22

33
<chapter id="backup">
44
<title>Backup and Restore</title>
@@ -166,10 +166,10 @@ pg_dump -h <replaceable>host1</> <replaceable>dbname</> | psql -h <replaceable>h
166166

167167
<para>
168168
After restoring a backup, it is wise to run <xref
169-
linkend="sql-analyze" endterm="sql-analyze-title"> on each
169+
linkend="sql-analyze"> on each
170170
database so the query optimizer has useful statistics;
171-
see <xref linkend="vacuum-for-statistics" endterm="vacuum-for-statistics-title">
172-
and <xref linkend="autovacuum" endterm="autovacuum-title"> for more information.
171+
see <xref linkend="vacuum-for-statistics">
172+
and <xref linkend="autovacuum"> for more information.
173173
For more advice on how to load large amounts of data
174174
into <productname>PostgreSQL</> efficiently, refer to <xref
175175
linkend="populate">.
@@ -1293,14 +1293,14 @@ archive_command = 'local_backup_script.sh'
12931293
deleted rows will still retain pointers. In other words, if you modify a
12941294
table with a hash index on it then you will get incorrect query results
12951295
on a standby server. When recovery completes it is recommended that you
1296-
manually <xref linkend="sql-reindex" endterm="sql-reindex-title">
1296+
manually <xref linkend="sql-reindex">
12971297
each such index after completing a recovery operation.
12981298
</para>
12991299
</listitem>
13001300

13011301
<listitem>
13021302
<para>
1303-
If a <xref linkend="sql-createdatabase" endterm="sql-createdatabase-title">
1303+
If a <xref linkend="sql-createdatabase">
13041304
command is executed while a base backup is being taken, and then
13051305
the template database that the <command>CREATE DATABASE</> copied
13061306
is modified while the base backup is still in progress, it is
@@ -1313,7 +1313,7 @@ archive_command = 'local_backup_script.sh'
13131313

13141314
<listitem>
13151315
<para>
1316-
<xref linkend="sql-createtablespace" endterm="sql-createtablespace-title">
1316+
<xref linkend="sql-createtablespace">
13171317
commands are WAL-logged with the literal absolute path, and will
13181318
therefore be replayed as tablespace creations with the same
13191319
absolute path. This might be undesirable if the log is being

‎doc/src/sgml/catalogs.sgml

Lines changed: 41 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/catalogs.sgml,v 2.224 2010/03/25 14:44:33 alvherre Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/catalogs.sgml,v 2.225 2010/04/03 07:22:52 petere Exp $ -->
22
<!--
33
Documentation of the system catalogs, directed toward PostgreSQL developers
44
-->
@@ -354,7 +354,7 @@
354354

355355
<para>
356356
New aggregate functions are registered with the <xref
357-
linkend="sql-createaggregate" endterm="sql-createaggregate-title">
357+
linkend="sql-createaggregate">
358358
command. See <xref linkend="xaggr"> for more information about
359359
writing aggregate functions and the meaning of the transition
360360
functions, etc.
@@ -886,7 +886,7 @@
886886
<entry>
887887
<structfield>attstattarget</structfield> controls the level of detail
888888
of statistics accumulated for this column by
889-
<xref linkend="sql-analyze" endterm="sql-analyze-title">.
889+
<xref linkend="sql-analyze">.
890890
A zero value indicates that no statistics should be collected.
891891
A negative value says to use the system default statistics target.
892892
The exact meaning of positive values is data type-dependent.
@@ -1274,7 +1274,7 @@
12741274
<para>
12751275
The catalog <structname>pg_cast</structname> stores data type conversion
12761276
paths, both built-in paths and those defined with
1277-
<xref linkend="sql-createcast" endterm="sql-createcast-title">.
1277+
<xref linkend="sql-createcast">.
12781278
</para>
12791279

12801280
<para>
@@ -1662,8 +1662,8 @@
16621662
<entry></entry>
16631663
<entry>
16641664
Access privileges; see
1665-
<xref linkend="sql-grant" endterm="sql-grant-title"> and
1666-
<xref linkend="sql-revoke" endterm="sql-revoke-title">
1665+
<xref linkend="sql-grant"> and
1666+
<xref linkend="sql-revoke">
16671667
for details
16681668
</entry>
16691669
</row>
@@ -1962,7 +1962,7 @@
19621962
<para>
19631963
The catalog <structname>pg_conversion</structname> describes the
19641964
available encoding conversion procedures. See
1965-
<xref linkend="sql-createconversion" endterm="sql-createconversion-title">
1965+
<xref linkend="sql-createconversion">
19661966
for more information.
19671967
</para>
19681968

@@ -2047,7 +2047,7 @@
20472047
<para>
20482048
The catalog <structname>pg_database</structname> stores information about
20492049
the available databases. Databases are created with the <xref
2050-
linkend="sql-createdatabase" endterm="sql-createdatabase-title"> command.
2050+
linkend="sql-createdatabase"> command.
20512051
Consult <xref linkend="managing-databases"> for details about the meaning
20522052
of some of the parameters.
20532053
</para>
@@ -2185,8 +2185,8 @@
21852185
<entry></entry>
21862186
<entry>
21872187
Access privileges; see
2188-
<xref linkend="sql-grant" endterm="sql-grant-title"> and
2189-
<xref linkend="sql-revoke" endterm="sql-revoke-title">
2188+
<xref linkend="sql-grant"> and
2189+
<xref linkend="sql-revoke">
21902190
for details
21912191
</entry>
21922192
</row>
@@ -2467,7 +2467,7 @@
24672467
<para>
24682468
The catalog <structname>pg_description</> stores optional descriptions
24692469
(comments) for each database object. Descriptions can be manipulated
2470-
with the <xref linkend="sql-comment" endterm="sql-comment-title"> command and viewed with
2470+
with the <xref linkend="sql-comment"> command and viewed with
24712471
<application>psql</application>'s <literal>\d</literal> commands.
24722472
Descriptions of many built-in system objects are provided in the initial
24732473
contents of <structname>pg_description</structname>.
@@ -2643,8 +2643,8 @@
26432643
<entry></entry>
26442644
<entry>
26452645
Access privileges; see
2646-
<xref linkend="sql-grant" endterm="sql-grant-title"> and
2647-
<xref linkend="sql-revoke" endterm="sql-revoke-title">
2646+
<xref linkend="sql-grant"> and
2647+
<xref linkend="sql-revoke">
26482648
for details
26492649
</entry>
26502650
</row>
@@ -2732,8 +2732,8 @@
27322732
<entry></entry>
27332733
<entry>
27342734
Access privileges; see
2735-
<xref linkend="sql-grant" endterm="sql-grant-title"> and
2736-
<xref linkend="sql-revoke" endterm="sql-revoke-title">
2735+
<xref linkend="sql-grant"> and
2736+
<xref linkend="sql-revoke">
27372737
for details
27382738
</entry>
27392739
</row>
@@ -3000,7 +3000,7 @@
30003000
<para>
30013001
The catalog <structname>pg_language</structname> registers
30023002
languages in which you can write functions or stored procedures.
3003-
See <xref linkend="sql-createlanguage" endterm="sql-createlanguage-title">
3003+
See <xref linkend="sql-createlanguage">
30043004
and <xref linkend="xplang"> for more information about language handlers.
30053005
</para>
30063006

@@ -3076,7 +3076,7 @@
30763076
<entry>
30773077
This references a function that is responsible for executing
30783078
<quote>inline</> anonymous code blocks
3079-
(<xref linkend="sql-do" endterm="sql-do-title"> blocks).
3079+
(<xref linkend="sql-do"> blocks).
30803080
Zero if inline blocks are not supported
30813081
</entry>
30823082
</row>
@@ -3098,8 +3098,8 @@
30983098
<entry></entry>
30993099
<entry>
31003100
Access privileges; see
3101-
<xref linkend="sql-grant" endterm="sql-grant-title"> and
3102-
<xref linkend="sql-revoke" endterm="sql-revoke-title">
3101+
<xref linkend="sql-grant"> and
3102+
<xref linkend="sql-revoke">
31033103
for details
31043104
</entry>
31053105
</row>
@@ -3231,8 +3231,8 @@
32313231
<entry></entry>
32323232
<entry>
32333233
Access privileges; see
3234-
<xref linkend="sql-grant" endterm="sql-grant-title"> and
3235-
<xref linkend="sql-revoke" endterm="sql-revoke-title">
3234+
<xref linkend="sql-grant"> and
3235+
<xref linkend="sql-revoke">
32363236
for details
32373237
</entry>
32383238
</row>
@@ -3290,8 +3290,8 @@
32903290
<entry></entry>
32913291
<entry>
32923292
Access privileges; see
3293-
<xref linkend="sql-grant" endterm="sql-grant-title"> and
3294-
<xref linkend="sql-revoke" endterm="sql-revoke-title">
3293+
<xref linkend="sql-grant"> and
3294+
<xref linkend="sql-revoke">
32953295
for details
32963296
</entry>
32973297
</row>
@@ -3418,7 +3418,7 @@
34183418

34193419
<para>
34203420
The catalog <structname>pg_operator</> stores information about operators.
3421-
See <xref linkend="sql-createoperator" endterm="sql-createoperator-title">
3421+
See <xref linkend="sql-createoperator">
34223422
and <xref linkend="xoper"> for more information.
34233423
</para>
34243424

@@ -3745,7 +3745,7 @@
37453745

37463746
<para>
37473747
The catalog <structname>pg_proc</> stores information about functions (or procedures).
3748-
See <xref linkend="sql-createfunction" endterm="sql-createfunction-title">
3748+
See <xref linkend="sql-createfunction">
37493749
and <xref linkend="xfunc"> for more information.
37503750
</para>
37513751

@@ -4011,8 +4011,8 @@
40114011
<entry></entry>
40124012
<entry>
40134013
Access privileges; see
4014-
<xref linkend="sql-grant" endterm="sql-grant-title"> and
4015-
<xref linkend="sql-revoke" endterm="sql-revoke-title">
4014+
<xref linkend="sql-grant"> and
4015+
<xref linkend="sql-revoke">
40164016
for details
40174017
</entry>
40184018
</row>
@@ -4368,8 +4368,7 @@
43684368
<para>
43694369
The catalog <structname>pg_shdescription</structname> stores optional
43704370
descriptions (comments) for shared database objects. Descriptions can be
4371-
manipulated with the <xref linkend="sql-comment"
4372-
endterm="sql-comment-title"> command and viewed with
4371+
manipulated with the <xref linkend="sql-comment"> command and viewed with
43734372
<application>psql</application>'s <literal>\d</literal> commands.
43744373
</para>
43754374

@@ -4437,7 +4436,7 @@
44374436
<para>
44384437
The catalog <structname>pg_statistic</structname> stores
44394438
statistical data about the contents of the database. Entries are
4440-
created by <xref linkend="sql-analyze" endterm="sql-analyze-title">
4439+
created by <xref linkend="sql-analyze">
44414440
and subsequently used by the query planner. Note that all the
44424441
statistical data is inherently approximate, even assuming that it
44434442
is up-to-date.
@@ -4668,8 +4667,8 @@
46684667
<entry></entry>
46694668
<entry>
46704669
Access privileges; see
4671-
<xref linkend="sql-grant" endterm="sql-grant-title"> and
4672-
<xref linkend="sql-revoke" endterm="sql-revoke-title">
4670+
<xref linkend="sql-grant"> and
4671+
<xref linkend="sql-revoke">
46734672
for details
46744673
</entry>
46754674
</row>
@@ -4697,7 +4696,7 @@
46974696

46984697
<para>
46994698
The catalog <structname>pg_trigger</structname> stores triggers on tables.
4700-
See <xref linkend="sql-createtrigger" endterm="sql-createtrigger-title">
4699+
See <xref linkend="sql-createtrigger">
47014700
for more information.
47024701
</para>
47034702

@@ -5250,9 +5249,9 @@
52505249
<para>
52515250
The catalog <structname>pg_type</structname> stores information about data
52525251
types. Base types and enum types (scalar types) are created with
5253-
<xref linkend="sql-createtype" endterm="sql-createtype-title">, and
5252+
<xref linkend="sql-createtype">, and
52545253
domains with
5255-
<xref linkend="sql-createdomain" endterm="sql-createdomain-title">.
5254+
<xref linkend="sql-createdomain">.
52565255
A composite type is automatically created for each table in the database, to
52575256
represent the row structure of the table. It is also possible to create
52585257
composite types with <command>CREATE TYPE AS</command>.
@@ -5917,7 +5916,7 @@
59175916
<itemizedlist>
59185917
<listitem>
59195918
<para>
5920-
via the <xref linkend="sql-declare" endterm="sql-declare-title">
5919+
via the <xref linkend="sql-declare">
59215920
statement in SQL
59225921
</para>
59235922
</listitem>
@@ -6414,17 +6413,15 @@
64146413
<para>
64156414
The <structname>pg_prepared_statements</structname> view displays
64166415
all the prepared statements that are available in the current
6417-
session. See <xref linkend="sql-prepare"
6418-
endterm="sql-prepare-title"> for more information about prepared
6416+
session. See <xref linkend="sql-prepare"> for more information about prepared
64196417
statements.
64206418
</para>
64216419

64226420
<para>
64236421
<structname>pg_prepared_statements</structname> contains one row
64246422
for each prepared statement. Rows are added to the view when a new
64256423
prepared statement is created and removed when a prepared statement
6426-
is released (for example, via the <xref linkend="sql-deallocate"
6427-
endterm="sql-deallocate-title"> command).
6424+
is released (for example, via the <xref linkend="sql-deallocate"> command).
64286425
</para>
64296426

64306427
<table>
@@ -6504,8 +6501,7 @@
65046501
<para>
65056502
The view <structname>pg_prepared_xacts</structname> displays
65066503
information about transactions that are currently prepared for two-phase
6507-
commit (see <xref linkend="sql-prepare-transaction"
6508-
endterm="sql-prepare-transaction-title"> for details).
6504+
commit (see <xref linkend="sql-prepare-transaction"> for details).
65096505
</para>
65106506

65116507
<para>
@@ -6780,8 +6776,8 @@
67806776
<para>
67816777
The view <structname>pg_settings</structname> provides access to
67826778
run-time parameters of the server. It is essentially an alternative
6783-
interface to the <xref linkend="sql-show" endterm="sql-show-title">
6784-
and <xref linkend="sql-set" endterm="sql-set-title"> commands.
6779+
interface to the <xref linkend="sql-show">
6780+
and <xref linkend="sql-set"> commands.
67856781
It also provides access to some facts about each parameter that are
67866782
not directly available from <command>SHOW</>, such as minimum and
67876783
maximum values.
@@ -6900,7 +6896,7 @@
69006896
The <structname>pg_settings</structname> view cannot be inserted into or
69016897
deleted from, but it can be updated. An <command>UPDATE</command> applied
69026898
to a row of <structname>pg_settings</structname> is equivalent to executing
6903-
the <xref linkend="sql-set" endterm="sql-set-title"> command on that named
6899+
the <xref linkend="sql-set"> command on that named
69046900
parameter. The change only affects the value used by the current
69056901
session. If an <command>UPDATE</command> is issued within a transaction
69066902
that is later aborted, the effects of the <command>UPDATE</command> command

0 commit comments

Comments
 (0)