8000 doc: wording improvements · postgrespro/postgres@a978565 · GitHub
[go: up one dir, main page]

Skip to content

Commit a978565

Browse files
committed
doc: wording improvements
Discussion: https://postgr.es/m/a5180360-ec04-ac58-25ce-3d795d3d1f6c@postgrespro.ru Author: Ekaterina Kiryanova Backpatch-through: master
1 parent 5ae2087 commit a978565

13 files changed

+35
-29
lines changed

doc/src/sgml/charset.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -293,10 +293,10 @@ initdb --locale=sv_SE
293293
<para>
294294
As explained above, the environment of the operating system provides the
295295
defaults for the locales of a newly initialized database cluster. In
296-
many cases, this is enough: If the operating system is configured for
297-
the desired language/territory, then
298-
<productname>PostgreSQL</productname> will by default also behave
299-
according to that locale.
296+
many cases, this is enough: if the operating system is configured for
297+
the desired language/territory, by default
298+
<productname>PostgreSQL</productname> will also behave according
299+
to that locale.
300300
</para>
301301
</listitem>
302302

doc/src/sgml/config.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9041,7 +9041,7 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
90419041
<para>
90429042
The timeout is measured from the time a command arrives at the
90439043
server until it is completed by the server. If multiple SQL
9044-
statements appear in a single simple-Query message, the timeout
9044+
statements appear in a single simple-query message, the timeout
90459045
is applied to each statement separately.
90469046
(<productname>PostgreSQL</productname> versions before 13 usually
90479047
treated the timeout as applying to the whole query string.)

doc/src/sgml/high-availability.sgml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1359,8 +1359,8 @@ synchronous_standby_names = 'ANY 2 (s1, s2, s3)'
13591359

13601360
<para>
13611361
If you need to re-create a standby server while transactions are
1362-
waiting, make sure that the commands pg_backup_start() and
1363-
pg_backup_stop() are run in a session with
1362+
waiting, make sure that the functions <function>pg_backup_start()</function>
1363+
and <function>pg_backup_stop()</function> are run in a session with
13641364
<varname>synchronous_commit</varname> = <literal>off</literal>, otherwise those
13651365
requests will wait forever for the standby to appear.
13661366
</para>
@@ -2219,10 +2219,11 @@ HINT: You can then restart the server after making the necessary configuration
22192219
The cumulative statistics system is active during recovery. All scans,
22202220
reads, blocks, index usage, etc., will be recorded normally on the
22212221
standby. However, WAL replay will not increment relation and database
2222-
specific counters. I.e. replay will not increment pg_stat_all_tables
2223-
columns (like n_tup_ins), nor will reads or writes performed by the
2224-
startup process be tracked in the pg_statio views, nor will associated
2225-
pg_stat_database columns be incremented.
2222+
specific counters. I.e. replay will not increment
2223+
<structname>pg_stat_all_tables</structname> columns (like <structfield>n_tup_ins</structfield>),
2224+
nor will reads or writes performed by the startup process be tracked in the
2225+
<structname>pg_statio_</structname> views, nor will associated
2226+
<structname>pg_stat_database</structname> columns be incremented.
22262227
</para>
22272228

22282229
<para>

doc/src/sgml/indices.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -754,7 +754,7 @@ CREATE INDEX people_names ON people ((first_name || ' ' || last_name));
754754
<para>
755755
Index expressions are relatively expensive to maintain, because the
756756
derived expression(s) must be computed for each row insertion
757-
and <link linkend="storage-hot">non-HOT update.</link> However, the index expressions are
757+
and <link linkend="storage-hot">non-HOT update</link>. However, the index expressions are
758758
<emphasis>not</emphasis> recomputed during an indexed search, since they are
759759
already stored in the index. In both examples above, the system
760760
sees the query as just <literal>WHERE indexedcolumn = 'constant'</literal>

doc/src/sgml/logicaldecoding.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ postgres=# SELECT pg_drop_replication_slot('regression_slot');
144144
</programlisting>
145145

146146
<para>
147-
The following examples shows how logical decoding is controlled over the
147+
The following examples show how logical decoding is controlled over the
148148
streaming replication protocol, using the
149149
program <xref linkend="app-pgrecvlogical"/> included in the PostgreSQL
150150
distribution. This requires that client authentication is set up to allow

doc/src/sgml/monitoring.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser
261261
unnecessary and can be avoided by setting
262262
<varname>stats_fetch_consistency</varname> to <literal>none</literal>.
263263

264-
You can invoke <function>pg_stat_clear_snapshot</function>() to discard the
264+
You can invoke <function>pg_stat_clear_snapshot()</function> to discard the
265265
current transaction's statistics snapshot or cached values (if any). The
266266
next use of statistical information will (when in snapshot mode) cause a
267267
new snapshot to be built or (when in cache mode) accessed statistics to be

doc/src/sgml/ref/merge.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -381,9 +381,9 @@ DELETE
381381
An expression to assign to the column. If used in a
382382
<literal>WHEN MATCHED</literal> clause, the expression can use values
383383
from the original row in the target table, and values from the
384-
<literal>data_source</literal> row.
384+
<replaceable>data_source</replaceable> row.
385385
If used in a <literal>WHEN NOT MATCHED</literal> clause, the
386-
expression can use values from the <literal>data_source</literal>.
386+
expression can use values from the <replaceable>data_source</replaceable>.
387387
</para>
388388
</listitem>
389389
</varlistentry>

doc/src/sgml/ref/pg_basebackup.sgml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -422,8 +422,9 @@ PostgreSQL documentation
422422
A compression detail string can optionally be specified.
423423
If the detail string is an integer, it specifies the compression
424424
level. Otherwise, it should be a comma-separated list of items,
425-
each of the form <literal>keyword</literal> or
426-
<literal>keyword=value</literal>.
425+
each of the form
426+
<replaceable>keyword</replaceable> or
427+
<replaceable>keyword=value</replaceable>.
427428
Currently, the supported keywords are <literal>level</literal>,
428429
<literal>long</literal>, and <literal>workers</literal>.
429430
The detail string cannot be used when the compression method
@@ -1019,7 +1020,7 @@ PostgreSQL documentation
10191020
</screen></para>
10201021

10211022
<para>
1022-
To create a backup of a local server with one tar file for each tablespace
1023+
To create a backup of the local server with one tar file for each tablespace
10231024
compressed with <application>gzip</application> at level 9, stored in the
10241025
directory <filename>backup</filename>:
10251026
<screen>

doc/src/sgml/ref/pg_receivewal.sgml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,8 @@ PostgreSQL documentation
281281
A compression detail string can optionally be specified. If the
282282
detail string is an integer, it specifies the compression level.
283283
Otherwise, it should be a comma-separated list of items, each of the
284-
form <literal>keyword</literal> or <literal>keyword=value</literal>.
284+
form <replaceable>keyword</replaceable> or
285+
<replaceable>keyword=value</replaceable>.
285286
Currently, the only supported keyword is <literal>level</literal>.
286287
</para>
287288
<para>

doc/src/sgml/ref/pg_recvlogical.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ PostgreSQL documentation
274274
<listitem>
275275
<para>
276276
Enables decoding of prepared transactions. This option may only be specified with
277-
<option>--create-slot</option>
277+
<option>--create-slot</option>.
278278
</para>
279279
</listitem>
280280
</varlistentry>

0 commit comments

Comments
 (0)
0