Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
why3
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
121
Issues
121
List
Boards
Labels
Service Desk
Milestones
Merge Requests
15
Merge Requests
15
Operations
Operations
Incidents
Packages & Registries
Packages & Registries
Container Registry
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Why3
why3
Commits
37268e11
Commit
37268e11
authored
Jun 20, 2014
by
Guillaume Melquiond
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Improve documentation a bit.
parent
742c8b96
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
18 additions
and
9 deletions
+18
-9
doc/exec.tex
doc/exec.tex
+2
-0
doc/manpages.tex
doc/manpages.tex
+12
-9
doc/manual.tex
doc/manual.tex
+4
-0
No files found.
doc/exec.tex
View file @
37268e11
...
...
@@ -17,6 +17,7 @@ the maximum and the sum of an array of integers.
Let us assume it is contained in a file
\texttt
{
maxsum.mlw
}
.
\section
{
Interpreting
\whyml
Code
}
\label
{
sec:execute
}
\index
{
execute@
\texttt
{
execute
}}
\index
{
interpretation!of
\whyml
}
\index
{
testing
\whyml
code
}
...
...
@@ -42,6 +43,7 @@ Execution of MaxAndSum.test ():
We get the expected output, namely the pair
\texttt
{
(45, 10)
}
.
\section
{
Compiling
\whyml
to OCaml
}
\label
{
sec:extract
}
\index
{
OCaml
}
\index
{
extraction
}
\index
{
extract@
\texttt
{
extract
}}
...
...
doc/manpages.tex
View file @
37268e11
...
...
@@ -6,7 +6,7 @@ provided by the \why environment. The main command is \texttt{why3};
it acts as an entry-point to all the features of
\why
. It is invoked
as such
\begin{verbatim}
why3 [general options...]
command
[specific options...]
why3 [general options...]
<command>
[specific options...]
\end{verbatim}
The following commands are available:
...
...
@@ -65,6 +65,7 @@ particular, option \verb|--help| displays the usage and options.
\index
{
debug@
\verb
+
--debug
+
}
\item
[\texttt{-{}-help}]
displays the usage and the exact list of options for the given tool.
\index
{
help@
\verb
+
--help
+
}
\end{description}
\section
{
The
\texttt
{
config
}
Command
}
...
...
@@ -111,9 +112,9 @@ If a supported prover is installed under a name
that is not automatically recognized by
\texttt
{
why3config
}
,
the option
\verb
|
--add-prover
|
will add a specified binary
to the configuration. For example, an Alt-Ergo executable
\verb
|
/home/me/bin/alt-ergo-trun
c
|
can be added as follows:
\verb
|
/home/me/bin/alt-ergo-trun
k
|
can be added as follows:
\begin{verbatim}
why3 config --add-prover alt-ergo /home/me/bin/alt-ergo-trun
c
why3 config --add-prover alt-ergo /home/me/bin/alt-ergo-trun
k
\end{verbatim}
As the first argument, one should put a prover
identification string. The list of known prover identifiers
...
...
@@ -551,7 +552,7 @@ file will be updated if both
\item
every goals are proved.
\end{itemize}
In other cases, you can use the IDE to update the session, or use the
option
\verb
|
-force
|
described below.
option
\verb
|
-
-
force
|
described below.
\paragraph
{
Exit code and options
}
...
...
@@ -568,6 +569,8 @@ Options are:
contains obsolete proof attempts.
\item
[\texttt{-{}-smoke-detector \{none|top|deep\}}]
tries to detect
if the context is self-contradicting.
\item
[\texttt{-{}-prover \textsl{<prover>}}]
restricts the replay to the
selected provers only.
\end{description}
\paragraph
{
Smoke detector
}
...
...
@@ -634,11 +637,11 @@ The available subcommands are as follows:
\item
[\texttt{copy}]
duplicates some of the proofs, selected by a filter.
\item
[\texttt{copy-archive}]
same as copy but also archives the
original proofs
\index
{
archived!proof attempt
}
.
\item
[\texttt{rm}]
remove some of the proofs, selected by a filter.
\item
[\texttt{rm}]
remove
s
some of the proofs, selected by a filter.
\end{description}
The first three commands do not modify the sessions, whereas the
four
last
modify them. Only the proof attempts recorded are modified. No
The first three commands do not modify the sessions, whereas the
last
four
modify them. Only the proof attempts recorded are modified. No
prover is called on the modified or created proof attempts, and
consequently the proof status is always marked as obsolete.
...
...
@@ -1046,14 +1049,14 @@ since regenerating the HTML documentation will not overwrite an existing
\label
{
sec:why3execute
}
\why
can symbolically execute programs written using the
\whyml
language
(extension
\texttt
{
.mlw
}
).
(extension
\texttt
{
.mlw
}
).
See also Section~
\ref
{
sec:execute
}
.
\index
{
execute@
\texttt
{
execute
}}
\section
{
The
\texttt
{
extract
}
Command
}
\label
{
sec:why3extract
}
\why
can extract programs written using the
\whyml
language
(extension
\texttt
{
.mlw
}
) to OCaml.
(extension
\texttt
{
.mlw
}
) to OCaml.
See also Section~
\ref
{
sec:extract
}
.
\index
{
extract@
\texttt
{
extract
}}
\section
{
The
\texttt
{
realize
}
Command
}
...
...
doc/manual.tex
View file @
37268e11
...
...
@@ -21,6 +21,10 @@
%\usepackage{url}
\usepackage
[pdftex,colorlinks=true,urlcolor=blue,pdfstartview=FitH]
{
hyperref
}
%BEGIN LATEX
\usepackage
{
upquote
}
%END LATEX
%BEGIN LATEX
\usepackage
{
graphicx
}
%END LATEX
...
...
Write
Preview
Markdown
is supported
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