Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
POTTIER Francois
menhir
Commits
e657c34f
Commit
e657c34f
authored
Nov 12, 2017
by
POTTIER Francois
Browse files
Documentation update.
parent
b7ab5732
Changes
2
Hide whitespace changes
Inline
Side-by-side
CHANGES.md
View file @
e657c34f
# Changes
## 2017/11/12
*
Documentation: clarify the fact that
`%type`
declarations should carry types
whose meaning does not depend on the headers
`%{ ... %}`
.
## 2017/10/13
*
Remove the OCaml version check at installation time, for greater simplicity,
...
...
doc/main.tex
View file @
e657c34f
...
...
@@ -463,6 +463,7 @@ A specification file begins with a sequence of declarations, ended by a
mandatory
\percentpercent
keyword.
\subsubsection
{
Headers
}
\label
{
sec:decls:headers
}
A header is a piece of
\ocaml
code, surrounded with
\dheader
{
and
}
. It is
copied verbatim at the beginning of the
\ml
file. It typically contains
\ocaml
...
...
@@ -539,13 +540,20 @@ assigns an \ocaml type to each of the nonterminal symbols $\nt{lid}_1, \ldots, \
For start symbols, providing an
\ocaml
type is mandatory, but is usually done as part of the
\dstart
declaration. For other symbols, it is optional. Providing type information can improve
the quality of
\ocaml
's type error messages.
% TEMPORARY type information can be mandatory in --coq mode; document?
A
\dtype
declaration may concern not only a nonterminal symbol, such as, say,
\texttt
{
expression
}
, but also a fully applied parameterized nonterminal
symbol, such as
\texttt
{
list(expression)
}
or
\texttt
{
separated
\_
list(COMMA,
option(expression))
}
.
The types provided as part of
\dtype
declarations are copied verbatim to the
\ml
and
\mli
files. In contrast, headers (
\sref
{
sec:decls:headers
}
) are copied
to the
\ml
file only. For this reason, the types provided as part of
\dtype
declarations must make sense both in the presence and in the absence of these
headers. They should typically be fully qualified types.
% TEMPORARY type information can be mandatory in --coq mode; document?
\subsubsection
{
Start symbols
}
\label
{
sec:start
}
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment