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

Commit 170d11b

Browse files
committed
Fix and improve several places in the docs
This adds some missing markups, fixes a couple of incorrect ones and clarifies some documentation in various places. Author: Liudmila Mantrova Discussion: https://postgr.es/m/a068f947-7a51-5df1-b3fd-1a131ae5c044@postgrespro.ru Backpatch-through: 12
1 parent 5b51bbf commit 170d11b

8 files changed

+26
-29
lines changed

doc/src/sgml/backup.sgml

+7-7
Original file line numberDiff line numberDiff line change
@@ -962,10 +962,10 @@ SELECT * FROM pg_stop_backup(false, true);
962962
The process for an exclusive backup is mostly the same as for a
963963
non-exclusive one, but it differs in a few key steps. This type of
964964
backup can only be taken on a primary and does not allow concurrent
965-
backups. Moreover, because it writes a backup_label file on the
966-
master, it can cause the master to fail to restart automatically after
967-
a crash. On the other hand, the erroneous removal of a backup_label
968-
file from a backup or standby is a common mistake which can result
965+
backups. Moreover, because it creates a backup label file, as
966+
described below, it can block automatic restart of the master server
967+
after a crash. On the other hand, the erroneous removal of this
968+
file from a backup or standby is a common mistake, which can result
969969
in serious data corruption. If it is necessary to use this method,
970970
the following steps may be used.
971971
</para>
@@ -1025,10 +1025,10 @@ SELECT pg_start_backup('label', true);
10251025
</para>
10261026
<para>
10271027
As noted above, if the server crashes during the backup it may not be
1028-
possible to restart until the <literal>backup_label</literal> file has
1028+
possible to restart until the <filename>backup_label</filename> file has
10291029
been manually deleted from the <envar>PGDATA</envar> directory. Note
10301030
that it is very important to never remove the
1031-
<literal>backup_label</literal> file when restoring a backup, because
1031+
<filename>backup_label</filename> file when restoring a backup, because
10321032
this will result in corruption. Confusion about when it is appropriate
10331033
to remove this file is a common cause of data corruption when using this
10341034
method; be very certain that you remove the file only on an existing
@@ -1075,7 +1075,7 @@ SELECT pg_stop_backup();
10751075
lack of disk space, failure to call <function>pg_stop_backup</function>
10761076
will leave the server in backup mode indefinitely, causing future backups
10771077
to fail and increasing the risk of a restart failure during the time that
1078-
<literal>backup_label</literal> exists.
1078+
<filename>backup_label</filename> exists.
10791079
</para>
10801080
</listitem>
10811081
</orderedlist>

doc/src/sgml/biblio.sgml

+3-6
Original file line numberDiff line numberDiff line change
@@ -137,14 +137,11 @@
137137
</biblioentry>
138138

139139
<biblioentry id="sqltr-19075-6">
140-
<title>SQL Technical Report</title>
140+
<title><ulink url="http://standards.iso.org/ittf/PubliclyAvailableStandards/c067367_ISO_IEC_TR_19075-6_2017.zip">SQL Technical Report</ulink></title>
141141
<subtitle>Part 6: SQL support for JavaScript Object
142142
Notation (JSON)</subtitle>
143-
<edition>First Edition.</edition>
144-
<biblioid>
145-
<ulink url="http://standards.iso.org/ittf/PubliclyAvailableStandards/c067367_ISO_IEC_TR_19075-6_2017.zip"></ulink>.
146-
</biblioid>
147-
<pubdate>2017.</pubdate>
143+
<edition>First Edition</edition>
144+
<pubdate>2017</pubdate>
148145
</biblioentry>
149146

150147
</bibliodiv>

doc/src/sgml/ref/alter_foreign_table.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -227,8 +227,8 @@ ALTER FOREIGN TABLE [ IF EXISTS ] <replaceable class="parameter">name</replaceab
227227
<listitem>
228228
<para>
229229
Backward compatibility syntax for removing the <literal>oid</literal>
230-
system column. As oid system columns cannot be added anymore, this never
231-
has an effect.
230+
system column. As <literal>oid</literal> system columns cannot be added
231+
anymore, this never has an effect.
232232
</para>
233233
</listitem>
234234
</varlistentry>

doc/src/sgml/ref/pg_checksums.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ PostgreSQL documentation
120120
to be written safely to disk. This option causes
121121
<command>pg_checksums</command> to return without waiting, which is
122122
faster, but means that a subsequent operating system crash can leave
123-
the updated data folder corrupt. Generally, this option is useful
123+
the updated data directory corrupt. Generally, this option is useful
124124
for testing but should not be used on a production installation.
125125
This option has no effect when using <literal>--check</literal>.
126126
</para>

doc/src/sgml/ref/pg_dump.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -749,7 +749,7 @@ PostgreSQL documentation
749749
<term><option>--extra-float-digits=<replaceable class="parameter">ndigits</replaceable></option></term>
750750
<listitem>
751751
<para>
752-
Use the specified value of extra_float_digits when dumping
752+
Use the specified value of <option>extra_float_digits</option> when dumping
753753
floating-point data, instead of the maximum available precision.
754754
Routine dumps made for backup purposes should not use this option.
755755
</para>

doc/src/sgml/ref/pg_rewind.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ PostgreSQL documentation
184184
to be written safely to disk. This option causes
185185
<command>pg_rewind</command> to return without waiting, which is
186186
faster, but means that a subsequent operating system crash can leave
187-
the synchronized data folder corrupt. Generally, this option is
187+
the synchronized data directory corrupt. Generally, this option is
188188
useful for testing but should not be used when creating a production
189189
installation.
190190
</para>

doc/src/sgml/ref/pgbench.sgml

+4-4
Original file line numberDiff line numberDiff line change
@@ -474,10 +474,10 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
474474
</listitem>
475475
</itemizedlist>
476476

477-
Because in "prepared" mode <application>pgbench</application> reuses
478-
the parse analysis result for the second and subsequent query
479-
iteration, <application>pgbench</application> runs faster in the
480-
prepared mode than in other modes.
477+
In the <literal>prepared</literal> mode, <application>pgbench</application>
478+
reuses the parse analysis result starting from the second query
479+
iteration, so <application>pgbench</application> runs faster
480+
than in other modes.
481481
</para>
482482
<para>
483483
The default is simple query protocol. (See <xref linkend="protocol"/>

doc/src/sgml/ref/reindex.sgml

+7-7
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ REINDEX [ ( VERBOSE ) ] { INDEX | TABLE | SCHEMA | DATABASE | SYSTEM } [ CONCURR
156156
<para>
157157
When this option is used, <productname>PostgreSQL</productname> will rebuild the
158158
index without taking any locks that prevent concurrent inserts,
159-
updates, or deletes on the table; whereas a standard reindex build
159+
updates, or deletes on the table; whereas a standard index rebuild
160160
locks out writes (but not reads) on the table until it's done.
161161
There are several caveats to be aware of when using this option
162162
&mdash; see <xref linkend="sql-reindex-concurrently"
@@ -280,12 +280,12 @@ REINDEX [ ( VERBOSE ) ] { INDEX | TABLE | SCHEMA | DATABASE | SYSTEM } [ CONCURR
280280
of writes. This method is invoked by specifying the
281281
<literal>CONCURRENTLY</literal> option of <command>REINDEX</command>. When this option
282282
is used, <productname>PostgreSQL</productname> must perform two scans of the table
283-
for each index that needs to be rebuild and in addition it must wait for
284-
all existing transactions that could potentially use the index to
285-
terminate. This method requires more total work than a standard index
283+
for each index that needs to be rebuilt and wait for termination of
284+
all existing transactions that could potentially use the index.
285+
This method requires more total work than a standard index
286286
rebuild and takes significantly longer to complete as it needs to wait
287287
for unfinished transactions that might modify the index. However, since
288-
it allows normal operations to continue while the index is rebuilt, this
288+
it allows normal operations to continue while the index is being rebuilt, this
289289
method is useful for rebuilding indexes in a production environment. Of
290290
course, the extra CPU, memory and I/O load imposed by the index rebuild
291291
may slow down other operations.
@@ -442,8 +442,8 @@ broken_db=&gt; \q
442442
</programlisting></para>
443443

444444
<para>
445-
Rebuild a table while authorizing read and write operations on involved
446-
relations when performed:
445+
Rebuild indexes for a table, without blocking read and write operations
446+
on involved relations while reindexing is in progress:
447447

448448
<programlisting>
449449
REINDEX TABLE CONCURRENTLY my_broken_table;

0 commit comments

Comments
 (0)