Re: Documentation patch: change a name in a grammar rule

OK, updated patch calls them "configuration_paramters"s.

---------------------------------------------------------------------------

Nicolas Barbier wrote:
> 2006/4/17, Peter Eisentraut <peter_e@gmx.net>:
>
> > Nicolas Barbier wrote:
> >
> >> In for example set.sgml, just "name" is used for the exact same
> >> concept. I changed the patch so that "varname" is used, because
> >> "name" was already in use by this specific grammar. Maybe the usage
> >> of "var" makes it less clear indeed, for people that know that those
> >> things are always referred to as "parameters" and never as
> >> "variables".
> >
> > A variable would be something that you store application data in,
> > whereas a parameter is some nondata value that influences your
> > calculations.  That's my recollection of how the terms are used in
> > mathematics.  So parameter is decidedly the better term than variable.
> > If that is confusing, make it config_param or something like that.
>
> Updated patch attached. We just had another person that made the
> mistake, hopefully making up for the time and resources I'm depriving
> you guys of :-).
>
> Nicolas
>
> --
> Nicolas Barbier
> http://www.gnu.org/philosophy/no-word-attachments.html

[ Attachment, skipping... ]

>
> ---------------------------(end of broadcast)---------------------------
> TIP 6: explain analyze is your friend

--
  Bruce Momjian   http://candle.pha.pa.us
  EnterpriseDB    http://www.enterprisedb.com

  + If your life is a hard drive, Christ can be your backup. +
Index: doc/src/sgml/ref/alter_role.sgml
===================================================================
RCS file: /cvsroot/pgsql/doc/src/sgml/ref/alter_role.sgml,v
retrieving revision 1.4
diff -c -c -r1.4 alter_role.sgml
*** doc/src/sgml/ref/alter_role.sgml    25 Apr 2006 14:47:29 -0000    1.4
--- doc/src/sgml/ref/alter_role.sgml    25 Apr 2006 14:55:23 -0000
***************
*** 36,43 ****

  ALTER ROLE <replaceable class="PARAMETER">name</replaceable> RENAME TO <replaceable>newname</replaceable>

! ALTER ROLE <replaceable class="PARAMETER">name</replaceable> SET <replaceable>varname</replaceable> { TO | = } {
<replaceable>value</replaceable>| DEFAULT } 
! ALTER ROLE <replaceable class="PARAMETER">name</replaceable> RESET <replaceable>varname</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>configuration_parameter</replaceable> {
TO| = } { <replaceable>value</replaceable> | DEFAULT } 
! ALTER ROLE <replaceable class="PARAMETER">name</replaceable> RESET <replaceable>configuration_parameter</replaceable>
  </synopsis>
   </refsynopsisdiv>

***************
*** 143,149 ****
       </varlistentry>

       <varlistentry>
!       <term><replaceable>varname</replaceable></term>
        <term><replaceable>value</replaceable></term>
        <listitem>
         <para>
--- 143,149 ----
       </varlistentry>

       <varlistentry>
!       <term><replaceable>configuration_parameter</replaceable></term>
        <term><replaceable>value</replaceable></term>
        <listitem>
         <para>
Index: doc/src/sgml/ref/alter_user.sgml
===================================================================
RCS file: /cvsroot/pgsql/doc/src/sgml/ref/alter_user.sgml,v
retrieving revision 1.40
diff -c -c -r1.40 alter_user.sgml
*** doc/src/sgml/ref/alter_user.sgml    25 Apr 2006 14:47:29 -0000    1.40
--- doc/src/sgml/ref/alter_user.sgml    25 Apr 2006 14:55:23 -0000
***************
*** 36,43 ****

  ALTER USER <replaceable class="PARAMETER">name</replaceable> RENAME TO <replaceable>newname</replaceable>

! ALTER USER <replaceable class="PARAMETER">name</replaceable> SET <replaceable>varname</replaceable> { TO | = } {
<replaceable>value</replaceable>| DEFAULT } 
! ALTER USER <replaceable class="PARAMETER">name</replaceable> RESET <replaceable>varname</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>configuration_parameter</replaceable> {
TO| = } { <replaceable>value</replaceable> | DEFAULT } 
! ALTER USER <replaceable class="PARAMETER">name</replaceable> RESET <replaceable>configuration_parameter</replaceable>
  </synopsis>
   </refsynopsisdiv>

