Received: from malur.postgresql.org ([217.196.149.56])
	by arkaria.postgresql.org with esmtps
 (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256)
	(Exim 4.92)
	(envelope-from <pgsql-docs-owner+archive@lists.postgresql.org>)
	id 1o9cg0-0002YR-Nq
	for pgsql-docs@arkaria.postgresql.org; Fri, 08 Jul 2022 01:21:00 +0000
Received: from localhost ([127.0.0.1] helo=malur.postgresql.org)
	by malur.postgresql.org with esmtp (Exim 4.92)
	(envelope-from <pgsql-docs-owner+archive@lists.postgresql.org>)
	id 1o9cfz-0007BV-GG
	for pgsql-docs@arkaria.postgresql.org; Fri, 08 Jul 2022 01:20:59 +0000
Received: from makus.postgresql.org ([2001:4800:3e1:1::229])
	by malur.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256)
	(Exim 4.92)
	(envelope-from <bruce@momjian.us>)
	id 1o9cfz-000766-8V
	for pgsql-docs@lists.postgresql.org; Fri, 08 Jul 2022 01:20:59 +0000
Received: from momjian.us ([72.94.173.45])
	by makus.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256)
	(Exim 4.92)
	(envelope-from <bruce@momjian.us>)
	id 1o9cfw-0001zS-Pc
	for pgsql-docs@lists.postgresql.org; Fri, 08 Jul 2022 01:20:58 +0000
Received: from bruce by momjian.us with local (Exim 4.94.2)
	(envelope-from <bruce@momjian.us>)
	id 1o9cfv-005jZW-7f; Thu, 07 Jul 2022 21:20:55 -0400
Date: Thu, 7 Jul 2022 21:20:55 -0400
From: Bruce Momjian <bruce@momjian.us>
To: troy@frericks.us, pgsql-docs@lists.postgresql.org
Subject: Re: How to reference the type of lock in the documentation.
Message-ID: <YseGd7IEIK3i7Fw3@momjian.us>
References: <165653551130.665.8240515669521441325@wrigleys.postgresql.org>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="LGbtvnIBWbWg2hLv"
Content-Disposition: inline
In-Reply-To: <165653551130.665.8240515669521441325@wrigleys.postgresql.org>
List-Id: <pgsql-docs.lists.postgresql.org>
List-Help: <https://lists.postgresql.org/manage/>
List-Subscribe: <https://lists.postgresql.org/manage/>
List-Post: <mailto:pgsql-docs@lists.postgresql.org>
List-Owner: <mailto:pgsql-docs-owner@lists.postgresql.org>
List-Archive: <https://www.postgresql.org/list/pgsql-docs>
Archived-At: 
 <https://www.postgresql.org/message-id/YseGd7IEIK3i7Fw3%40momjian.us>
Precedence: bulk


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

On Wed, Jun 29, 2022 at 08:45:11PM +0000, PG Doc comments form wrote:
> The following documentation comment has been logged on the website:
> 
> Page: https://www.postgresql.org/docs/10/explicit-locking.html
> Description:
> 
> On page https://www.postgresql.org/docs/10/explicit-locking.html, I'd like
> to suggest a search-engine-optimization improvement. Generally, but
> especially on this page, it'd be nice to have the lock name along with the
> user-friendly name. For example, with the first use of "SHARE UPDATE
> EXCLUSIVE", I'd like to see the lock name with it, for example, "SHARE
> UPDATE EXCLUSIVE (ShareUpdateExclusiveLock)". 

I see your point --- that the names that appear in the pg_locks view
don't appear in our documentation.  The attached patches adds the
pg_locks names after each lock name.  You can see the doc output here:

	https://momjian.us/tmp/pgsql/explicit-locking.html

If people like this, I can apply it to all supported branches.

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

  Indecision is a decision.  Inaction is an action.  Mark Batterson


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

diff --git a/doc/src/sgml/mvcc.sgml b/doc/src/sgml/mvcc.sgml
index ff148bb3dc..ed3d099c72 100644
--- a/doc/src/sgml/mvcc.sgml
+++ b/doc/src/sgml/mvcc.sgml
@@ -907,7 +907,7 @@ ERROR:  could not serialize access due to read/write dependencies among transact
       <title>Table-Level Lock Modes</title>
       <varlistentry>
        <term>
-        <literal>ACCESS SHARE</literal>
+        <literal>ACCESS SHARE</literal> / <literal>AccessShareLock</literal>
        </term>
        <listitem>
         <para>
@@ -925,7 +925,7 @@ ERROR:  could not serialize access due to read/write dependencies among transact
 
       <varlistentry>
        <term>
-        <literal>ROW SHARE</literal>
+        <literal>ROW SHARE</literal> / <literal>RowShareLock</literal>
        </term>
        <listitem>
         <para>
@@ -948,7 +948,7 @@ ERROR:  could not serialize access due to read/write dependencies among transact
 
       <varlistentry>
        <term>
-        <literal>ROW EXCLUSIVE</literal>
+        <literal>ROW EXCLUSIVE</literal> / <literal>RowExclusiveLock</literal>
        </term>
        <listitem>
         <para>
@@ -971,7 +971,7 @@ ERROR:  could not serialize access due to read/write dependencies among transact
 
       <varlistentry>
        <term>
-        <literal>SHARE UPDATE EXCLUSIVE</literal>
+        <literal>SHARE UPDATE EXCLUSIVE</literal> / <literal>ShareUpdateExclusiveLock</literal>
        </term>
        <listitem>
         <para>
@@ -997,7 +997,7 @@ ERROR:  could not serialize access due to read/write dependencies among transact
 
       <varlistentry>
        <term>
-        <literal>SHARE</literal>
+        <literal>SHARE</literal> / <literal>ShareLock</literal>
        </term>
        <listitem>
         <para>
@@ -1017,7 +1017,7 @@ ERROR:  could not serialize access due to read/write dependencies among transact
 
       <varlistentry>
        <term>
-        <literal>SHARE ROW EXCLUSIVE</literal>
+        <literal>SHARE ROW EXCLUSIVE</literal> / <literal>ShareRowExclusiveLock</literal>
        </term>
        <listitem>
         <para>
@@ -1039,7 +1039,7 @@ ERROR:  could not serialize access due to read/write dependencies among transact
 
       <varlistentry>
        <term>
-        <literal>EXCLUSIVE</literal>
+        <literal>EXCLUSIVE</literal> / <literal>ExclusiveLock</literal>
        </term>
        <listitem>
         <para>
@@ -1061,7 +1061,7 @@ ERROR:  could not serialize access due to read/write dependencies among transact
 
       <varlistentry>
        <term>
-        <literal>ACCESS EXCLUSIVE</literal>
+        <literal>ACCESS EXCLUSIVE</literal> / <literal>AccessExclusiveLock</literal>
        </term>
        <listitem>
         <para>

--LGbtvnIBWbWg2hLv--