RE: Documentation Edits for pg_createsubscriber

From: "Hayato Kuroda (Fujitsu)" <kuroda(dot)hayato(at)fujitsu(dot)com>
To: "'David G(dot) Johnston'" <david(dot)g(dot)johnston(at)gmail(dot)com>
Cc: PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: RE: Documentation Edits for pg_createsubscriber
Date: 2025-03-11 02:56:07
Message-ID: OSCPR01MB1496655514E7D6D6BACC58987F5D12@OSCPR01MB14966.jpnprd01.prod.outlook.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Dear David,

> The main thing I noted is that our synopsis is simply wrong regarding the
> optionality of the --database option. I went with a fix that included only
> showing the two mandatory options and adding a paragraph to usage explaining
> that --database exists and how to use it. Our existing example also covers
> that common usage.

According to the code, -D and -P is anyway needed, but -d can be omitted when -P
contians dbname option. And you wanted to follow the rule, right?
IIUC shorter synopsis is always welcomed.

> It took me a bit, and reading implementation code, to understand what was meant
> by "Additional recovery parameters are added to avoid ...". I decided that
> detail seemed unnecessary for the user-facing documentation - supposedly they
> will never see the recovery file if everything works OK (and if they do the
> various empty string settings should be reasonably self-evident). If we do
> want to keep it I'll try to find a better wording.

To confirm; users can run SHOW command after the conversion and they can see
our setting. Do you think it is a user-facing?

Here are my comments. (I ran Grammarly to check your sentences)

01.
Your patch breaks 80-column-per-line rule. Please check it.

02.
```
+ The minimal command shown above...
```

"shown" can be removed.

03.
```
+ then created using auto-generated names, which can be overriden
```

s/overriden/overridden/.

04.
```
+ using the corresponding long-form command-line options, once each per database.
```

"," and "each" can be removed.

05.
```
+ does not perform an initial data copy. Instead it relies on a LSN-based
```

Latter sentence can be "Inseted, it relies on an LSN-based..."

06.
```
+ <para>
+ Note, the configuration setting <literal>port</literal> in this file is effectively ignored
+ as <application>pg_createsubscriber</application> always specifies the target listening port
+ on the <application>pg_ctl</application> command-line.
+ Use the <option>-p</option> option to specify which port the target server should listen on.
</para>
```

Can you clarify the <literal>port</literal> in the config file is ignored only
while the pg_createsuscriber commands?

07.
```
+ <application>pg_createsubscriber</application> is designed have full and
```

s/is designed have/is designed to have/.

Best regards,
Hayato Kuroda
FUJITSU LIMITED

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message David G. Johnston 2025-03-11 03:36:45 Re: Documentation Edits for pg_createsubscriber
Previous Message wenhui qiu 2025-03-11 02:00:10 Re: Trigger more frequent autovacuums