Обсуждение: doc patch: missing tags in protocol.sgml

Поиск
Список
Период
Сортировка

doc patch: missing tags in protocol.sgml

От
"Hayato Kuroda (Fujitsu)"
Дата:
Dear hackers,

I found that in protocol.sgml, the parameter "streaming" is mentioned twice [1] but
both are not tagged. IIUC, "streaming" can be <varname> and "parallel" can be <literal>.
Also, the first "streaming" can have a link to the pgoutput's manual. Attached patch fixes like that.

Thanks Peter Smith and Noboru Saito to confirm the point.

[1]:
```
         The LSN of the abort operation, present only when streaming is set to parallel.
...
         Abort timestamp of the transaction, present only when streaming is set to
         parallel. The value is in number of microseconds since PostgreSQL epoch (2000-01-01).
```

Best regards,
Hayato Kuroda
FUJITSU LIMITED


Вложения

Re: doc patch: missing tags in protocol.sgml

От
Masahiko Sawada
Дата:
On Wed, Aug 27, 2025 at 11:49 PM Hayato Kuroda (Fujitsu)
<kuroda.hayato@fujitsu.com> wrote:
>
> Dear hackers,
>
> I found that in protocol.sgml, the parameter "streaming" is mentioned twice [1] but
> both are not tagged. IIUC, "streaming" can be <varname> and "parallel" can be <literal>.
> Also, the first "streaming" can have a link to the pgoutput's manual. Attached patch fixes like that.

Looks good to me. I'm going to push the patch, barring any objections.

Regards,

--
Masahiko Sawada
Amazon Web Services: https://aws.amazon.com



RE: doc patch: missing tags in protocol.sgml

От
"Hayato Kuroda (Fujitsu)"
Дата:
Dear Sawada-san,

Thanks for looking the patch.
Actually PG16-18 has the same issue as this, but it does not have the page for
pgoutput. Attached patch sets a link to create_subscription.sgml instead. Thought?

Best regards,
Hayato Kuroda
FUJITSU LIMITED


Вложения

Re: doc patch: missing tags in protocol.sgml

От
Masahiko Sawada
Дата:
On Thu, Aug 28, 2025 at 6:53 PM Hayato Kuroda (Fujitsu)
<kuroda.hayato@fujitsu.com> wrote:
>
> Dear Sawada-san,
>
> Thanks for looking the patch.
> Actually PG16-18 has the same issue as this, but it does not have the page for
> pgoutput. Attached patch sets a link to create_subscription.sgml instead. Thought?

I guess that it would be better to link to "Logical Streaming
Replication Parameters"[1] since the pgoutput page is derived from
this section. We would have to link to the section instead of
"streaming" parameter but I think it would not be a big issue.

Regards,

[1] https://www.postgresql.org/docs/17/protocol-logical-replication.html#PROTOCOL-LOGICAL-REPLICATION-PARAMS

--
Masahiko Sawada
Amazon Web Services: https://aws.amazon.com



RE: doc patch: missing tags in protocol.sgml

От
"Hayato Kuroda (Fujitsu)"
Дата:
Dear Sawada-san,

> I guess that it would be better to link to "Logical Streaming
> Replication Parameters"[1] since the pgoutput page is derived from
> this section. We would have to link to the section instead of
> "streaming" parameter but I think it would not be a big issue.

Seems better, PSA the fixed version. A patch for master is not changed thus
I did not attach here.

Best regards,
Hayato Kuroda
FUJITSU LIMITED


Вложения