Received: from malur.postgresql.org ([217.196.149.56])
	by arkaria.postgresql.org with esmtps
 (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256)
	(Exim 4.92)
	(envelope-from <pgsql-hackers-owner+archive@lists.postgresql.org>)
	id 1nrMXz-0001if-2B
	for pgsql-hackers@arkaria.postgresql.org; Wed, 18 May 2022 16:29:15 +0000
Received: from localhost ([127.0.0.1] helo=malur.postgresql.org)
	by malur.postgresql.org with esmtp (Exim 4.92)
	(envelope-from <pgsql-hackers-owner+archive@lists.postgresql.org>)
	id 1nrMXx-0003im-QE
	for pgsql-hackers@arkaria.postgresql.org; Wed, 18 May 2022 16:29:13 +0000
Received: from magus.postgresql.org ([2a02:c0:301:0:ffff::29])
	by malur.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256)
	(Exim 4.92)
	(envelope-from <tgl@sss.pgh.pa.us>)
	id 1nrMXx-0003id-Gz
	for pgsql-hackers@lists.postgresql.org; Wed, 18 May 2022 16:29:13 +0000
Received: from sss.pgh.pa.us ([66.207.139.130])
	by magus.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256)
	(Exim 4.92)
	(envelope-from <tgl@sss.pgh.pa.us>)
	id 1nrMXv-0005CF-87
	for pgsql-hackers@lists.postgresql.org; Wed, 18 May 2022 16:29:13 +0000
Received: from sss1.sss.pgh.pa.us (localhost [127.0.0.1])
	by sss.pgh.pa.us (8.15.2/8.15.2) with ESMTP id 24IGT5hj017624;
	Wed, 18 May 2022 12:29:05 -0400
From: Tom Lane <tgl@sss.pgh.pa.us>
To: Peter Eisentraut <peter.eisentraut@enterprisedb.com>
cc: Kyotaro Horiguchi <horikyota.ntt@gmail.com>,
        pgsql-hackers@lists.postgresql.org
Subject: Re: create_help.pl treats <literal> as replaceable
In-reply-to: <b4773b4a-3c2c-336a-6904-297d9accd5dc@enterprisedb.com>
References: <20220517.174342.1884842412165214815.horikyota.ntt@gmail.com>
 <1581685.1652800163@sss.pgh.pa.us>
 <b4773b4a-3c2c-336a-6904-297d9accd5dc@enterprisedb.com>
Comments: In-reply-to Peter Eisentraut <peter.eisentraut@enterprisedb.com>
	message dated "Wed, 18 May 2022 18:22:15 +0200"
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-ID: <17622.1652891345.1@sss.pgh.pa.us>
Date: Wed, 18 May 2022 12:29:05 -0400
Message-ID: <17623.1652891345@sss.pgh.pa.us>
List-Id: <pgsql-hackers.lists.postgresql.org>
List-Help: <https://lists.postgresql.org/manage/>
List-Subscribe: <https://lists.postgresql.org/manage/>
List-Post: <mailto:pgsql-hackers@lists.postgresql.org>
List-Owner: <mailto:pgsql-hackers-owner@lists.postgresql.org>
List-Archive: <https://www.postgresql.org/list/pgsql-hackers>
Archived-At: 
 <https://www.postgresql.org/message-id/17623.1652891345%40sss.pgh.pa.us>
Precedence: bulk

Peter Eisentraut <peter.eisentraut@enterprisedb.com> writes:
> On 17.05.22 17:09, Tom Lane wrote:
>> Isn't that a documentation bug rather than a problem with create_help?

> Yeah, there is no need for a <literal> inside a <synopsis>.  So I just 
> removed it.

I think you should have upper-cased MATCH while at it, to make it clear
that it acts like a keyword in this context.  The current situation is
quite unreadable in plain-ASCII output:

regression=# \help copy
Command:     COPY
...
    HEADER [ boolean | match ]
...

Since "boolean" is a metasyntactic variable here, it's absolutely
not obvious that "match" isn't.

			regards, tom lane