How to reference the type of lock in the documentation.

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

On Fri, Jul 8, 2022 at 10:21 AM Bruce Momjian <bruce@momjian.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/

On Fri, Jul 8, 2022 at 11:12:59AM +0900, Masahiko Sawada wrote:

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

I wasn't happy with the '/' so I changed to using parentheses instead.
Updated patch attached, same URL for updated output.

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

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

On Mon, Jul 11, 2022 at 06:50:30PM -0500, Troy Frericks wrote:

Looks awesome!

Patch applied to all supported versions --- thanks for your report.

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

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