Commit 2b61be07 authored by Guillaume Melquiond's avatar Guillaume Melquiond

Move away most of the generated files from doc/ as it is getting crowded.

parent 54d6b937
...@@ -120,21 +120,17 @@ why3.conf ...@@ -120,21 +120,17 @@ why3.conf
/doc/manual.synctex.gz /doc/manual.synctex.gz
/doc/*.haux /doc/*.haux
/doc/*.pdf /doc/*.pdf
/doc/generated/
/doc/html/ /doc/html/
/doc/*.hind /doc/*.hind
/doc/*.htoc /doc/*.htoc
/doc/bnf /doc/bnf
/doc/bnf.ml /doc/bnf.ml
/doc/*_bnf.tex
/doc/apidoc.tex /doc/apidoc.tex
/doc/apidoc/ /doc/apidoc/
/doc/stdlibdoc/ /doc/stdlibdoc/
/doc/texput.log /doc/texput.log
/doc/extract_ocaml_code /doc/extract_ocaml_code
/doc/logic_*.ml
/doc/call_provers_*.ml
/doc/whyconf_*.ml
/doc/*__*.ml
# /lib # /lib
/lib/why3-cpulimit /lib/why3-cpulimit
......
...@@ -1860,9 +1860,9 @@ doc: doc/manual.pdf doc/html/index.html ...@@ -1860,9 +1860,9 @@ doc: doc/manual.pdf doc/html/index.html
BNF = ident qualid attribute constant operator type formula term1 term2 term3 \ BNF = ident qualid attribute constant operator type formula term1 term2 term3 \
theory theory2 \ theory theory2 \
why_file spec expr expr2 module whyml_file term_old_at why_file spec expr expr2 module whyml_file term_old_at
BNFTEX = $(BNF:%=doc/%_bnf.tex) BNFTEX = $(BNF:%=doc/generated/%_bnf.tex)
doc/%_bnf.tex: doc/%.bnf doc/bnf$(EXE) doc/generated/%_bnf.tex: doc/%.bnf doc/bnf$(EXE)
doc/bnf$(EXE) $< > $@ doc/bnf$(EXE) $< > $@
doc/bnf$(EXE): doc/bnf.mll doc/bnf$(EXE): doc/bnf.mll
...@@ -1872,19 +1872,19 @@ doc/bnf$(EXE): doc/bnf.mll ...@@ -1872,19 +1872,19 @@ doc/bnf$(EXE): doc/bnf.mll
doc/extract_ocaml_code: doc/extract_ocaml_code.ml doc/extract_ocaml_code: doc/extract_ocaml_code.ml
$(OCAMLC) str.cma -o $@ $< $(OCAMLC) str.cma -o $@ $<
doc/logic__%.ml: examples/use_api/logic.ml doc/extract_ocaml_code doc/generated/logic__%.ml: examples/use_api/logic.ml doc/extract_ocaml_code
doc/extract_ocaml_code $* < $< > $@ doc/extract_ocaml_code $* < $< > $@
doc/whyconf__%.ml: src/driver/whyconf.ml doc/extract_ocaml_code doc/generated/whyconf__%.ml: src/driver/whyconf.ml doc/extract_ocaml_code
doc/extract_ocaml_code $* < $< > $@ doc/extract_ocaml_code $* < $< > $@
doc/call_provers__%.ml: src/driver/call_provers.ml doc/extract_ocaml_code doc/generated/call_provers__%.ml: src/driver/call_provers.ml doc/extract_ocaml_code
doc/extract_ocaml_code $* < $< > $@ doc/extract_ocaml_code $* < $< > $@
doc/mlw_tree__%.ml: examples/use_api/mlw_tree.ml doc/extract_ocaml_code doc/generated/mlw_tree__%.ml: examples/use_api/mlw_tree.ml doc/extract_ocaml_code
doc/extract_ocaml_code $* < $< > $@ doc/extract_ocaml_code $* < $< > $@
doc/transform__%.ml: examples/use_api/transform.ml doc/extract_ocaml_code doc/generated/transform__%.ml: examples/use_api/transform.ml doc/extract_ocaml_code
doc/extract_ocaml_code $* < $< > $@ doc/extract_ocaml_code $* < $< > $@
OCAMLCODE_LOGIC = opening printformula declarepropvars declarepropatoms \ OCAMLCODE_LOGIC = opening printformula declarepropvars declarepropatoms \
...@@ -1904,11 +1904,12 @@ OCAMLCODE_MLWTREE = buildenv openmodule useimport \ ...@@ -1904,11 +1904,12 @@ OCAMLCODE_MLWTREE = buildenv openmodule useimport \
source1 code1 helper1 source2 code2 source3 code3 \ source1 code1 helper1 source2 code2 source3 code3 \
closemodule checkingvcs closemodule checkingvcs
OCAMLCODE = $(addprefix doc/logic__, $(addsuffix .ml, $(OCAMLCODE_LOGIC))) \ OCAMLCODE = \
$(addprefix doc/call_provers__, $(addsuffix .ml, $(OCAMLCODE_CALLPROVERS))) \ $(addprefix doc/generated/logic__, $(addsuffix .ml, $(OCAMLCODE_LOGIC))) \
$(addprefix doc/transform__, $(addsuffix .ml, $(OCAMLCODE_TRANSFORM))) \ $(addprefix doc/generated/call_provers__, $(addsuffix .ml, $(OCAMLCODE_CALLPROVERS))) \
$(addprefix doc/mlw_tree__, $(addsuffix .ml, $(OCAMLCODE_MLWTREE))) \ $(addprefix doc/generated/transform__, $(addsuffix .ml, $(OCAMLCODE_TRANSFORM))) \
doc/whyconf__provertype.ml $(addprefix doc/generated/mlw_tree__, $(addsuffix .ml, $(OCAMLCODE_MLWTREE))) \
doc/generated/whyconf__provertype.ml
DOC = api glossary ide intro exec macros manpages install \ DOC = api glossary ide intro exec macros manpages install \
manual starting syntax syntaxref technical version whyml \ manual starting syntax syntaxref technical version whyml \
......
This diff is collapsed.
...@@ -178,7 +178,7 @@ In the following, strings are referred to with the non-terminal ...@@ -178,7 +178,7 @@ In the following, strings are referred to with the non-terminal
uppercase identifiers and, similarly, lowercase and uppercase uppercase identifiers and, similarly, lowercase and uppercase
qualified identifiers. qualified identifiers.
\begin{center}\framebox{\input{./qualid_bnf.tex}}\end{center} \begin{center}\framebox{\input{./generated/qualid_bnf.tex}}\end{center}
\paragraph{Constants.} \paragraph{Constants.}
The syntax for constants is given in Figure~\ref{fig:bnf:constant}. The syntax for constants is given in Figure~\ref{fig:bnf:constant}.
...@@ -187,7 +187,7 @@ Integer constants may be given in base 16, 10, 8 or 2. ...@@ -187,7 +187,7 @@ Integer constants may be given in base 16, 10, 8 or 2.
Real constants may be given in base 16 or 10. Real constants may be given in base 16 or 10.
\begin{figure} \begin{figure}
\begin{center}\framebox{\input{./constant_bnf.tex}}\end{center} \begin{center}\framebox{\input{./generated/constant_bnf.tex}}\end{center}
\caption{Syntax for constants.} \caption{Syntax for constants.}
\label{fig:bnf:constant} \label{fig:bnf:constant}
\end{figure} \end{figure}
...@@ -195,7 +195,7 @@ Real constants may be given in base 16 or 10. ...@@ -195,7 +195,7 @@ Real constants may be given in base 16 or 10.
\paragraph{Operators.} \paragraph{Operators.}
Prefix and infix operators are built from characters organized in four Prefix and infix operators are built from characters organized in four
categories (\textsl{op-char-1} to \textsl{op-char-4}). categories (\textsl{op-char-1} to \textsl{op-char-4}).
\begin{center}\framebox{\input{./operator_bnf.tex}}\end{center} \begin{center}\framebox{\input{./generated/operator_bnf.tex}}\end{center}
Infix operators are classified into 4 categories, according to the Infix operators are classified into 4 categories, according to the
characters they are built from: characters they are built from:
\begin{itemize} \begin{itemize}
...@@ -211,7 +211,7 @@ characters they are built from: ...@@ -211,7 +211,7 @@ characters they are built from:
\paragraph{Labels.} Identifiers, terms, formulas, program expressions \paragraph{Labels.} Identifiers, terms, formulas, program expressions
can all be labeled, either with a string, or with a location tag. can all be labeled, either with a string, or with a location tag.
\begin{center}\framebox{\input{./label_bnf.tex}}\end{center} \begin{center}\framebox{\input{./generated/label_bnf.tex}}\end{center}
A location tag consists of a file name, a line number, and starting A location tag consists of a file name, a line number, and starting
and ending characters. and ending characters.
......
...@@ -25,7 +25,7 @@ In the following, strings are referred to with the non-terminal ...@@ -25,7 +25,7 @@ In the following, strings are referred to with the non-terminal
%\subsection{Constants} %\subsection{Constants}
The syntax for numerical constants is given by the following rules: The syntax for numerical constants is given by the following rules:
%\begin{figure}[ht] %\begin{figure}[ht]
\begin{center}\input{./constant_bnf.tex}\end{center} \begin{center}\input{./generated/constant_bnf.tex}\end{center}
%\caption{Syntax for numerical constants.} %\caption{Syntax for numerical constants.}
%\label{fig:bnf:constant} %\label{fig:bnf:constant}
%\end{figure} %\end{figure}
...@@ -42,7 +42,7 @@ The syntax distinguishes identifiers that start with a lowercase letter ...@@ -42,7 +42,7 @@ The syntax distinguishes identifiers that start with a lowercase letter
or an underscore (\nonterm{lident}{}\spacefalse) and identifiers that or an underscore (\nonterm{lident}{}\spacefalse) and identifiers that
start with an uppercase letter (\nonterm{uident}{}\spacefalse): start with an uppercase letter (\nonterm{uident}{}\spacefalse):
%\begin{figure}[ht] %\begin{figure}[ht]
\begin{center}\input{./ident_bnf.tex}\end{center} \begin{center}\input{./generated/ident_bnf.tex}\end{center}
%\caption{Syntax for identifiers.} %\caption{Syntax for identifiers.}
%\label{fig:bnf:ident} %\label{fig:bnf:ident}
%\end{figure} %\end{figure}
...@@ -56,7 +56,7 @@ Prefix and infix operators are built from characters organized in four ...@@ -56,7 +56,7 @@ Prefix and infix operators are built from characters organized in four
precedence groups (\textsl{op-char-1} to \textsl{op-char-4}): precedence groups (\textsl{op-char-1} to \textsl{op-char-4}):
%as shown in Figure~\ref{fig:bnf:operator}. %as shown in Figure~\ref{fig:bnf:operator}.
%\begin{figure}[ht] %\begin{figure}[ht]
\begin{center}\input{./operator_bnf.tex}\end{center} \begin{center}\input{./generated/operator_bnf.tex}\end{center}
%\caption{Syntax for operators.} %\caption{Syntax for operators.}
%\label{fig:bnf:operator} %\label{fig:bnf:operator}
%\end{figure} %\end{figure}
...@@ -80,7 +80,7 @@ are always recognized as bang operators. ...@@ -80,7 +80,7 @@ are always recognized as bang operators.
%Qualified identifiers are prefixed with a sequence of uppercase %Qualified identifiers are prefixed with a sequence of uppercase
%identifiers, e.g., \texttt{App.S.get}: %identifiers, e.g., \texttt{App.S.get}:
%\begin{figure}[ht] %\begin{figure}[ht]
%\begin{center}\input{./qualid_bnf.tex}\end{center} %\begin{center}\input{./generated/qualid_bnf.tex}\end{center}
%\caption{Syntax for qualified identifiers.} %\caption{Syntax for qualified identifiers.}
%\label{fig:bnf:qualid} %\label{fig:bnf:qualid}
%\end{figure} %\end{figure}
...@@ -88,7 +88,7 @@ are always recognized as bang operators. ...@@ -88,7 +88,7 @@ are always recognized as bang operators.
Finally, any identifier, term, formula, or expression Finally, any identifier, term, formula, or expression
in a \whyml source can be tagged either with a string in a \whyml source can be tagged either with a string
\textit{attribute} or a location: \textit{attribute} or a location:
\begin{center}\input{./attribute_bnf.tex}\end{center} \begin{center}\input{./generated/attribute_bnf.tex}\end{center}
An attribute cannot contain newlines or closing square brackets; An attribute cannot contain newlines or closing square brackets;
leading and trailing spaces are ignored. leading and trailing spaces are ignored.
A location consists of a file name in double quotes, A location consists of a file name in double quotes,
...@@ -100,7 +100,7 @@ a line number, and starting and ending character positions. ...@@ -100,7 +100,7 @@ a line number, and starting and ending character positions.
\whyml features an ML-style type system with polymorphic types, \whyml features an ML-style type system with polymorphic types,
variants (sum types), and records that can have mutable fields. variants (sum types), and records that can have mutable fields.
The syntax for type expressions is the following: The syntax for type expressions is the following:
\begin{center}\input{./type_bnf.tex}\end{center} \begin{center}\input{./generated/type_bnf.tex}\end{center}
Built-in types are \texttt{int} (arbitrary precision integers), Built-in types are \texttt{int} (arbitrary precision integers),
\texttt{real} (real numbers), \texttt{bool}, the arrow type \texttt{real} (real numbers), \texttt{bool}, the arrow type
(also called the \textit{mapping type}, right-associative), (also called the \textit{mapping type}, right-associative),
...@@ -144,19 +144,19 @@ syntactical level, and \why will perform the necessary conversions ...@@ -144,19 +144,19 @@ syntactical level, and \why will perform the necessary conversions
behind the scenes. behind the scenes.
\begin{figure}[ht] \begin{figure}[ht]
\begin{center}\input{./term1_bnf.tex}\end{center} \begin{center}\input{./generated/term1_bnf.tex}\end{center}
\caption{\whyml terms (part I).} \caption{\whyml terms (part I).}
\label{fig:bnf:term1} \label{fig:bnf:term1}
\end{figure} \end{figure}
\begin{figure}[ht] \begin{figure}[ht]
\begin{center}\input{./term2_bnf.tex}\end{center} \begin{center}\input{./generated/term2_bnf.tex}\end{center}
\caption{\whyml terms (part II).} \caption{\whyml terms (part II).}
\label{fig:bnf:term2} \label{fig:bnf:term2}
\end{figure} \end{figure}
\begin{figure}[ht] \begin{figure}[ht]
\begin{center}\input{./term3_bnf.tex}\end{center} \begin{center}\input{./generated/term3_bnf.tex}\end{center}
\caption{\whyml terms (part III).} \caption{\whyml terms (part III).}
\label{fig:bnf:term3} \label{fig:bnf:term3}
\end{figure} \end{figure}
...@@ -281,7 +281,7 @@ Note that infix symbols of level 1 include equality (\texttt{=}) and ...@@ -281,7 +281,7 @@ Note that infix symbols of level 1 include equality (\texttt{=}) and
disequality (\texttt{<>}). disequality (\texttt{<>}).
\begin{figure} \begin{figure}
\begin{center}\framebox{\input{./formula_bnf.tex}}\end{center} \begin{center}\framebox{\input{./generated/formula_bnf.tex}}\end{center}
\caption{Syntax for formulas.} \caption{Syntax for formulas.}
\label{fig:bnf:formula} \label{fig:bnf:formula}
\end{figure} \end{figure}
...@@ -305,13 +305,13 @@ transformations interpret those connectives as introduction of logical cuts ...@@ -305,13 +305,13 @@ transformations interpret those connectives as introduction of logical cuts
The syntax for theories is given on Figure~\ref{fig:bnf:theorya} and~\ref{fig:bnf:theoryb}. The syntax for theories is given on Figure~\ref{fig:bnf:theorya} and~\ref{fig:bnf:theoryb}.
\begin{figure} \begin{figure}
\begin{center}\framebox{\input{./theory_bnf.tex}}\end{center} \begin{center}\framebox{\input{./generated/theory_bnf.tex}}\end{center}
\caption{Syntax for theories (part 1).} \caption{Syntax for theories (part 1).}
\label{fig:bnf:theorya} \label{fig:bnf:theorya}
\end{figure} \end{figure}
\begin{figure} \begin{figure}
\begin{center}\framebox{\input{./theory2_bnf.tex}}\end{center} \begin{center}\framebox{\input{./generated/theory2_bnf.tex}}\end{center}
\caption{Syntax for theories (part 2).} \caption{Syntax for theories (part 2).}
\label{fig:bnf:theoryb} \label{fig:bnf:theoryb}
\end{figure} \end{figure}
...@@ -414,7 +414,7 @@ This type is used in the standard library in the theories ...@@ -414,7 +414,7 @@ This type is used in the standard library in the theories
\subsection{Files} \subsection{Files}
A \why input file is a (possibly empty) list of theories. A \why input file is a (possibly empty) list of theories.
\begin{center}\framebox{\input{./why_file_bnf.tex}}\end{center} \begin{center}\framebox{\input{./generated/why_file_bnf.tex}}\end{center}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
...@@ -426,13 +426,13 @@ A \why input file is a (possibly empty) list of theories. ...@@ -426,13 +426,13 @@ A \why input file is a (possibly empty) list of theories.
The syntax for specification clauses in programs The syntax for specification clauses in programs
is given in Figure~\ref{fig:bnf:spec}. is given in Figure~\ref{fig:bnf:spec}.
\begin{figure} \begin{figure}
\begin{center}\framebox{\input{./spec_bnf.tex}}\end{center} \begin{center}\framebox{\input{./generated/spec_bnf.tex}}\end{center}
\caption{Specification clauses in programs.} \caption{Specification clauses in programs.}
\label{fig:bnf:spec} \label{fig:bnf:spec}
\end{figure} \end{figure}
Within specifications, terms are extended with new constructs Within specifications, terms are extended with new constructs
\verb|old| and \verb|at|: \verb|old| and \verb|at|:
\begin{center}\framebox{\input{./term_old_at_bnf.tex}}\end{center} \begin{center}\framebox{\input{./generated/term_old_at_bnf.tex}}\end{center}
Within a postcondition, $\verb|old|~t$ refers to the value of term $t$ Within a postcondition, $\verb|old|~t$ refers to the value of term $t$
in the prestate. Within the scope of a code mark $L$, in the prestate. Within the scope of a code mark $L$,
the term $\verb|at|~t~\verb|'|L$ refers to the value of term $t$ at the program the term $\verb|at|~t~\verb|'|L$ refers to the value of term $t$ at the program
...@@ -443,13 +443,13 @@ point corresponding to $L$. ...@@ -443,13 +443,13 @@ point corresponding to $L$.
The syntax for program expressions is given in The syntax for program expressions is given in
Figure~\ref{fig:bnf:expra} and~Figure~\ref{fig:bnf:exprb}. Figure~\ref{fig:bnf:expra} and~Figure~\ref{fig:bnf:exprb}.
\begin{figure} \begin{figure}
\begin{center}\framebox{\input{./expr_bnf.tex}}\end{center} \begin{center}\framebox{\input{./generated/expr_bnf.tex}}\end{center}
\caption{Syntax for program expressions (part 1).} \caption{Syntax for program expressions (part 1).}
\label{fig:bnf:expra} \label{fig:bnf:expra}
\end{figure} \end{figure}
\begin{figure} \begin{figure}
\begin{center}\framebox{\input{./expr2_bnf.tex}}\end{center} \begin{center}\framebox{\input{./generated/expr2_bnf.tex}}\end{center}
\caption{Syntax for program expressions (part 2).} \caption{Syntax for program expressions (part 2).}
\label{fig:bnf:exprb} \label{fig:bnf:exprb}
\end{figure} \end{figure}
...@@ -601,7 +601,7 @@ right, lazily. ...@@ -601,7 +601,7 @@ right, lazily.
The syntax for modules is given in Figure~\ref{fig:bnf:module}. The syntax for modules is given in Figure~\ref{fig:bnf:module}.
\begin{figure} \begin{figure}
\begin{center}\framebox{\input{./module_bnf.tex}}\end{center} \begin{center}\framebox{\input{./generated/module_bnf.tex}}\end{center}
\caption{Syntax for modules.} \caption{Syntax for modules.}
\label{fig:bnf:module} \label{fig:bnf:module}
\end{figure} \end{figure}
...@@ -613,7 +613,7 @@ variables, functions, exceptions). ...@@ -613,7 +613,7 @@ variables, functions, exceptions).
\subsection{Files} \subsection{Files}
A \whyml input file is a (possibly empty) list of theories and modules. A \whyml input file is a (possibly empty) list of theories and modules.
\begin{center}\framebox{\input{./whyml_file_bnf.tex}}\end{center} \begin{center}\framebox{\input{./generated/whyml_file_bnf.tex}}\end{center}
A theory defined in a \whyml file can only be used within that A theory defined in a \whyml file can only be used within that
file. If a theory is supposed to be reused from other files, be they file. If a theory is supposed to be reused from other files, be they
\why or \whyml files, it should be defined in a \why file. \why or \whyml files, it should be defined in a \why file.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment