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

Commit c29c578

Browse files
committed
Don't use SGML empty tags
For DocBook XML compatibility, don't use SGML empty tags (</>) anymore, replace by the full tag name. Add a warning option to catch future occurrences. Alexander Lakhin, Jürgen Purtz
1 parent 6ecabea commit c29c578

File tree

337 files changed

+31636
-31635
lines changed

Some content is hidden

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

337 files changed

+31636
-31635
lines changed

doc/src/sgml/Makefile

+2-1
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,11 @@ ALLSGML := $(wildcard $(srcdir)/*.sgml $(srcdir)/ref/*.sgml) $(GENERATED_SGML)
6666
# Enable some extra warnings
6767
# -wfully-tagged needed to throw a warning on missing tags
6868
# for older tool chains, 2007-08-31
69-
override SPFLAGS += -wall -wno-unused-param -wno-empty -wfully-tagged
69+
override SPFLAGS += -wall -wno-unused-param -wfully-tagged
7070
# Additional warnings for XML compatibility. The conditional is meant
7171
# to detect whether we are using OpenSP rather than the ancient
7272
# original SP.
73+
override SPFLAGS += -wempty
7374
ifneq (,$(filter o%,$(notdir $(OSX))))
7475
override SPFLAGS += -wdata-delim -winstance-ignore-ms -winstance-include-ms -winstance-param-entity
7576
endif

doc/src/sgml/acronyms.sgml

+9-9
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
<title>Acronyms</title>
55

66
<para>
7-
This is a list of acronyms commonly used in the <productname>PostgreSQL</>
8-
documentation and in discussions about <productname>PostgreSQL</>.
7+
This is a list of acronyms commonly used in the <productname>PostgreSQL</productname>
8+
documentation and in discussions about <productname>PostgreSQL</productname>.
99

1010
<variablelist>
1111

@@ -153,7 +153,7 @@
153153
<ulink
154154
url="http://en.wikipedia.org/wiki/Data_Definition_Language">Data
155155
Definition Language</ulink>, SQL commands such as <command>CREATE
156-
TABLE</>, <command>ALTER USER</>
156+
TABLE</command>, <command>ALTER USER</command>
157157
</para>
158158
</listitem>
159159
</varlistentry>
@@ -164,8 +164,8 @@
164164
<para>
165165
<ulink
166166
url="http://en.wikipedia.org/wiki/Data_Manipulation_Language">Data
167-
Manipulation Language</ulink>, SQL commands such as <command>INSERT</>,
168-
<command>UPDATE</>, <command>DELETE</>
167+
Manipulation Language</ulink>, SQL commands such as <command>INSERT</command>,
168+
<command>UPDATE</command>, <command>DELETE</command>
169169
</para>
170170
</listitem>
171171
</varlistentry>
@@ -281,7 +281,7 @@
281281
<listitem>
282282
<para>
283283
<link linkend="config-setting">Grand Unified Configuration</link>,
284-
the <productname>PostgreSQL</> subsystem that handles server configuration
284+
the <productname>PostgreSQL</productname> subsystem that handles server configuration
285285
</para>
286286
</listitem>
287287
</varlistentry>
@@ -384,7 +384,7 @@
384384
<term><acronym>LSN</acronym></term>
385385
<listitem>
386386
<para>
387-
Log Sequence Number, see <link linkend="datatype-pg-lsn"><type>pg_lsn</></link>
387+
Log Sequence Number, see <link linkend="datatype-pg-lsn"><type>pg_lsn</type></link>
388388
and <link linkend="wal-internals">WAL Internals</link>.
389389
</para>
390390
</listitem>
@@ -486,7 +486,7 @@
486486
<term><acronym>PGSQL</acronym></term>
487487
<listitem>
488488
<para>
489-
<link linkend="postgres"><productname>PostgreSQL</></link>
489+
<link linkend="postgres"><productname>PostgreSQL</productname></link>
490490
</para>
491491
</listitem>
492492
</varlistentry>
@@ -495,7 +495,7 @@
495495
<term><acronym>PGXS</acronym></term>
496496
<listitem>
497497
<para>
498-
<link linkend="extend-pgxs"><productname>PostgreSQL</> Extension System</link>
498+
<link linkend="extend-pgxs"><productname>PostgreSQL</productname> Extension System</link>
499499
</para>
500500
</listitem>
501501
</varlistentry>

doc/src/sgml/adminpack.sgml

+27-27
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
</indexterm>
99

1010
<para>
11-
<filename>adminpack</> provides a number of support functions which
12-
<application>pgAdmin</> and other administration and management tools can
11+
<filename>adminpack</filename> provides a number of support functions which
12+
<application>pgAdmin</application> and other administration and management tools can
1313
use to provide additional functionality, such as remote management
1414
of server log files.
1515
Use of all these functions is restricted to superusers.
@@ -25,7 +25,7 @@
2525
</para>
2626

2727
<table id="functions-adminpack-table">
28-
<title><filename>adminpack</> Functions</title>
28+
<title><filename>adminpack</filename> Functions</title>
2929
<tgroup cols="3">
3030
<thead>
3131
<row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry>
@@ -58,7 +58,7 @@
5858
<entry><function>pg_catalog.pg_logdir_ls()</function></entry>
5959
<entry><type>setof record</type></entry>
6060
<entry>
61-
List the log files in the <varname>log_directory</> directory
61+
List the log files in the <varname>log_directory</varname> directory
6262
</entry>
6363
</row>
6464
</tbody>
@@ -69,9 +69,9 @@
6969
<primary>pg_file_write</primary>
7070
</indexterm>
7171
<para>
72-
<function>pg_file_write</> writes the specified <parameter>data</> into
73-
the file named by <parameter>filename</>. If <parameter>append</> is
74-
false, the file must not already exist. If <parameter>append</> is true,
72+
<function>pg_file_write</function> writes the specified <parameter>data</parameter> into
73+
the file named by <parameter>filename</parameter>. If <parameter>append</parameter> is
74+
false, the file must not already exist. If <parameter>append</parameter> is true,
7575
the file can already exist, and will be appended to if so.
7676
Returns the number of bytes written.
7777
</para>
@@ -80,15 +80,15 @@
8080
<primary>pg_file_rename</primary>
8181
</indexterm>
8282
<para>
83-
<function>pg_file_rename</> renames a file. If <parameter>archivename</>
84-
is omitted or NULL, it simply renames <parameter>oldname</>
85-
to <parameter>newname</> (which must not already exist).
86-
If <parameter>archivename</> is provided, it first
87-
renames <parameter>newname</> to <parameter>archivename</> (which must
88-
not already exist), and then renames <parameter>oldname</>
89-
to <parameter>newname</>. In event of failure of the second rename step,
90-
it will try to rename <parameter>archivename</> back
91-
to <parameter>newname</> before reporting the error.
83+
<function>pg_file_rename</function> renames a file. If <parameter>archivename</parameter>
84+
is omitted or NULL, it simply renames <parameter>oldname</parameter>
85+
to <parameter>newname</parameter> (which must not already exist).
86+
If <parameter>archivename</parameter> is provided, it first
87+
renames <parameter>newname</parameter> to <parameter>archivename</parameter> (which must
88+
not already exist), and then renames <parameter>oldname</parameter>
89+
to <parameter>newname</parameter>. In event of failure of the second rename step,
90+
it will try to rename <parameter>archivename</parameter> back
91+
to <parameter>newname</parameter> before reporting the error.
9292
Returns true on success, false if the source file(s) are not present or
9393
not writable; other cases throw errors.
9494
</para>
@@ -97,19 +97,19 @@
9797
<primary>pg_file_unlink</primary>
9898
</indexterm>
9999
<para>
100-
<function>pg_file_unlink</> removes the specified file.
100+
<function>pg_file_unlink</function> removes the specified file.
101101
Returns true on success, false if the specified file is not present
102-
or the <function>unlink()</> call fails; other cases throw errors.
102+
or the <function>unlink()</function> call fails; other cases throw errors.
103103
</para>
104104

105105
<indexterm>
106106
<primary>pg_logdir_ls</primary>
107107
</indexterm>
108108
<para>
109-
<function>pg_logdir_ls</> returns the start timestamps and path
109+
<function>pg_logdir_ls</function> returns the start timestamps and path
110110
names of all the log files in the <xref linkend="guc-log-directory">
111111
directory. The <xref linkend="guc-log-filename"> parameter must have its
112-
default setting (<literal>postgresql-%Y-%m-%d_%H%M%S.log</>) to use this
112+
default setting (<literal>postgresql-%Y-%m-%d_%H%M%S.log</literal>) to use this
113113
function.
114114
</para>
115115

@@ -119,12 +119,12 @@
119119
and should not be used in new applications; instead use those shown
120120
in <xref linkend="functions-admin-signal-table">
121121
and <xref linkend="functions-admin-genfile-table">. These functions are
122-
provided in <filename>adminpack</> only for compatibility with old
123-
versions of <application>pgAdmin</>.
122+
provided in <filename>adminpack</filename> only for compatibility with old
123+
versions of <application>pgAdmin</application>.
124124
</para>
125125

126126
<table id="functions-adminpack-deprecated-table">
127-
<title>Deprecated <filename>adminpack</> Functions</title>
127+
<title>Deprecated <filename>adminpack</filename> Functions</title>
128128
<tgroup cols="3">
129129
<thead>
130130
<row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry>
@@ -136,22 +136,22 @@
136136
<entry><function>pg_catalog.pg_file_read(filename text, offset bigint, nbytes bigint)</function></entry>
137137
<entry><type>text</type></entry>
138138
<entry>
139-
Alternate name for <function>pg_read_file()</>
139+
Alternate name for <function>pg_read_file()</function>
140140
</entry>
141141
</row>
142142
<row>
143143
<entry><function>pg_catalog.pg_file_length(filename text)</function></entry>
144144
<entry><type>bigint</type></entry>
145145
<entry>
146-
Same as <structfield>size</> column returned
147-
by <function>pg_stat_file()</>
146+
Same as <structfield>size</structfield> column returned
147+
by <function>pg_stat_file()</function>
148148
</entry>
149149
</row>
150150
<row>
151151
<entry><function>pg_catalog.pg_logfile_rotate()</function></entry>
152152
<entry><type>integer</type></entry>
153153
<entry>
154-
Alternate name for <function>pg_rotate_logfile()</>, but note that it
154+
Alternate name for <function>pg_rotate_logfile()</function>, but note that it
155155
returns integer 0 or 1 rather than <type>boolean</type>
156156
</entry>
157157
</row>

0 commit comments

Comments
 (0)