agora inbox for pgsql-docs@postgresql.org  
help / color / mirror / Atom feed
Remove unnecessary secondary index terms for replication settings
4+ messages / 3 participants
[nested] [flat]

* Remove unnecessary secondary index terms for replication settings
@ 2025-04-23 06:53  Fujii Masao <masao.fujii@oss.nttdata.com>
  0 siblings, 2 replies; 4+ messages in thread

From: Fujii Masao @ 2025-04-23 06:53 UTC (permalink / raw)
  To: pgsql-docs@lists.postgresql.org

Hi,

In config.sgml, the entries for max_replication_slots and
max_active_replication_origins include secondary index terms:

         <primary><varname>max_replication_slots</varname> configuration parameter</primary>
         <secondary>in a sending server</secondary>

         <primary><varname>max_active_replication_origins</varname> configuration parameter</primary>
         <secondary>in a subscriber</secondary>

These secondary terms don't seem necessary anymore, since each parameter
now has only one index entry. Removing them would simplify the documentation.

Originally, the secondary entries made sense because
max_active_replication_origins was part of max_replication_slots,
so both needed separate index entries. But commit 04ff636cbce
split them into distinct parameters.

Patch attached.

Regards,

-- 
Fujii Masao
Advanced Computing Technology Center
Research and Development Headquarters
NTT DATA CORPORATION
From fada9d65dd5c177e43179bcd5cc2e57d36b5d831 Mon Sep 17 00:00:00 2001
From: Fujii Masao <fujii@postgresql.org>
Date: Wed, 23 Apr 2025 15:25:42 +0900
Subject: [PATCH v1] doc: remove unnecessary secondary index terms for
 replication settings.

Previously, config.sgml included secondary index terms for
max_replication_slots and max_active_replication_origins. These are
no longer necessary, as each parameter now has a single distinct index entry.

The secondary terms were originally useful because
max_active_replication_origins was part of max_replication_slots,
and separate index entries helped users locate each setting. However,
commit 04ff636cbce split them into independent parameters,
making the secondary terms redundant.

This commit removes the unnecessary secondary index entries to
simplify the documentation.
---
 doc/src/sgml/config.sgml | 2 --
 1 file changed, 2 deletions(-)

diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index c1674c22cb2..bd48a3ba139 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -4511,7 +4511,6 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"'  # Windows
        <term><varname>max_replication_slots</varname> (<type>integer</type>)
        <indexterm>
         <primary><varname>max_replication_slots</varname> configuration parameter</primary>
-        <secondary>in a sending server</secondary>
        </indexterm>
        </term>
        <listitem>
@@ -5282,7 +5281,6 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
       <term><varname>max_active_replication_origins</varname> (<type>integer</type>)
        <indexterm>
         <primary><varname>max_active_replication_origins</varname> configuration parameter</primary>
-        <secondary>in a subscriber</secondary>
        </indexterm>
       </term>
       <listitem>
-- 
2.49.0



Attachments:

  [text/plain] v1-0001-doc-remove-unnecessary-secondary-index-terms-for-.patch (1.8K, ../../e825e7a7-4877-441d-93c1-25377db36c31@oss.nttdata.com/2-v1-0001-doc-remove-unnecessary-secondary-index-terms-for-.patch)
  download | inline diff:
From fada9d65dd5c177e43179bcd5cc2e57d36b5d831 Mon Sep 17 00:00:00 2001
From: Fujii Masao <fujii@postgresql.org>
Date: Wed, 23 Apr 2025 15:25:42 +0900
Subject: [PATCH v1] doc: remove unnecessary secondary index terms for
 replication settings.

Previously, config.sgml included secondary index terms for
max_replication_slots and max_active_replication_origins. These are
no longer necessary, as each parameter now has a single distinct index entry.

The secondary terms were originally useful because
max_active_replication_origins was part of max_replication_slots,
and separate index entries helped users locate each setting. However,
commit 04ff636cbce split them into independent parameters,
making the secondary terms redundant.

This commit removes the unnecessary secondary index entries to
simplify the documentation.
---
 doc/src/sgml/config.sgml | 2 --
 1 file changed, 2 deletions(-)

diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index c1674c22cb2..bd48a3ba139 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -4511,7 +4511,6 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"'  # Windows
        <term><varname>max_replication_slots</varname> (<type>integer</type>)
        <indexterm>
         <primary><varname>max_replication_slots</varname> configuration parameter</primary>
-        <secondary>in a sending server</secondary>
        </indexterm>
        </term>
        <listitem>
@@ -5282,7 +5281,6 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
       <term><varname>max_active_replication_origins</varname> (<type>integer</type>)
        <indexterm>
         <primary><varname>max_active_replication_origins</varname> configuration parameter</primary>
-        <secondary>in a subscriber</secondary>
        </indexterm>
       </term>
       <listitem>
-- 
2.49.0



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

* Re: Remove unnecessary secondary index terms for replication settings
@ 2025-04-23 21:09  Euler Taveira <euler@eulerto.com>
  parent: Fujii Masao <masao.fujii@oss.nttdata.com>
  1 sibling, 0 replies; 4+ messages in thread

From: Euler Taveira @ 2025-04-23 21:09 UTC (permalink / raw)
  To: pgsql-docs@lists.postgresql.org

On Wed, Apr 23, 2025, at 3:53 AM, Fujii Masao wrote:
> These secondary terms don't seem necessary anymore, since each parameter
> now has only one index entry. Removing them would simplify the documentation.
> 
> Originally, the secondary entries made sense because
> max_active_replication_origins was part of max_replication_slots,
> so both needed separate index entries. But commit 04ff636cbce
> split them into distinct parameters.

Agreed. It was an oversight in my patch. LGTM.


--
Euler Taveira
EDB   https://www.enterprisedb.com/

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

* Re: Remove unnecessary secondary index terms for replication settings
@ 2025-04-24 14:30  Robert Treat <rob@xzilla.net>
  parent: Fujii Masao <masao.fujii@oss.nttdata.com>
  1 sibling, 1 reply; 4+ messages in thread

From: Robert Treat @ 2025-04-24 14:30 UTC (permalink / raw)
  To: Fujii Masao <masao.fujii@oss.nttdata.com>; +Cc: pgsql-docs@lists.postgresql.org

On Wed, Apr 23, 2025 at 2:54 AM Fujii Masao <masao.fujii@oss.nttdata.com> wrote:
>
> Hi,
>
> In config.sgml, the entries for max_replication_slots and
> max_active_replication_origins include secondary index terms:
>
>          <primary><varname>max_replication_slots</varname> configuration parameter</primary>
>          <secondary>in a sending server</secondary>
>
>          <primary><varname>max_active_replication_origins</varname> configuration parameter</primary>
>          <secondary>in a subscriber</secondary>
>
> These secondary terms don't seem necessary anymore, since each parameter
> now has only one index entry. Removing them would simplify the documentation.
>
> Originally, the secondary entries made sense because
> max_active_replication_origins was part of max_replication_slots,
> so both needed separate index entries. But commit 04ff636cbce
> split them into distinct parameters.
>
> Patch attached.
>

Make sense, +1 from me.


Robert Treat
https://xzilla.net





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

* Re: Remove unnecessary secondary index terms for replication settings
@ 2025-04-25 06:02  Fujii Masao <masao.fujii@oss.nttdata.com>
  parent: Robert Treat <rob@xzilla.net>
  0 siblings, 0 replies; 4+ messages in thread

From: Fujii Masao @ 2025-04-25 06:02 UTC (permalink / raw)
  To: Robert Treat <rob@xzilla.net>; euler@eulerto.com; +Cc: pgsql-docs@lists.postgresql.org



On 2025/04/24 23:30, Robert Treat wrote:
> On Wed, Apr 23, 2025 at 2:54 AM Fujii Masao <masao.fujii@oss.nttdata.com> wrote:
>>
>> Hi,
>>
>> In config.sgml, the entries for max_replication_slots and
>> max_active_replication_origins include secondary index terms:
>>
>>           <primary><varname>max_replication_slots</varname> configuration parameter</primary>
>>           <secondary>in a sending server</secondary>
>>
>>           <primary><varname>max_active_replication_origins</varname> configuration parameter</primary>
>>           <secondary>in a subscriber</secondary>
>>
>> These secondary terms don't seem necessary anymore, since each parameter
>> now has only one index entry. Removing them would simplify the documentation.
>>
>> Originally, the secondary entries made sense because
>> max_active_replication_origins was part of max_replication_slots,
>> so both needed separate index entries. But commit 04ff636cbce
>> split them into distinct parameters.
>>
>> Patch attached.
>>
> 
> Make sense, +1 from me.

Thanks both for the review! I've pushed the patch.

Regards,

-- 
Fujii Masao
Advanced Computing Technology Center
Research and Development Headquarters
NTT DATA CORPORATION






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


end of thread, other threads:[~2025-04-25 06:02 UTC | newest]

Thread overview: 4+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2025-04-23 06:53 Remove unnecessary secondary index terms for replication settings Fujii Masao <masao.fujii@oss.nttdata.com>
2025-04-23 21:09 ` Euler Taveira <euler@eulerto.com>
2025-04-24 14:30 ` Robert Treat <rob@xzilla.net>
2025-04-25 06:02   ` Fujii Masao <masao.fujii@oss.nttdata.com>

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox