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
*** ./doc/src/sgml/ref/alter_role.sgml.orig	2006-04-15 01:15:51.000000000 +0200
--- ./doc/src/sgml/ref/alter_role.sgml	2006-04-15 01:16:02.000000000 +0200
***************
*** 36,43 ****
  
  ALTER ROLE <replaceable class="PARAMETER">name</replaceable> RENAME TO <replaceable>newname</replaceable>
  
! ALTER ROLE <replaceable class="PARAMETER">name</replaceable> SET <replaceable>parameter</replaceable> { TO | = } { <replaceable>value</replaceable> | DEFAULT }
! ALTER ROLE <replaceable class="PARAMETER">name</replaceable> RESET <replaceable>parameter</replaceable>
  </synopsis>
   </refsynopsisdiv>
  
--- 36,43 ----
  
  ALTER ROLE <replaceable class="PARAMETER">name</replaceable> RENAME TO <replaceable>newname</replaceable>
  
! ALTER ROLE <replaceable class="PARAMETER">name</replaceable> SET <replaceable>gucname</replaceable> { TO | = } { <replaceable>value</replaceable> | DEFAULT }
! ALTER ROLE <replaceable class="PARAMETER">name</replaceable> RESET <replaceable>gucname</replaceable>
  </synopsis>
   </refsynopsisdiv>
  
***************
*** 143,149 ****
       </varlistentry>
  
       <varlistentry>
!       <term><replaceable>parameter</replaceable></term>
        <term><replaceable>value</replaceable></term>
        <listitem>
         <para>
--- 143,149 ----
       </varlistentry>
  
       <varlistentry>
!       <term><replaceable>gucname</replaceable></term>
        <term><replaceable>value</replaceable></term>
        <listitem>
         <para>
*** ./doc/src/sgml/ref/alter_user.sgml.orig	2006-04-15 01:15:51.000000000 +0200
--- ./doc/src/sgml/ref/alter_user.sgml	2006-04-15 01:16:02.000000000 +0200
***************
*** 36,43 ****
  
  ALTER USER <replaceable class="PARAMETER">name</replaceable> RENAME TO <replaceable>newname</replaceable>
  
! ALTER USER <replaceable class="PARAMETER">name</replaceable> SET <replaceable>parameter</replaceable> { TO | = } { <replaceable>value</replaceable> | DEFAULT }
! ALTER USER <replaceable class="PARAMETER">name</replaceable> RESET <replaceable>parameter</replaceable>
  </synopsis>
   </refsynopsisdiv>
  
--- 36,43 ----
  
  ALTER USER <replaceable class="PARAMETER">name</replaceable> RENAME TO <replaceable>newname</replaceable>
  
! ALTER USER <replaceable class="PARAMETER">name</replaceable> SET <replaceable>gucname</replaceable> { TO | = } { <replaceable>value</replaceable> | DEFAULT }
! ALTER USER <replaceable class="PARAMETER">name</replaceable> RESET <replaceable>gucname</replaceable>
  </synopsis>
   </refsynopsisdiv>
  



---------------------------(end of broadcast)---------------------------
TIP 3: Have you checked our extensive FAQ?

               http://www.postgresql.org/docs/faq

Reply via email to