ÖÐÎâÄϹËΩһЦ

Description:
I would like to suggest some ways of keeping the documentation of mysql
syntax changes up to date, as those changes are made by the developers
of mysql.

Any changes made to the internals of mysql may not be immediately
apparent, or of any particular concern, to joe bloggs average user of
mysql.

As the syntax is joe bloggs way of communicating with mysql, he needs
to know about these changes right away.

IMHO, There needs to be some sort of methodology in place that will
ensure changes made to mysql syntax are properly documented by the
developers as those changes are made.

How can this be accomplished?

Well, I did start Jack Crenshaw's "Let's build a compiler" course,
around 98-98. http://compilers.iecc.com/crenshaw/

(I realise that Jack only covers top-down resursive-descent one-pass
compilation techniques, and hand written parsers, but I'm sure that the
method mentioned below is applicable to other types of parsers as well.)

One of the tips Jack mentions is how to go about designing your parser.

He suggests that parser design is first done using BNF syntax diagrams.
(IIRC he actually suggests the use of XBNF diagrams.)

Then use the BNF (or XBNF) as a blueprint to convert that particular syntax
construct into parser code.

By using this method, all mysql syntax documentation is guaranteed to be
up to date, as the documentation is actually designed first, before
changes to the code have been implemeted. Bearing this idea of Jack's in
mind, may I suggest the following methodology for documenting the changes
made to mysql syntax.

1. Changes to the mysql syntax are limited to core parser developers of
 MySQL AB only.

 (Maybe there needs to be a small team of MySQL AB persons that are
 directly responsible for implementing changes to the mysql syntax,
 using the method mentioned above.)

2. Anyone can make suggestions to improve mysql syntax, by submitting a bug
 report.

3. Only the MySQL AB parser team can implement changes to mysql syntax,
 whether it be suggestions submitted via a bug report, or ideas from any
 other sources.

4. The parser team designs the new mysql syntax with (X)BNF diagrams.

5. The syntax changes are made to the mysql program code by the parser
 team, or a member of the team.

6. The changes are tested and approved for inclusion in the next release of
 mysql.

7. When the changes have been approved for the next release, the (X)BNF is
 then passed along to Stefan Hinz for inclusion in the reference manual.

Hopefully, this will keep all changes to mysql syntax current and up to
date.

Kind Regards

Keith Roberts

How to repeat:
Just test the documented syntax using the mysql monitor program.

Suggested fix:
Limit mysql syntax changes to a small number of core developers only, and use some sort
of methodology for implementing those syntax changes that will ensure those changes are
properly documented as soon as they have been implemented and accepted into the next
release of mysql.