Date: Wed, 26 Jan 2022 18:32:04 -0500
From: Bruce Momjian <bruce@momjian.us>
To: Alvaro Herrera <alvherre@alvh.no-ip.org>
Cc: Dave Stewart <davs2rt@gmail.com>,
	"David G. Johnston" <david.g.johnston@gmail.com>,
	Tom Lane <tgl@sss.pgh.pa.us>,
	Pg Docs <pgsql-docs@lists.postgresql.org>
Subject: Re: Conventions
Message-ID: <YfHZ9Ecpiy/v1oPN@momjian.us>
References: <YfFuK5fHSAKUN5yV@momjian.us>
 <202201261701.rzej4dlxqyts@alvherre.pgsql>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="anBwoYSoCA4CxaXt"
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <202201261701.rzej4dlxqyts@alvherre.pgsql>
Archived-At: 
 <https://www.postgresql.org/message-id/YfHZ9Ecpiy/v1oPN%40momjian.us>
Precedence: bulk


--anBwoYSoCA4CxaXt
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: 8bit

On Wed, Jan 26, 2022 at 02:01:40PM -0300, Álvaro Herrera wrote:
> On 2022-Jan-26, Bruce Momjian wrote:
> 
> > On Tue, Jan 25, 2022 at 06:45:47PM -0800, Dave Stewart wrote:
> > > I'm good with it.  Thank you!
> > 
> > OK, updated patch attached.  I don't think we even show TCL syntax
> > anywhere anymore, so I removed that text, rather than moving it.
> 
> We do here:
> https://www.postgresql.org/docs/14/pltcl-dbaccess.html
> Maybe not worth bothering, though.  I think it should be obvious to
> someone already familiar with the language; and for those who aren't,
> they probably won't be reading this page.

Oh, that helps.  I looked for '?' in pltcl.sgml and when I couldn't find
any, I think the use of the question-mark syntax was gone, but I do see
it in the output:

	https://www.postgresql.org/docs/14/pltcl-dbaccess.html

and then I found this in stylesheet-common.xsl:

	<!-- Special support for Tcl synopses -->
	
	<xsl:template match="optional[@role='tcl']">
-->	  <xsl:text>?</xsl:text>
	  <xsl:call-template name="inline.charseq"/>
	  <xsl:text>?</xsl:text>
	</xsl:template>

The attached patch moves the TCL syntax mention to a more appropriate
place.

-- 
  Bruce Momjian  <bruce@momjian.us>        https://momjian.us
  EDB                                      https://enterprisedb.com

  If only the physical world exists, free will is an illusion.


--anBwoYSoCA4CxaXt
Content-Type: text/x-diff; charset=us-ascii
Content-Disposition: attachment; filename="paren.diff"

diff --git a/doc/src/sgml/notation.sgml b/doc/src/sgml/notation.sgml
index bd1e8f629a..c3798d5f1b 100644
--- a/doc/src/sgml/notation.sgml
+++ b/doc/src/sgml/notation.sgml
@@ -6,12 +6,12 @@
  <para>
   The following conventions are used in the synopsis of a command:
   brackets (<literal>[</literal> and <literal>]</literal>) indicate
-  optional parts.  (In the synopsis of a Tcl command, question marks
-  (<literal>?</literal>) are used instead, as is usual in Tcl.)  Braces
+  optional parts.  Braces
   (<literal>{</literal> and <literal>}</literal>) and vertical lines
   (<literal>|</literal>) indicate that you must choose one
   alternative.  Dots (<literal>...</literal>) mean that the preceding element
-  can be repeated.
+  can be repeated.  All other symbols, including parentheses, should be
+  taken literally.
  </para>
 
  <para>
diff --git a/doc/src/sgml/pltcl.sgml b/doc/src/sgml/pltcl.sgml
index 1759fc4498..6ef968e078 100644
--- a/doc/src/sgml/pltcl.sgml
+++ b/doc/src/sgml/pltcl.sgml
@@ -321,7 +321,8 @@ $$ LANGUAGE pltcl;
 
     <para>
      The following commands are available to access the database from
-     the body of a PL/Tcl function:
+     the body of a PL/Tcl function (brackets (<literal>[</literal> and
+     <literal>]</literal>) are represented here as question marks):
 
     <variablelist>
 

--anBwoYSoCA4CxaXt--