Documentation patch: change a name in a grammar rule to prevent confusion

From: "Nicolas Barbier" <nicolas(dot)barbier(at)gmail(dot)com>
To: "PostgreSQL Patches" <pgsql-patches(at)postgresql(dot)org>
Subject: Documentation patch: change a name in a grammar rule to prevent confusion
Date: 2006-04-14 23:59:09
Message-ID: b0f3f5a10604141659l7bcf1956t98b809d5090f2147@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-patches

Hello,

the following patch changes "parameter" to "gucname" in the grammar
(and later references) for the SET syntax in ALTER ROLE and ALTER
USER. The rationale for this is that on #postgresql (IRC), we observe
many people trying to change the password for a role as follows:

ALTER ROLE blah SET PASSWORD = 'password';

(the correct syntax is "ALTER ROLE blah PASSWORD 'password';")

The confusion is induced by the usage of the word "parameter" and the
name of a section called "Parameters", which then lists the possible
non-GUC parameters. This apparently makes readers think that those are
the "parameters" that can be changed with above syntax.

Nicolas

--
Nicolas Barbier
http://www.gnu.org/philosophy/no-word-attachments.html

Attachment Content-Type Size
pgsql_doc_alter_role_clarification.patch text/x-patch 2.5 KB

Responses

Browse pgsql-patches by date

  From Date Subject
Next Message Neil Conway 2006-04-15 01:11:55 Re: Documentation patch: change a name in a grammar rule
Previous Message Tom Lane 2006-04-14 16:07:15 Re: Proposed doc-patch: Identifying the Current WAL file