pg.ddx.io  pgsql-bugs@postgresql.org mailing list archive  

help / color / mirror / Atom feed

From: Nathan Bossart <nathan@postgresql.org>
Subject: [PATCH v2 1/1] Fix documentation for wal_summary_keep_time.
Date: Mon, 8 Jan 2024 21:42:32 -0600

The documentation for this parameter lists its type as Boolean, but
it is actually an integer.  Furthermore, there is no mention of how
the value is interpreted when specified without units.  This commit
fixes these oversights in commit 174c480508.

Co-authored-by: Hubert Depesz Lubaczewski
Discussion: https://postgr.es/m/ZZwkujFihO2uqKwp%40depesz.com
---
 doc/src/sgml/config.sgml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

inline patch 1: doc/src/sgml/config.sgml (+2/-1 lines) download inline-1.patch
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index f323bba018..61038472c5 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -4179,7 +4179,7 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"'  # Windows
      </varlistentry>
 
      <varlistentry id="guc-wal-summary-keep-time" xreflabel="wal_summary_keep_time">
-      <term><varname>wal_summary_keep_time</varname> (<type>boolean</type>)
+      <term><varname>wal_summary_keep_time</varname> (<type>integer</type>)
       <indexterm>
        <primary><varname>wal_summary_keep_time</varname> configuration parameter</primary>
       </indexterm>
@@ -4198,6 +4198,7 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"'  # Windows
        know will not be required for future incremental backups.
        This parameter can only be set in the
        <filename>postgresql.conf</filename> file or on the server command line.
+       If this value is specified without units, it is taken as minutes.
        The default is 10 days. If <literal>summarize_wal = off</literal>,
        existing WAL summaries will not be removed regardless of the value of
        this parameter, because the WAL summarizer will not run.
-- 
2.25.1


--d6Gm4EdcadzBjdND--

Message-ID: <no-message-id-25594@localhost>
Permalink:  ../no-message-id-25594@localhost/
Also on:    postgresql.org/message-id/no-message-id-25594@localhost

copy link · copy postgr.es · copy git am

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-bugs@postgresql.org
  Cc: nathan@postgresql.org
  Subject: Re: [PATCH v2 1/1] Fix documentation for wal_summary_keep_time.
  In-Reply-To: <no-message-id-25594@localhost>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox