Postgres Pro
Downloads
Home   >   mailing lists

Re: Syntax diagrams in user documentation - Mailing list pgsql-hackers

From Christopher Browne
Subject Re: Syntax diagrams in user documentation
Date
Msg-id CAFNqd5VxLLM+QikD7QNZ=Lq8myd+xcAvhMjCrr-1ZWX=Eq1AFQ@mail.gmail.com
Whole thread Raw
In response to Syntax diagrams in user documentation  (Peter Geoghegan <pg@bowt.ie>)
Responses Re: Syntax diagrams in user documentation
List pgsql-hackers
Tree view
On Thu, 28 Mar 2019 at 17:56, Peter Geoghegan <pg@bowt.ie> wrote:
SQLite has a bubble generator tool that they use to generate syntax
diagrams for their documentation:

https://www.sqlite.org/docsrc/doc/tip/art/syntax/bubble-generator.tcl?mimetype=text/plain

I think that the results are rather good. See, for example, the INSERT
documentation:

https://www.sqlite.org/lang_insert.html

neato!

(And no coincidence that GraphViz has a command by that name...  https://www.graphviz.org/pdf/neatoguide.pdf)

An especially cool idea if we could automatically dig input directly from src/backend/parser/gram.y
--
When confronted by a difficult problem, solve it by reducing it to the
question, "How would the Lone Ranger handle this?"

pgsql-hackers by date:

Previous
From: Alvaro Herrera
Date:
Subject: Re: Syntax diagrams in user documentation
Next
From: Tom Lane
Date:
Subject: Re: speeding up planning with partitions