pg.ddx.io  pgsql-bugs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
Wrong datatype in docs for wal_summary_keep_time
4+ messages / 2 participants
[nested] [flat]

Commits from this thread:
  2024-01-09 d97ef756af  Fix documentation for wal_summary_keep_time.
* Wrong datatype in docs for wal_summary_keep_time
@ 2024-01-08 16:37 hubert depesz lubaczewski <depesz@depesz.com>
  2024-01-08 23:23 ` Re: Wrong datatype in docs for wal_summary_keep_time Nathan Bossart <nathandbossart@gmail.com>
  0 siblings, 1 reply; 4+ messages in thread

From: hubert depesz lubaczewski @ 2024-01-08 16:37 UTC (permalink / raw)
  To: PostgreSQL mailing lists <pgsql-bugs@lists.postgresql.org>; +Cc: Robert Haas <rhaas@postgresql.org>

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+
inline patch 1: config.sgml.fixed (+1/-1 lines) download inline-1.patch--- 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 ^ permalink raw reply [nested|flat] 4+ messages in thread

* Re: Wrong datatype in docs for wal_summary_keep_time
  2024-01-08 16:37 Wrong datatype in docs for wal_summary_keep_time hubert depesz lubaczewski <depesz@depesz.com>
@ 2024-01-08 23:23 ` Nathan Bossart <nathandbossart@gmail.com>
  2024-01-09 03:47   ` Re: Wrong datatype in docs for wal_summary_keep_time Nathan Bossart <nathandbossart@gmail.com>
  0 siblings, 1 reply; 4+ messages in thread

From: Nathan Bossart @ 2024-01-08 23:23 UTC (permalink / raw)
  To: hubert depesz lubaczewski <depesz@depesz.com>; +Cc: PostgreSQL mailing lists <pgsql-bugs@lists.postgresql.org>; Robert Haas <rhaas@postgresql.org>

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





^ permalink  raw  reply  [nested|flat] 4+ messages in thread

* Re: Wrong datatype in docs for wal_summary_keep_time
  2024-01-08 16:37 Wrong datatype in docs for wal_summary_keep_time hubert depesz lubaczewski <depesz@depesz.com>
  2024-01-08 23:23 ` Re: Wrong datatype in docs for wal_summary_keep_time Nathan Bossart <nathandbossart@gmail.com>
@ 2024-01-09 03:47   ` Nathan Bossart <nathandbossart@gmail.com>
  2024-01-09 17:38     ` Re: Wrong datatype in docs for wal_summary_keep_time Nathan Bossart <nathandbossart@gmail.com>
  0 siblings, 1 reply; 4+ messages in thread

From: Nathan Bossart @ 2024-01-09 03:47 UTC (permalink / raw)
  To: hubert depesz lubaczewski <depesz@depesz.com>; +Cc: PostgreSQL mailing lists <pgsql-bugs@lists.postgresql.org>; Robert Haas <rhaas@postgresql.org>

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

Attachments:

  v2-0001-Fix-documentation-for-wal_summary_keep_time.patch (text/x-diff, 0B) download

^ permalink  raw  reply  [nested|flat] 4+ messages in thread

* Re: Wrong datatype in docs for wal_summary_keep_time
  2024-01-08 16:37 Wrong datatype in docs for wal_summary_keep_time hubert depesz lubaczewski <depesz@depesz.com>
  2024-01-08 23:23 ` Re: Wrong datatype in docs for wal_summary_keep_time Nathan Bossart <nathandbossart@gmail.com>
  2024-01-09 03:47   ` Re: Wrong datatype in docs for wal_summary_keep_time Nathan Bossart <nathandbossart@gmail.com>
@ 2024-01-09 17:38     ` Nathan Bossart <nathandbossart@gmail.com>
  0 siblings, 0 replies; 4+ messages in thread

From: Nathan Bossart @ 2024-01-09 17:38 UTC (permalink / raw)
  To: hubert depesz lubaczewski <depesz@depesz.com>; +Cc: PostgreSQL mailing lists <pgsql-bugs@lists.postgresql.org>; Robert Haas <rhaas@postgresql.org>

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





^ permalink  raw  reply  [nested|flat] 4+ messages in thread


end of thread, other threads:[~2024-01-09 17:38 UTC | newest]

Thread overview: 4+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2024-01-08 16:37 Wrong datatype in docs for wal_summary_keep_time hubert depesz lubaczewski <depesz@depesz.com>
2024-01-08 23:23 ` Nathan Bossart <nathandbossart@gmail.com>
2024-01-09 03:47   ` Nathan Bossart <nathandbossart@gmail.com>
2024-01-09 17:38     ` Nathan Bossart <nathandbossart@gmail.com>

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