Re: [PATCH] minor doc fix for create-role

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: tara(at)anne(dot)cat
Cc: pgsql-hackers(at)postgresql(dot)org
Subject: Re: [PATCH] minor doc fix for create-role
Date: 2019-08-18 16:41:23
Message-ID: 14899.1566146483@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

tara(at)anne(dot)cat writes:
> Attached is a minor patch to fix the name param documentation for create role, just adding a direct quote from user-manag.sgml talking about what the role name is allowed to be. I was searching for this information and figured the reference page should have it as well.

Hm, I guess my reaction to this proposal is "why just here?". We have
an awful lot of different CREATE commands, and none of them say more
about the target name than this one does. (Not to mention ALTER, DROP,
etc.) Perhaps it's worth adding some boilerplate text to all those
places, but I'm dubious.

Also, the specific text proposed for addition doesn't seem that helpful,
since it doesn't define which characters are "special characters".
I'd rather see something like "The name must be a valid SQL identifier
as defined in <link to section 4.1.1>." But, while that would work fine
in HTML output, it would not be particularly short or useful in man-page
output.

Perhaps the ideal solution would be further markup on the synopsis
sections that somehow identifies each term as an "identifier" or
other appropriate syntactic category, and provides a hyperlink to
a definition (in output formats that are friendly to that). Seems
like a lot of work though :-(

regards, tom lane

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Tom Lane 2019-08-18 18:37:34 Re: Unused header file inclusion
Previous Message Jürgen Purtz 2019-08-18 15:29:30 Re: pgsql: doc: Add some images