Thread: Wrong datatype in docs for wal_summary_keep_time

Wrong datatype in docs for wal_summary_keep_time

From
hubert depesz lubaczewski
Date:
Hi,
I was reviewing new changes, and found out that we now have
"wal_summary_keep_time" setting, but the docs
(https://www.postgresql.org/docs/devel/runtime-config-wal.html#RUNTIME-CONFIG-WAL-SUMMARIZATION)
say that it's boolean, while it is integer.

The fix is simple:

#v+
--- config.sgml 2024-01-05 10:43:17.776276803 +0100
+++ config.sgml.fixed   2024-01-08 17:35:54.202968175 +0100
@@ -4179,7 +4179,7 @@
      </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>
#v-

Best regards,

depesz




Re: Wrong datatype in docs for wal_summary_keep_time

From
Nathan Bossart
Date:
On Mon, Jan 08, 2024 at 05:37:14PM +0100, hubert depesz lubaczewski wrote:
> I was reviewing new changes, and found out that we now have
> "wal_summary_keep_time" setting, but the docs
> (https://www.postgresql.org/docs/devel/runtime-config-wal.html#RUNTIME-CONFIG-WAL-SUMMARIZATION)
> say that it's boolean, while it is integer.

Indeed.  I'll try to get this committed tonight unless Robert beats me to
it.

-- 
Nathan Bossart
Amazon Web Services: https://aws.amazon.com



Re: Wrong datatype in docs for wal_summary_keep_time

From
Nathan Bossart
Date:
On Mon, Jan 08, 2024 at 05:23:11PM -0600, Nathan Bossart wrote:
> On Mon, Jan 08, 2024 at 05:37:14PM +0100, hubert depesz lubaczewski wrote:
>> I was reviewing new changes, and found out that we now have
>> "wal_summary_keep_time" setting, but the docs
>> (https://www.postgresql.org/docs/devel/runtime-config-wal.html#RUNTIME-CONFIG-WAL-SUMMARIZATION)
>> say that it's boolean, while it is integer.
> 
> Indeed.  I'll try to get this committed tonight unless Robert beats me to
> it.

I noticed that the docs also fail to mention how the value of this
parameter is interpreted when specified without units, so I've put together
a v2 patch that fixes this, too.

-- 
Nathan Bossart
Amazon Web Services: https://aws.amazon.com

Attachment

Re: Wrong datatype in docs for wal_summary_keep_time

From
Nathan Bossart
Date:
On Mon, Jan 08, 2024 at 09:47:22PM -0600, Nathan Bossart wrote:
> I noticed that the docs also fail to mention how the value of this
> parameter is interpreted when specified without units, so I've put together
> a v2 patch that fixes this, too.

And committed.  Thanks for the report!

-- 
Nathan Bossart
Amazon Web Services: https://aws.amazon.com