Re: pgrowlocks columns do not match docs: "modes" instead of "lock_type"

From: Michael Paquier <michael(at)paquier(dot)xyz>
To: chris+postgresql(at)qwirx(dot)com, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: pgrowlocks columns do not match docs: "modes" instead of "lock_type"
Date: 2018-10-02 07:41:52
Message-ID: 20181002074152.GD17642@paquier.xyz
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Mon, Oct 01, 2018 at 09:42:08AM +0000, PG Doc comments form wrote:
> The description of the pgrowlocks extension says that the function returns a
> column called "lock_type". However this column is really called "modes", as
> shown in contrib/pgrowlocks/pgrowlocks--1.2.sql:
>
> CREATE FUNCTION pgrowlocks(IN relname text,
> OUT locked_row TID, -- row TID
> OUT locker XID, -- locking XID
> OUT multi bool, -- multi XID?
> OUT xids xid[], -- multi XIDs
> OUT modes text[], -- multi XID statuses
> OUT pids INTEGER[]) -- locker's process id
> RETURNS SETOF record
> AS 'MODULE_PATHNAME', 'pgrowlocks'
> LANGUAGE C STRICT PARALLEL SAFE;

0ac5ad5 has updated pgrowlocks from 1.0 to 1.1 and it forgot the
documentation. The order of the columns is correct, but the example was
not. So I updated the documentation with a fresh one, and fixed it all
the way down to 9.3. Thanks for the report, Chris!
--
Michael

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Joe Conway 2018-10-02 12:45:37 Re: dblink_error_message return value
Previous Message PG Doc comments form 2018-10-01 09:42:08 pgrowlocks columns do not match docs: "modes" instead of "lock_type"