doc: Move remove_temp_files_after_crash to section for developer options

The main goal of this option is to allow inspecting temporary files for
debugging purposes, so moving the parameter there is natural.

Oversight in cd91de0.

Reported-by: Justin Pryzby
Author: Euler Taveira
Discussion: https://postgr.es/m/20210612004347.GP16435@telsasoft.com
This commit is contained in:
Michael Paquier 2021-06-25 08:40:16 +09:00
parent 9b4e4cfe66
commit 797b0fc0b0
3 changed files with 22 additions and 26 deletions

View File

@ -9863,28 +9863,6 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry id="guc-remove-temp-files-after-crash" xreflabel="remove_temp_files_after_crash">
<term><varname>remove_temp_files_after_crash</varname> (<type>boolean</type>)
<indexterm>
<primary><varname>remove_temp_files_after_crash</varname> configuration parameter</primary>
</indexterm>
</term>
<listitem>
<para>
When set to <literal>on</literal>, which is the default,
<productname>PostgreSQL</productname> will automatically remove
temporary files after a backend crash. If disabled, the files will be
retained and may be used for debugging, for example. Repeated crashes
may however result in accumulation of useless files.
</para>
<para>
This parameter can only be set in the <filename>postgresql.conf</filename>
file or on the server command line.
</para>
</listitem>
</varlistentry>
<varlistentry id="guc-data-sync-retry" xreflabel="data_sync_retry"> <varlistentry id="guc-data-sync-retry" xreflabel="data_sync_retry">
<term><varname>data_sync_retry</varname> (<type>boolean</type>) <term><varname>data_sync_retry</varname> (<type>boolean</type>)
<indexterm> <indexterm>
@ -10912,6 +10890,25 @@ LOG: CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1)
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry id="guc-remove-temp-files-after-crash" xreflabel="remove_temp_files_after_crash">
<term><varname>remove_temp_files_after_crash</varname> (<type>boolean</type>)
<indexterm>
<primary><varname>remove_temp_files_after_crash</varname> configuration parameter</primary>
</indexterm>
</term>
<listitem>
<para>
When set to <literal>on</literal>, which is the default,
<productname>PostgreSQL</productname> will automatically remove
temporary files after a backend crash. If disabled, the files will be
retained and may be used for debugging, for example. Repeated crashes
may however result in accumulation of useless files. This parameter
can only be set in the <filename>postgresql.conf</filename> file or on
the server command line.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</sect1> </sect1>
<sect1 id="runtime-config-short"> <sect1 id="runtime-config-short">

View File

@ -1404,9 +1404,10 @@ static struct config_bool ConfigureNamesBool[] =
NULL, NULL, NULL NULL, NULL, NULL
}, },
{ {
{"remove_temp_files_after_crash", PGC_SIGHUP, ERROR_HANDLING_OPTIONS, {"remove_temp_files_after_crash", PGC_SIGHUP, DEVELOPER_OPTIONS,
gettext_noop("Remove temporary files after backend crash."), gettext_noop("Remove temporary files after backend crash."),
NULL NULL,
GUC_NOT_IN_SAMPLE
}, },
&remove_temp_files_after_crash, &remove_temp_files_after_crash,
true, true,

View File

@ -768,8 +768,6 @@
#exit_on_error = off # terminate session on any error? #exit_on_error = off # terminate session on any error?
#restart_after_crash = on # reinitialize after backend crash? #restart_after_crash = on # reinitialize after backend crash?
#remove_temp_files_after_crash = on # remove temporary files after
# backend crash?
#data_sync_retry = off # retry or panic on failure to fsync #data_sync_retry = off # retry or panic on failure to fsync
# data? # data?
# (change requires restart) # (change requires restart)