Re: doc - add missing documentation for "acldefault" - Mailing list pgsql-hackers

From Joe Conway
Subject Re: doc - add missing documentation for "acldefault"
Date
Msg-id 79481421-29ce-f066-3db8-2223e531f0dc@joeconway.com
Whole thread Raw
In response to Re: doc - add missing documentation for "acldefault"  (Fabien COELHO <coelho@cri.ensmp.fr>)
Responses Re: doc - add missing documentation for "acldefault"  (Tom Lane <tgl@sss.pgh.pa.us>)
List pgsql-hackers
On 08/03/2018 09:04 AM, Fabien COELHO wrote:
> Here is a version of the patch which documents briefly all aclitem-related
> functions, in a separate table.

I claimed this patch for review and commit. Comments:
---
* There is a comment in src/backend/utils/adt/acl.c noting that
  acldefault is "not documented for general use" which needs adjustment

* It makes no sense to me to document purely internal functions, e.g.
  aclitemin/out. If we are going to do that we should do it universally,
  which is not true currently, and IMHO makes no sense anyway.

* I do believe aclitemeq() has utility outside internal purposes.

* The <indexterm> section is incomplete

* Interestingly (since that is what started this thread apparently) I
  found myself questioning whether acldefault() is really worth
  documenting since the result will be misleading if the defaults have
  been altered via SQL.
---

Attached patch addresses those items and does a bit of reordering and
editorialization. If there are no objections I will commit it this way
in a day or two.

Thanks,

Joe

--
Crunchy Data - http://crunchydata.com
PostgreSQL Support for Secure Enterprises
Consulting, Training, & Open Source Development

Attachment

pgsql-hackers by date:

Previous
From: Arthur Zakirov
Date:
Subject: Re: [HACKERS] proposal: schema variables
Next
From: Michael Banck
Date:
Subject: Re: Online verification of checksums