Re: How to reference the type of lock in the documentation.

From: Masahiko Sawada <sawada(dot)mshk(at)gmail(dot)com>
To: Bruce Momjian <bruce(at)momjian(dot)us>
Cc: troy(at)frericks(dot)us, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: How to reference the type of lock in the documentation.
Date: 2022-07-08 02:12:59
Message-ID: CAD21AoATecBK0=bRnLfGaptvPPk7sg1QkWLdyJcstU77feRnXw@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Fri, Jul 8, 2022 at 10:21 AM Bruce Momjian <bruce(at)momjian(dot)us> wrote:
>
> 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.

+1

Regards,

--
Masahiko Sawada
EDB: https://www.enterprisedb.com/

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Bruce Momjian 2022-07-08 15:17:29 Re: How to reference the type of lock in the documentation.
Previous Message Bruce Momjian 2022-07-08 01:20:55 Re: How to reference the type of lock in the documentation.