From: Rod Taylor <rbt@rbt.ca>
To: PostgreSQL Docs <pgsql-docs@postgresql.org>
Cc: PostgreSQL Patches <pgsql-patches@postgresql.org>
Subject: Synopsis inconsistencies
Date: 11 Jun 2003 23:36:47 -0400
Message-ID: <1055389007.50088.19.camel@jester> (raw)
Most of the synopsis areas for DROP commands use "name" as the
identifier, while some areas do not.
The attached converts be below to "name":
conversion_name
index_name
The below have an existing, initdb supplied, entity named "name". As
such, it could be confusing for the reader to see that identifier used
in the example.
domainname
typename
Perhaps we should be going the otherway and converting the other uses of
"name" into "group_name", "user_name", "function_name", etc.
--
Rod Taylor <rbt@rbt.ca>
PGP Key: http://www.rbt.ca/rbtpub.ascAttachments:name.patch (text/x-patch, 3.2K) download
Index: create_conversion.sgml
===================================================================
RCS file: /home/rbt/work/postgresql/cvs/pgsql-server/doc/src/sgml/ref/create_conversion.sgml,v
retrieving revision 1.8
diff -c -r1.8 create_conversion.sgml
*** create_conversion.sgml 22 Apr 2003 10:08:08 -0000 1.8
--- create_conversion.sgml 12 Jun 2003 03:34:18 -0000
***************
*** 13,19 ****
<refsynopsisdiv>
<synopsis>
! CREATE [DEFAULT] CONVERSION <replaceable>conversion_name</replaceable>
FOR <replaceable>source_encoding</replaceable> TO <replaceable>dest_encoding</replaceable> FROM <replaceable>funcname</replaceable>
</synopsis>
</refsynopsisdiv>
--- 13,19 ----
<refsynopsisdiv>
<synopsis>
! CREATE [DEFAULT] CONVERSION <replaceable>name</replaceable>
FOR <replaceable>source_encoding</replaceable> TO <replaceable>dest_encoding</replaceable> FROM <replaceable>funcname</replaceable>
</synopsis>
</refsynopsisdiv>
***************
*** 55,61 ****
</varlistentry>
<varlistentry>
! <term><replaceable>conversion_name</replaceable></term>
<listitem>
<para>
--- 55,61 ----
</varlistentry>
<varlistentry>
! <term><replaceable>name</replaceable></term>
<listitem>
<para>
Index: drop_index.sgml
===================================================================
RCS file: /home/rbt/work/postgresql/cvs/pgsql-server/doc/src/sgml/ref/drop_index.sgml,v
retrieving revision 1.17
diff -c -r1.17 drop_index.sgml
*** drop_index.sgml 4 May 2003 02:23:16 -0000 1.17
--- drop_index.sgml 12 Jun 2003 03:34:00 -0000
***************
*** 16,22 ****
<refsynopsisdiv>
<synopsis>
! DROP INDEX <replaceable class="PARAMETER">index_name</replaceable> [, ...] [ CASCADE | RESTRICT ]
</synopsis>
</refsynopsisdiv>
--- 16,22 ----
<refsynopsisdiv>
<synopsis>
! DROP INDEX <replaceable class="PARAMETER">name</replaceable> [, ...] [ CASCADE | RESTRICT ]
</synopsis>
</refsynopsisdiv>
***************
*** 35,41 ****
<variablelist>
<varlistentry>
! <term><replaceable class="PARAMETER">index_name</replaceable></term>
<listitem>
<para>
The name (optionally schema-qualified) of an index to remove.
--- 35,41 ----
<variablelist>
<varlistentry>
! <term><replaceable class="PARAMETER">name</replaceable></term>
<listitem>
<para>
The name (optionally schema-qualified) of an index to remove.
***************
*** 78,88 ****
</varlistentry>
<varlistentry>
! <term><computeroutput>ERROR: index "<replaceable class="PARAMETER">index_name</replaceable>" does not exist</computeroutput></term>
<listitem>
<para>
This message is returned if <replaceable
! class="PARAMETER">index_name</replaceable> is not an existing
index.
</para>
</listitem>
--- 78,88 ----
</varlistentry>
<varlistentry>
! <term><computeroutput>ERROR: index "<replaceable class="PARAMETER">name</replaceable>" does not exist</computeroutput></term>
<listitem>
<para>
This message is returned if <replaceable
! class="PARAMETER">name</replaceable> is not an existing
index.
</para>
</listitem>
signature.asc (application/pgp-signature, 186B) download
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: rbt@rbt.ca, pgsql-patches@postgresql.org
Subject: Re: Synopsis inconsistencies
In-Reply-To: <1055389007.50088.19.camel@jester>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox