pg.ddx.io  pgsql-hackers@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Alvaro Herrera <alvherre@alvh.no-ip.org>
To: Bharath Rupireddy <bharath.rupireddyforpostgres@gmail.com>
Cc: Pg Hackers <pgsql-hackers@lists.postgresql.org>
Subject: Re: minor replication slot docs edits
Date: Thu, 18 Jan 2024 11:49:18 +0100
Message-ID: <202401181049.el2j6ez663dp@alvherre.pgsql> (raw)
In-Reply-To: <CALj2ACWaWxVBAgkHDmKFiQN2ediDY+VOAp1t0ohZEpcW87ua8Q@mail.gmail.com>

On 2024-Jan-16, Bharath Rupireddy wrote:

> Thanks for the patch. The wording looks good to me. However, I have
> some comments on the placement of the note:
> 
> 1. How about bundling this in a <note> </note> or <caution> </caution>?

Yeah, I considered this too, but I discarded the idea because my
impression of <caution> and <note> was that they attract too much
attention off the main text; it should be the other way around.  But
that's not really something for this patch to solve, and we use
<caution> boxes in many other places and nobody complains about this.
So I made it a <caution>.

> 2. I think the better place for this note is at the end after the
> "Similarly, <xref linkend="guc-hot-standby-feedback"/> on its own,
> without" paragraph. It will then be like we introduce what replication
> slot is and why it is better over other mechanisms to retain WAL and
> then caution the users of it retaining WAL.

Makes sense.

I have pushed it.  I made one other terminology change from "primary" to
"primary server", but only in that subsection.  We use "primary" as a
standalone term extensively in other sections of this chapter, and I
don't like it very much, but I didn't want to make this more invasive.

Another thing I noticed is that we could change all (or most of) the
<varname> tags to <xref linkend="guc-..."/>, but it's also a much larger
change.  Having (some of?) these variable names be links would be useful
IMO.

-- 
Álvaro Herrera         PostgreSQL Developer  —  https://www.EnterpriseDB.com/





view thread (4+ messages)  latest in thread

Message-ID: <202401181049.el2j6ez663dp@alvherre.pgsql>
Permalink:  ../202401181049.el2j6ez663dp@alvherre.pgsql/
Also on:    postgresql.org/message-id/202401181049.el2j6ez663dp@alvherre.pgsql

 · 

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients from your mail client; the link fills in
  the headers below: reply via email
  Some clients, webmail especially, drop In-Reply-To and References from
  a link, and the reply then starts a new thread: use the mbox below.

  To: pgsql-hackers@postgresql.org
  Cc: alvherre@alvh.no-ip.org, bharath.rupireddyforpostgres@gmail.com
  Subject: Re: minor replication slot docs edits
  In-Reply-To: <202401181049.el2j6ez663dp@alvherre.pgsql>
  References: <CALj2ACWaWxVBAgkHDmKFiQN2ediDY+VOAp1t0ohZEpcW87ua8Q@mail.gmail.com> <202401181049.el2j6ez663dp@alvherre.pgsql>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

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