Camlp4 documentation priorities
From Gallium
Feel free to put here documentation points that you would like to be extended in priority.
Contents |
[edit]
Summary on how to upgrade syntax extensions from 3.09 to 3.10
[edit]
List of valid OCaml-AST quotations (<:expr< ... >>, ...) in the old and in the new camlp4
Something similar requested by Hendrik Tews: an ocaml grammar annotated with all possible quotations/antiquotations, like I attempted on http://wwwtcs.inf.tu-dresden.de/~tews/ocamlp4/qo_doc.html, preferably for original and revised syntax.
There is an attempt to give the grammar of quotations (revised) in Abstract Syntax Tree.
[edit]
List of contributed source-code examples using camlp4 3.10 (see Camlp4 contributions)
[edit]
Wanted: Reference Manual
We need a comprehensive reference manual that includes:
- A complete description of all the features that are officially supported. This should cover at least all the features that used to exist in 3.09.
- Examples that are guaranteed to work for the version of Camlp4 being described, including:
- Every shell command that is needed for compiling and running each example
- Comments where needed
- Downloadable tarball containing everything needed to run the examples assuming a basic installation of the core OCaml distribution.
- Better no example than an example that is not guaranteed to work in the current or future versions of Camlp4.
- A read-only version of the manual with each official release of OCaml/Camlp4
- A copy of any source file that is needed for using Camlp4. This may include Camlp4OCamlParser.ml if needed, even though a clear API is preferred.
Without such a manual, it is not possible to translate any non-trivial syntax extension to Camlp4 3.10. It is not possible to write any tutorial either.
Reusing some of the structure of the Camlp4 3.09 or Camlp5 reference manual seems like a good idea.