Re: Syntax diagrams in user documentation

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Christopher Browne <cbbrowne(at)gmail(dot)com>
Cc: Peter Geoghegan <pg(at)bowt(dot)ie>, PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Syntax diagrams in user documentation
Date: 2019-03-29 03:42:35
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-hackers

Christopher Browne <cbbrowne(at)gmail(dot)com> writes:
> An especially cool idea if we could automatically dig input directly from
> src/backend/parser/gram.y

FWIW, I think the odds of getting desirable diagrams that way are nil.
There are *way* too many things about our Bison grammar that can
be described charitably as implementation details, or uncharitably
as ugly hacks.

It may or may not be useful to present the grammar as railroad
diagrams or the like; but I think we need to expect that that'd be
an abstraction of the syntax, not something that can be automatically
reverse-engineered from the implementation.

It might be more useful to try to generate pretty pictures from
the SGML^H^H^H^HXML docs' <synopsis> sections.

regards, tom lane

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Amit Langote 2019-03-29 03:44:44 Re: speeding up planning with partitions
Previous Message Tsunakawa, Takayuki 2019-03-29 03:36:45 RE: Timeout parameters