Skip to content

Commit e8e2999

Browse files
peterepetere
committed
Order some new options on man pages more sensibly, minor improvements
1 parent 104184d commit e8e2999

10 files changed

+100
-97
lines changed

‎doc/src/sgml/ref/alter_database.sgml

+12-12
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> [ [ WITH ] <rep
2525

2626
<phrase>where <replaceable class="PARAMETER">option</replaceable> can be:</phrase>
2727

28-
IS_TEMPLATE <replaceable class="PARAMETER">istemplate</replaceable>
2928
ALLOW_CONNECTIONS <replaceable class="PARAMETER">allowconn</replaceable>
3029
CONNECTION LIMIT <replaceable class="PARAMETER">connlimit</replaceable>
30+
IS_TEMPLATE <replaceable class="PARAMETER">istemplate</replaceable>
3131

3232
ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> RENAME TO <replaceable>new_name</replaceable>
3333

@@ -110,17 +110,6 @@ ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> RESET ALL
110110
</listitem>
111111
</varlistentry>
112112

113-
<varlistentry>
114-
<term><replaceable class="parameter">istemplate</replaceable></term>
115-
<listitem>
116-
<para>
117-
If true, then this database can be cloned by any user with <literal>CREATEDB</literal>
118-
privileges; if false, then only superusers or the owner of the
119-
database can clone it.
120-
</para>
121-
</listitem>
122-
</varlistentry>
123-
124113
<varlistentry>
125114
<term><replaceable class="parameter">allowconn</replaceable></term>
126115
<listitem>
@@ -140,6 +129,17 @@ ALTER DATABASE <replaceable class="PARAMETER">name</replaceable> RESET ALL
140129
</listitem>
141130
</varlistentry>
142131

132+
<varlistentry>
133+
<term><replaceable class="parameter">istemplate</replaceable></term>
134+
<listitem>
135+
<para>
136+
If true, then this database can be cloned by any user with <literal>CREATEDB</literal>
137+
privileges; if false, then only superusers or the owner of the
138+
database can clone it.
139+
</para>
140+
</listitem>
141+
</varlistentry>
142+
143143
<varlistentry>
144144
<term><replaceable>new_name</replaceable></term>
145145
<listitem>

‎doc/src/sgml/ref/create_database.sgml

+12-12
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ CREATE DATABASE <replaceable class="PARAMETER">name</replaceable>
2828
[ LC_COLLATE [=] <replaceable class="parameter">lc_collate</replaceable> ]
2929
[ LC_CTYPE [=] <replaceable class="parameter">lc_ctype</replaceable> ]
3030
[ TABLESPACE [=] <replaceable class="parameter">tablespace_name</replaceable> ]
31-
[ IS_TEMPLATE [=] <replaceable class="parameter">istemplate</replaceable> ]
3231
[ ALLOW_CONNECTIONS [=] <replaceable class="parameter">allowconn</replaceable> ]
3332
[ CONNECTION LIMIT [=] <replaceable class="parameter">connlimit</replaceable> ] ]
33+
[ IS_TEMPLATE [=] <replaceable class="parameter">istemplate</replaceable> ]
3434
</synopsis>
3535
</refsynopsisdiv>
3636

@@ -149,17 +149,6 @@ CREATE DATABASE <replaceable class="PARAMETER">name</replaceable>
149149
</listitem>
150150
</varlistentry>
151151

152-
<varlistentry>
153-
<term><replaceable class="parameter">istemplate</replaceable></term>
154-
<listitem>
155-
<para>
156-
If true, then this database can be cloned by any user with <literal>CREATEDB</literal>
157-
privileges; if false (the default), then only superusers or the owner
158-
of the database can clone it.
159-
</para>
160-
</listitem>
161-
</varlistentry>
162-
163152
<varlistentry>
164153
<term><replaceable class="parameter">allowconn</replaceable></term>
165154
<listitem>
@@ -180,6 +169,17 @@ CREATE DATABASE <replaceable class="PARAMETER">name</replaceable>
180169
</para>
181170
</listitem>
182171
</varlistentry>
172+
173+
<varlistentry>
174+
<term><replaceable class="parameter">istemplate</replaceable></term>
175+
<listitem>
176+
<para>
177+
If true, then this database can be cloned by any user with <literal>CREATEDB</literal>
178+
privileges; if false (the default), then only superusers or the owner
179+
of the database can clone it.
180+
</para>
181+
</listitem>
182+
</varlistentry>
183183
</variablelist>
184184

185185
<para>

‎doc/src/sgml/ref/create_policy.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ CREATE POLICY <replaceable class="parameter">name</replaceable> ON <replaceable
3434

3535
<para>
3636
The <command>CREATE POLICY</command> command defines a new policy for a
37-
table. Note that row level security must also be enabled on the table using
37+
table. Note that row-level security must also be enabled on the table using
3838
<command>ALTER TABLE</command> in order for created policies to be applied.
3939
</para>
4040

‎doc/src/sgml/ref/pg_ctl-ref.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -427,10 +427,10 @@ PostgreSQL documentation
427427
Name of the event source for <application>pg_ctl</application> to use
428428
for logging to the event log when running as a Windows service. The
429429
default is <literal>PostgreSQL</literal>. Note that this only controls
430-
the logging from <application>pg_ctl</application> itself - once
430+
the logging from <application>pg_ctl</application> itself; once
431431
started, the server will use the event source specified
432432
by <xref linkend="guc-event-source">. Should the server fail during
433-
early startup, it may also log using the default event
433+
early startup, it might also log using the default event
434434
source <literal>PostgreSQL</literal>.
435435
</para>
436436
</listitem>

‎doc/src/sgml/ref/pg_dump.sgml

+25-25
Original file line numberDiff line numberDiff line change
@@ -688,13 +688,13 @@ PostgreSQL documentation
688688
<listitem>
689689
<para>
690690
This option is relevant only when dumping the contents of a table
691-
which has row security. By default, pg_dump will set
692-
<literal>ROW_SECURITY</literal> to <literal>OFF</literal>, to ensure
691+
which has row security. By default, <application>pg_dump</application> will set
692+
<xref linkend="guc-row-security"> to off, to ensure
693693
that all data is dumped from the table. If the user does not have
694694
sufficient privileges to bypass row security, then an error is thrown.
695695
This parameter instructs <application>pg_dump</application> to set
696-
row_security to 'ON' instead, allowing the user to dump the contents
697-
of the table which they have access to.
696+
<xref linkend="guc-row-security"> to on instead, allowing the user
697+
to dump the parts of the contents of the table that they have access to.
698698
</para>
699699

700700
</listitem>
@@ -843,27 +843,6 @@ PostgreSQL documentation
843843
</listitem>
844844
</varlistentry>
845845

846-
<varlistentry>
847-
<term><option>--snapshot=<replaceable class="parameter">snapshotname</replaceable></option></term>
848-
<listitem>
849-
<para>
850-
Use the specified synchronized snapshot when making a dump of the
851-
database (see
852-
<xref linkend="functions-snapshot-synchronization-table"> for more
853-
details).
854-
</para>
855-
<para>
856-
This option is useful when needing to synchronize the dump with
857-
a logical replication slot (see <xref linkend="logicaldecoding">)
858-
or with a concurrent session.
859-
</para>
860-
<para>
861-
In the case of a parallel dump, the snapshot name defined by this
862-
option is used rather than taking a new snapshot.
863-
</para>
864-
</listitem>
865-
</varlistentry>
866-
867846
<varlistentry>
868847
<term><option>--serializable-deferrable</option></term>
869848
<listitem>
@@ -899,6 +878,27 @@ PostgreSQL documentation
899878
</listitem>
900879
</varlistentry>
901880

881+
<varlistentry>
882+
<term><option>--snapshot=<replaceable class="parameter">snapshotname</replaceable></option></term>
883+
<listitem>
884+
<para>
885+
Use the specified synchronized snapshot when making a dump of the
886+
database (see
887+
<xref linkend="functions-snapshot-synchronization-table"> for more
888+
details).
889+
</para>
890+
<para>
891+
This option is useful when needing to synchronize the dump with
892+
a logical replication slot (see <xref linkend="logicaldecoding">)
893+
or with a concurrent session.
894+
</para>
895+
<para>
896+
In the case of a parallel dump, the snapshot name defined by this
897+
option is used rather than taking a new snapshot.
898+
</para>
899+
</listitem>
900+
</varlistentry>
901+
902902
<varlistentry>
903903
<term><option>--use-set-session-authorization</></term>
904904
<listitem>

‎doc/src/sgml/ref/pg_receivexlog.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ PostgreSQL documentation
5050

5151
<para>
5252
Unlike the standby's WAL receiver, <application>pg_receivexlog</>
53-
flushes WAL data only when a WAL file is closed, by default.
53+
by default flushes WAL data only when a WAL file is closed.
5454
<literal>--synchronous</> option must be specified to flush WAL data
5555
in real time and ensure it's safely flushed to disk.
5656
</para>

‎doc/src/sgml/ref/pg_restore.sgml

+9-9
Original file line numberDiff line numberDiff line change
@@ -481,25 +481,25 @@
481481
</varlistentry>
482482

483483
<varlistentry>
484-
<term><option>--enable-row-security</></term> <listitem>
484+
<term><option>--enable-row-security</></term>
485+
<listitem>
485486
<para>
486487
This option is relevant only when restoring the contents of a table
487-
which has row security. By default, pg_restore will set
488-
<literal>ROW_SECURITY</literal> to <literal>OFF</literal>, to ensure
488+
which has row security. By default, <application>pg_restore</application> will set
489+
<xref linkend="guc-row-security"> to off, to ensure
489490
that all data is restored in to the table. If the user does not have
490491
sufficient privileges to bypass row security, then an error is thrown.
491492
This parameter instructs <application>pg_restore</application> to set
492-
row_security to 'ON' instead, allowing the user to attempt to restore
493-
the contents of the table with row security enabled. This may still
493+
<xref linkend="guc-row-security"> to on instead, allowing the user to attempt to restore
494+
the contents of the table with row security enabled. This might still
494495
fail if the user does not have the right to insert the rows from the
495496
dump into the table.
496497
</para>
497-
498+
498499
<para>
499-
Note that this option currently also requires the dump be in INSERT
500-
format as COPY TO does not support row security.
500+
Note that this option currently also requires the dump be in <command>INSERT</command>
501+
format, as <command>COPY TO</command> does not support row security.
501502
</para>
502-
503503
</listitem>
504504
</varlistentry>
505505

‎doc/src/sgml/ref/pg_rewind.sgml

+12-9
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,16 @@ PostgreSQL documentation
8181
<filename>recovery.conf</> file in the target data directory with a
8282
suitable <varname>restore_command</>.
8383
</para>
84+
85+
<para>
86+
<application>pg_rewind</> requires that the target server either has
87+
the <xref linkend="guc-wal-log-hints"> option is enabled
88+
in <filename>postgresql.conf</> or that data checksums were enabled when
89+
the cluster was initialized with <application>initdb</>. Neither of these
90+
are currently on by default.
91+
<xref linkend="guc-full-page-writes"> must also be enabled. That is the
92+
default.
93+
</para>
8494
</refsect1>
8595

8696
<refsect1>
@@ -159,13 +169,13 @@ PostgreSQL documentation
159169
<varlistentry>
160170
<term><option>-V</option></term>
161171
<term><option>--version</option></term>
162-
<listitem><para>Display version information, then exit</para></listitem>
172+
<listitem><para>Display version information, then exit.</para></listitem>
163173
</varlistentry>
164174