Index: doc/src/sgml/ref/reset.sgml
===================================================================
RCS file: /cvsroot/pgsql/doc/src/sgml/ref/reset.sgml,v
retrieving revision 1.29
diff -c -c -r1.29 reset.sgml
*** doc/src/sgml/ref/reset.sgml    25 Apr 2006 14:47:29 -0000    1.29
--- doc/src/sgml/ref/reset.sgml    25 Apr 2006 14:55:23 -0000
***************
*** 20,26 ****

   <refsynopsisdiv>
  <synopsis>
! RESET <replaceable class="PARAMETER">varname</replaceable>
  RESET ALL
  </synopsis>
   </refsynopsisdiv>
--- 20,26 ----

   <refsynopsisdiv>
  <synopsis>
! RESET <replaceable class="PARAMETER">configuration_parameter</replaceable>
  RESET ALL
  </synopsis>
   </refsynopsisdiv>
***************
*** 33,39 ****
     default values.  <command>RESET</command> is an alternative
     spelling for
  <synopsis>
! SET <replaceable class="parameter">varname</replaceable> TO DEFAULT
  </synopsis>
     Refer to <xref linkend="sql-set" endterm="sql-set-title"> for
     details.
--- 33,39 ----
     default values.  <command>RESET</command> is an alternative
     spelling for
  <synopsis>
! SET <replaceable class="parameter">configuration_parameter</replaceable> TO DEFAULT
  </synopsis>
     Refer to <xref linkend="sql-set" endterm="sql-set-title"> for
     details.
***************
*** 62,68 ****

    <variablelist>
     <varlistentry>
!     <term><replaceable class="PARAMETER">varname</replaceable></term>
      <listitem>
       <para>
        The name of a run-time parameter. See <xref linkend="sql-set"
--- 62,68 ----

    <variablelist>
     <varlistentry>
!     <term><replaceable class="PARAMETER">configuration_parameter</replaceable></term>
      <listitem>
       <para>
        The name of a run-time parameter. See <xref linkend="sql-set"
Index: doc/src/sgml/ref/set.sgml
===================================================================
RCS file: /cvsroot/pgsql/doc/src/sgml/ref/set.sgml,v
retrieving revision 1.87
diff -c -c -r1.87 set.sgml
*** doc/src/sgml/ref/set.sgml    25 Apr 2006 14:47:29 -0000    1.87
--- doc/src/sgml/ref/set.sgml    25 Apr 2006 14:55:23 -0000
***************
*** 20,26 ****

   <refsynopsisdiv>
  <synopsis>
! SET [ SESSION | LOCAL ] <replaceable class="PARAMETER">varname</replaceable> { TO | = } { <replaceable
class="PARAMETER">value</replaceable>| '<replaceable class="PARAMETER">value</replaceable>' | DEFAULT } 
  SET [ SESSION | LOCAL ] TIME ZONE { <replaceable class="PARAMETER">timezone</replaceable> | LOCAL | DEFAULT }
  </synopsis>
   </refsynopsisdiv>
--- 20,26 ----

   <refsynopsisdiv>
  <synopsis>
! SET [ SESSION | LOCAL ] <replaceable class="PARAMETER">configuration_parameter</replaceable> { TO | = } {
<replaceableclass="PARAMETER">value</replaceable> | '<replaceable class="PARAMETER">value</replaceable>' | DEFAULT } 
  SET [ SESSION | LOCAL ] TIME ZONE { <replaceable class="PARAMETER">timezone</replaceable> | LOCAL | DEFAULT }
  </synopsis>
   </refsynopsisdiv>
***************
*** 91,97 ****
     </varlistentry>

     <varlistentry>
!     <term><replaceable class="PARAMETER">varname</replaceable></term>
      <listitem>
       <para>
        Name of a settable run-time parameter.  Available parameters are
--- 91,97 ----
     </varlistentry>

     <varlistentry>
!     <term><replaceable class="PARAMETER">configuration_parameter</replaceable></term>
      <listitem>
       <para>
        Name of a settable run-time parameter.  Available parameters are