doc: Move remove_temp_files_after_crash to section for developer options
authorMichael Paquier <michael@paquier.xyz>
Thu, 24 Jun 2021 23:40:16 +0000 (08:40 +0900)
committerMichael Paquier <michael@paquier.xyz>
Thu, 24 Jun 2021 23:40:16 +0000 (08:40 +0900)
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

doc/src/sgml/config.sgml
src/backend/utils/misc/guc.c
src/backend/utils/misc/postgresql.conf.sample

index eeba2caa43f8606f79984cb28e429a0f6c0fae9f..f5a753e5898c48a698e8341ba8e5511c1b4e10e9 100644 (file)
@@ -9863,28 +9863,6 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
       </listitem>
      </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">
       <term><varname>data_sync_retry</varname> (<type>boolean</type>)
       <indexterm>
@@ -10912,6 +10890,25 @@ LOG:  CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1)
       </listitem>
      </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>
   </sect1>
   <sect1 id="runtime-config-short">
index 68b62d523dc953d0e09239ded994595aee8ab8f6..eaeeee58a0bd83a9127e2b1c3eeee3c220b3473e 100644 (file)
@@ -1404,9 +1404,10 @@ static struct config_bool ConfigureNamesBool[] =
                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."),
-                       NULL
+                       NULL,
+                       GUC_NOT_IN_SAMPLE
                },
                &remove_temp_files_after_crash,
                true,
index ddbb6dc2be2c09e5674b5588775998f4a1228f80..a5a7174b0e751d17876292135597b1891b87d60a 100644 (file)
 
 #exit_on_error = off                   # terminate session on any error?
 #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?
                                        # (change requires restart)