Date: Fri, 27 Oct 2023 11:40:08 -0400
From: Bruce Momjian <bruce@momjian.us>
To: andyatkinson@gmail.com, pgsql-docs@lists.postgresql.org
Subject: Re: [very minor] Documentation suggestion
Message-ID: <ZTvZ2JGcoKoFxMUB@momjian.us>
References: <166631875298.630.2861049399528658047@wrigleys.postgresql.org>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="vegSJkjh11AEgO54"
Content-Disposition: inline
In-Reply-To: <166631875298.630.2861049399528658047@wrigleys.postgresql.org>
Archived-At: 
 <https://www.postgresql.org/message-id/ZTvZ2JGcoKoFxMUB%40momjian.us>
Precedence: bulk


--vegSJkjh11AEgO54
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

On Fri, Oct 21, 2022 at 02:19:12AM +0000, PG Doc comments form wrote:
> The following documentation comment has been logged on the website:
> 
> Page: https://www.postgresql.org/docs/15/logicaldecoding-synchronous.html
> Description:
> 
> Very minor suggestion. Earlier on this page, commands are referred to that
> can cause "a deadlock". Later on the page, it says "cause deadlock".
> 
> https://www.postgresql.org/account/comments/new/15/logicaldecoding-synchronous.html/
> 
> "Note that these commands that can cause deadlock"

The full sentence is:

     Note that these commands that can cause deadlock apply to not only
     explicitly indicated system catalog tables above but also to any other
     [user] catalog table.

What I think it means is:

     Note that these commands, that can cause deadlock, apply to not only
     explicitly indicated system catalog tables above but also to any other
     [user] catalog table.

so with "a" it would be:

     Note that these commands, that can cause a deadlock, apply to not only
     explicitly indicated system catalog tables above but also to any other
     [user] catalog table.

but it still needs help ;-)  Here is the text I just applied:

     Note that these commands can cause deadlocks not only for the system
     catalog tables listed above but for other catalog tables.

Attached is the applied patch to master.

-- 
  Bruce Momjian  <bruce@momjian.us>        https://momjian.us
  EDB                                      https://enterprisedb.com

  Only you can decide what is important to you.

--vegSJkjh11AEgO54
Content-Type: text/x-diff; charset=us-ascii
Content-Disposition: attachment; filename="master.diff"

commit 16ace6f745
Author: Bruce Momjian <bruce@momjian.us>
Date:   Fri Oct 27 11:35:47 2023 -0400

    doc: clarify logical decoding's deadlock of system tables
    
    Reported-by: andyatkinson@gmail.com
    
    Discussion: https://postgr.es/m/166631875298.630.2861049399528658047@wrigleys.postgresql.org
    
    Backpatch-through: master

diff --git a/doc/src/sgml/logicaldecoding.sgml b/doc/src/sgml/logicaldecoding.sgml
index 5af016cfa9..8067946a25 100644
--- a/doc/src/sgml/logicaldecoding.sgml
+++ b/doc/src/sgml/logicaldecoding.sgml
@@ -1197,9 +1197,8 @@ OutputPluginWrite(ctx, true);
       </listitem>
      </itemizedlist>
 
-     Note that these commands that can cause deadlock apply to not only explicitly
-     indicated system catalog tables above but also to any other [user] catalog
-     table.
+     Note that these commands can cause deadlocks not only for the system
+     catalog tables listed above but for other catalog tables.
     </para>
    </sect2>
   </sect1>

--vegSJkjh11AEgO54--