Change true/false to on/off.

We prefer to use on/off than true/false for boolean configuration
parameters in the documentation, but there were a few places where
true/false were still used.

Dicussion: https://postgr.es/m/20181202.072508.618341295047874293.t-ishii%40sraoss.co.jp
This commit is contained in:
Tatsuo Ishii 2018-12-06 12:15:15 +09:00
parent 71a05b2232
commit 228b0485f4
1 changed files with 13 additions and 13 deletions

View File

@ -1249,7 +1249,7 @@ include_dir 'conf.d'
than the client's. than the client's.
This parameter can only be set in the <filename>postgresql.conf</filename> This parameter can only be set in the <filename>postgresql.conf</filename>
file or on the server command line. file or on the server command line.
The default is <literal>true</literal>. The default is <literal>on</literal>.
</para> </para>
<para> <para>
@ -1404,12 +1404,12 @@ include_dir 'conf.d'
This parameter determines whether the passphrase command set by This parameter determines whether the passphrase command set by
<varname>ssl_passphrase_command</varname> will also be called during a <varname>ssl_passphrase_command</varname> will also be called during a
configuration reload if a key file needs a passphrase. If this configuration reload if a key file needs a passphrase. If this
parameter is false (the default), then parameter is off (the default), then
<varname>ssl_passphrase_command</varname> will be ignored during a <varname>ssl_passphrase_command</varname> will be ignored during a
reload and the SSL configuration will not be reloaded if a passphrase reload and the SSL configuration will not be reloaded if a passphrase
is needed. That setting is appropriate for a command that requires a is needed. That setting is appropriate for a command that requires a
TTY for prompting, which might not be available when the server is TTY for prompting, which might not be available when the server is
running. Setting this parameter to true might be appropriate if the running. Setting this parameter to on might be appropriate if the
passphrase is obtained from a file, for example. passphrase is obtained from a file, for example.
</para> </para>
<para> <para>
@ -3330,14 +3330,14 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
<listitem> <listitem>
<para> <para>
Specifies whether to stop just after the specified recovery target Specifies whether to stop just after the specified recovery target
(<literal>true</literal>), or just before the recovery target (<literal>on</literal>), or just before the recovery target
(<literal>false</literal>). (<literal>off</literal>).
Applies when <xref linkend="guc-recovery-target-lsn"/>, Applies when <xref linkend="guc-recovery-target-lsn"/>,
<xref linkend="guc-recovery-target-time"/>, or <xref linkend="guc-recovery-target-time"/>, or
<xref linkend="guc-recovery-target-xid"/> is specified. <xref linkend="guc-recovery-target-xid"/> is specified.
This setting controls whether transactions This setting controls whether transactions
having exactly the target WAL location (LSN), commit time, or transaction ID, respectively, will having exactly the target WAL location (LSN), commit time, or transaction ID, respectively, will
be included in the recovery. Default is <literal>true</literal>. be included in the recovery. Default is <literal>on</literal>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -8675,8 +8675,8 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
</term> </term>
<listitem> <listitem>
<para> <para>
If true, any error will terminate the current session. By default, If on, any error will terminate the current session. By default,
this is set to false, so that only FATAL errors will terminate the this is set to off, so that only FATAL errors will terminate the
session. session.
</para> </para>
</listitem> </listitem>
@ -8690,9 +8690,9 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
</term> </term>
<listitem> <listitem>
<para> <para>
When set to true, which is the default, <productname>PostgreSQL</productname> When set to on, which is the default, <productname>PostgreSQL</productname>
will automatically reinitialize after a backend crash. Leaving this will automatically reinitialize after a backend crash. Leaving this
value set to true is normally the best way to maximize the availability value set to on is normally the best way to maximize the availability
of the database. However, in some circumstances, such as when of the database. However, in some circumstances, such as when
<productname>PostgreSQL</productname> is being invoked by clusterware, it may be <productname>PostgreSQL</productname> is being invoked by clusterware, it may be
useful to disable the restart so that the clusterware can gain useful to disable the restart so that the clusterware can gain
@ -8709,7 +8709,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
</term> </term>
<listitem> <listitem>
<para> <para>
When set to false, which is the default, <productname>PostgreSQL</productname> When set to off, which is the default, <productname>PostgreSQL</productname>
will raise a PANIC-level error on failure to flush modified data files will raise a PANIC-level error on failure to flush modified data files
to the filesystem. This causes the database server to crash. to the filesystem. This causes the database server to crash.
</para> </para>
@ -8724,9 +8724,9 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
faulty hardware. faulty hardware.
</para> </para>
<para> <para>
If set to true, <productname>PostgreSQL</productname> will instead If set to on, <productname>PostgreSQL</productname> will instead
report an error but continue to run so that the data flushing report an error but continue to run so that the data flushing
operation can be retried in a later checkpoint. Only set it to true operation can be retried in a later checkpoint. Only set it to on
after investigating the operating system's treatment of buffered data after investigating the operating system's treatment of buffered data
in case of write-back failure. in case of write-back failure.
</para> </para>