165175
<varlistentry>
166176
<term><option>-?</option></term>
167177
<term><option>--help</option></term>
168-
<listitem><para>Show help, then exit</para></listitem>
178+
<listitem><para>Show help, then exit.</para></listitem>
169179
</varlistentry>
170180

171181
</variablelist>
@@ -185,13 +195,6 @@ PostgreSQL documentation
185195
<refsect1>
186196
<title>Notes</title>
187197

188-
<para>
189-
<application>pg_rewind</> requires that the <varname>wal_log_hints</>
190-
option is enabled in <filename>postgresql.conf</>, or that data checksums
191-
were enabled when the cluster was initialized with <application>initdb</>.
192-
<varname>full_page_writes</> must also be enabled.
193-
</para>
194-
195198
<refsect2>
196199
<title>How it works</title>
197200

‎doc/src/sgml/ref/pgupgrade.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -414,8 +414,8 @@ pg_upgrade.exe
414414
servers</title>
415415

416416
<para>
417-
If you have Streaming Replication (<xref
418-
linkend="streaming-replication">) or Log-Shipping (<xref
417+
If you have Streaming Replication (see <xref
418+
linkend="streaming-replication">) or Log-Shipping (see <xref
419419
linkend="warm-standby">) standby servers, follow these steps to
420420
upgrade them. You will not be running <application>pg_upgrade</>
421421
on the standby servers, but rather <application>rsync</>. Do not

‎doc/src/sgml/ref/vacuumdb.sgml

+24-24
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,30 @@ PostgreSQL documentation
133133
</listitem>
134134
</varlistentry>
135135

136+
<varlistentry>
137+
<term><option>-j <replaceable class="parameter">njobs</replaceable></option></term>
138+
<term><option>--jobs=<replaceable class="parameter">njobs</replaceable></option></term>
139+
<listitem>
140+
<para>
141+
Execute the vacuum or analyze commands in parallel by running
142+
<replaceable class="parameter">njobs</replaceable>
143+
commands simultaneously. This option reduces the time of the
144+
processing but it also increases the load on the database server.
145+
</para>
146+
<para>
147+
<application>vacuumdb</application> will open
148+
<replaceable class="parameter">njobs</replaceable> connections to the
149+
database, so make sure your <xref linkend="guc-max-connections">
150+
setting is high enough to accommodate all connections.
151+
</para>
152+
<para>
153+
Note that using this mode together with the <option>-f</option>
154+
(<literal>FULL</literal>) option might cause deadlock failures if
155+
certain system catalogs are processed in parallel.
156+
</para>
157+
</listitem>
158+
</varlistentry>
159+
136160
<varlistentry>
137161
<term><option>-q</></term>
138162
<term><option>--quiet</></term>
@@ -203,30 +227,6 @@ PostgreSQL documentation
203227
</listitem>
204228
</varlistentry>
205229

206-
<varlistentry>
207-
<term><option>-j <replaceable class="parameter">njobs</replaceable></option></term>
208-
<term><option>--jobs=<replaceable class="parameter">njobs</replaceable></option></term>
209-
<listitem>
210-
<para>
211-
Execute the vacuum or analyze commands in parallel by running
212-
<replaceable class="parameter">njobs</replaceable>
213-
commands simultaneously. This option reduces the time of the
214-
processing but it also increases the load on the database server.
215-
</para>
216-
<para>
217-
<application>vacuumdb</application> will open
218-
<replaceable class="parameter">njobs</replaceable> connections to the
219-
database, so make sure your <xref linkend="guc-max-connections">
220-
setting is high enough to accommodate all connections.
221-
</para>
222-
<para>
223-
Note that using this mode together with the <option>-f</option>
224-
(<literal>FULL</literal>) option might cause deadlock failures if
225-
certain system catalogs are processed in parallel.
226-
</para>
227-
</listitem>
228-
</varlistentry>
229-
230230
<varlistentry>
231231
<term><option>--analyze-in-stages</option></term>
232232
<listitem>

0 commit comments

Comments
 (0)