public inbox for [email protected]
help / color / mirror / Atom feedDocument default values for --fsync-interval and --plugin in pg_recvlogical
3+ messages / 2 participants
[nested] [flat]
* Document default values for --fsync-interval and --plugin in pg_recvlogical
@ 2025-11-16 06:19 Fujii Masao <[email protected]>
2025-11-16 18:34 ` Re: Document default values for --fsync-interval and --plugin in pg_recvlogical Laurenz Albe <[email protected]>
0 siblings, 1 reply; 3+ messages in thread
From: Fujii Masao @ 2025-11-16 06:19 UTC (permalink / raw)
To: [email protected]
Hi,
I noticed that pg_recvlogical --help shows default values for
the --fsync-interval and --plugin options, but the docs does not.
This would be inconvenient for users.
The attached patch adds the missing default value descriptions
to the pg_recvlogical docs.
Regards,
--
Fujii Masao
Attachments:
[application/octet-stream] v1-0001-doc-Document-default-values-for-some-pg_recvlogic.patch (1.9K, 2-v1-0001-doc-Document-default-values-for-some-pg_recvlogic.patch)
download | inline diff:
From 309f048d72dc2d7c93a5c289269501159ebd8e05 Mon Sep 17 00:00:00 2001
From: Fujii Masao <[email protected]>
Date: Sun, 16 Nov 2025 14:39:37 +0900
Subject: [PATCH v1] doc: Document default values for some pg_recvlogical
options.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
The documentation did not previously mention the default values for
the --fsync-interval and --plugin options, even though pg_recvlogical --help
shows them. This omission made it harder for users to understand
the tool’s behavior from the documentation alone.
This commit adds the missing default value descriptions for both options
to the pg_recvlogical documentation.
---
doc/src/sgml/ref/pg_recvlogical.sgml | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/doc/src/sgml/ref/pg_recvlogical.sgml b/doc/src/sgml/ref/pg_recvlogical.sgml
index 263ebdeeab4..2cc24f91583 100644
--- a/doc/src/sgml/ref/pg_recvlogical.sgml
+++ b/doc/src/sgml/ref/pg_recvlogical.sgml
@@ -206,7 +206,7 @@ PostgreSQL documentation
<para>
Specifies how often <application>pg_recvlogical</application> should
issue <function>fsync()</function> calls to ensure the output file is
- safely flushed to disk.
+ safely flushed to disk. The default value is 10 seconds.
</para>
<para>
@@ -275,8 +275,10 @@ PostgreSQL documentation
<listitem>
<para>
When creating a slot, use the specified logical decoding output
- plugin. See <xref linkend="logicaldecoding"/>. This option has no
- effect if the slot already exists.
+ plugin. See <xref linkend="logicaldecoding-output-plugin"/> for
+ information about the plugins <productname>PostgreSQL</productname>
+ provides. The default is <xref linkend="test-decoding"/>.
+ This option has no effect if the slot already exists.
</para>
</listitem>
</varlistentry>
--
2.51.2
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: Document default values for --fsync-interval and --plugin in pg_recvlogical
2025-11-16 06:19 Document default values for --fsync-interval and --plugin in pg_recvlogical Fujii Masao <[email protected]>
@ 2025-11-16 18:34 ` Laurenz Albe <[email protected]>
2025-11-17 14:26 ` Re: Document default values for --fsync-interval and --plugin in pg_recvlogical Fujii Masao <[email protected]>
0 siblings, 1 reply; 3+ messages in thread
From: Laurenz Albe @ 2025-11-16 18:34 UTC (permalink / raw)
To: Fujii Masao <[email protected]>; [email protected]
On Sun, 2025-11-16 at 15:19 +0900, Fujii Masao wrote:
> I noticed that pg_recvlogical --help shows default values for
> the --fsync-interval and --plugin options, but the docs does not.
> This would be inconvenient for users.
>
> The attached patch adds the missing default value descriptions
> to the pg_recvlogical docs.
+1 for that patch, it looks good to me.
Yours,
Laurenz Albe
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: Document default values for --fsync-interval and --plugin in pg_recvlogical
2025-11-16 06:19 Document default values for --fsync-interval and --plugin in pg_recvlogical Fujii Masao <[email protected]>
2025-11-16 18:34 ` Re: Document default values for --fsync-interval and --plugin in pg_recvlogical Laurenz Albe <[email protected]>
@ 2025-11-17 14:26 ` Fujii Masao <[email protected]>
0 siblings, 0 replies; 3+ messages in thread
From: Fujii Masao @ 2025-11-17 14:26 UTC (permalink / raw)
To: Laurenz Albe <[email protected]>; +Cc: [email protected]
On Mon, Nov 17, 2025 at 3:34 AM Laurenz Albe <[email protected]> wrote:
>
> On Sun, 2025-11-16 at 15:19 +0900, Fujii Masao wrote:
> > I noticed that pg_recvlogical --help shows default values for
> > the --fsync-interval and --plugin options, but the docs does not.
> > This would be inconvenient for users.
> >
> > The attached patch adds the missing default value descriptions
> > to the pg_recvlogical docs.
>
> +1 for that patch, it looks good to me.
Thanks for the review! I've pushed the patch.
Regards,
--
Fujii Masao
^ permalink raw reply [nested|flat] 3+ messages in thread
end of thread, other threads:[~2025-11-17 14:26 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2025-11-16 06:19 Document default values for --fsync-interval and --plugin in pg_recvlogical Fujii Masao <[email protected]>
2025-11-16 18:34 ` Laurenz Albe <[email protected]>
2025-11-17 14:26 ` Fujii Masao <[email protected]>
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox