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

From: Bruce Momjian <bruce(at)momjian(dot)us>
To: 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 01:20:55
Message-ID: YseGd7IEIK3i7Fw3@momjian.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

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(at)momjian(dot)us> https://momjian.us
EDB https://enterprisedb.com

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

Attachment Content-Type Size
lock.diff text/x-diff 2.6 KB

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Masahiko Sawada 2022-07-08 02:12:59 Re: How to reference the type of lock in the documentation.
Previous Message Noboru Saito 2022-07-07 01:38:05 Re: proposal: convert comments in documents to html comments