diff --git a/Makefile b/Makefile index fc166f543..182b6ff8e 100644 --- a/Makefile +++ b/Makefile @@ -160,7 +160,7 @@ doc: odoc sphinx-doc sphinx-doc: # cp LICENSE.md $(SPHINX_DOC_DIR)/About/license.md # cp -r licenses $(SPHINX_DOC_DIR)/About - $(SPHINXBUILD) "$(SPHINX_DOC_DIR)" "$(SPHINX_BUILD_DIR)" + $(SPHINXBUILD) -W "$(SPHINX_DOC_DIR)" "$(SPHINX_BUILD_DIR)" # Build the odoc odoc: diff --git a/docs/sphinx_docs/Install/index.md b/docs/sphinx_docs/Install/index.md index 68d8b6259..96b5d173d 100644 --- a/docs/sphinx_docs/Install/index.md +++ b/docs/sphinx_docs/Install/index.md @@ -3,7 +3,7 @@ ## From a package manager Alt-ergo is available on [opam], the ocaml package manager with the following command : -``` +```console opam install alt-ergo ``` @@ -29,33 +29,36 @@ External dependencies graph generated with `dune-deps` (use `make archi` for sou To compile the sources of the library `alt-ergo-lib` and the binary `alt-ergo`, you will need the following libraries : ``` - ocaml >= 4.08.0 + ocaml >= 4.08.1 dune >= 3.0 dune-build-info - dolmen >= 0.9 - dolmen_loop >= 0.9 - ocplib-simplex >= 0.5 - zarith >= 1.4 + dune-site + dolmen >= 0.10 + dolmen_type >= 0.10 + dolmen_loop >= 0.10 + ocplib-simplex >= 0.5.1 + zarith >= 1.11 seq - fmt - ppx_blob + fmt >= 0.9.0 + ppx_blob >= 0.7.2 camlzip >= 1.07 menhir dune-site - cmdliner + cmdliner >= 1.1.0 psmt2-frontend >= 0.4 stdlib-shims + ppx_deriving ``` You can install dependencies using: -``` +```console $ make deps ``` and create a development switch with: -``` +```console $ make dev-switch ``` @@ -104,8 +107,8 @@ $ make js-deps For this build rule you will need the following aditional libraries : ``` -js_of_ocaml between 4.0.1 and 5.0.1 -zarith_stubs_js +js_of_ocaml >= 5.4.0 +zarith_stubs_js >= v0.16.1 ``` #### Alt-Ergo web worker @@ -114,9 +117,9 @@ zarith_stubs_js For this build rule you will need the following aditional libraries : ``` -js_of_ocaml between 4.0.1 and 5.0.1 +js_of_ocaml >= 5.4.0 js_of_ocaml-lwt -zarith_stubs_js +zarith_stubs_js >= v0.16.1 data-encoding ``` @@ -128,11 +131,11 @@ This command create a `www/` directory in which you can find a small js example For this build rule you will need the following aditional libraries : ``` -js_of_ocaml between 4.0.1 and 5.0.1 +js_of_ocaml >= 5.4.0 js_of_ocaml-lwt js_of_ocaml-ppx lwt_ppx -zarith_stubs_js +zarith_stubs_js >= v0.16.1 data-encoding ``` diff --git a/docs/sphinx_docs/Model_generation.md b/docs/sphinx_docs/Model_generation.md index a7f2c8694..a6098dd75 100644 --- a/docs/sphinx_docs/Model_generation.md +++ b/docs/sphinx_docs/Model_generation.md @@ -63,7 +63,7 @@ Model generation is known to be sometimes incomplete in the presence of arrays. - Using the native language in the input file `INPUT.ae`: - ``` + ```smt-lib logic a, b, c : int axiom A : a <> c @@ -101,7 +101,7 @@ Model generation is known to be sometimes incomplete in the presence of arrays. - Using the SMT-LIB language in the input file `INPUT.smt2`: - ``` + ```smt-lib (set-logic ALL) (declare-fun a () Int) (declare-fun b () Int) @@ -116,7 +116,7 @@ Model generation is known to be sometimes incomplete in the presence of arrays. ``` and the command `alt-ergo --produce-models INPUT.smt2` produces the output - ``` + ```smt-lib unknown ( (define-fun a () Int 0) @@ -135,7 +135,7 @@ Model generation is known to be sometimes incomplete in the presence of arrays. - Alternatively, using the statement `(set-option :produce-models true)` - ``` + ```smt-lib (set-logic ALL) (set-option :produce-models true) (declare-fun a () Int) @@ -149,7 +149,7 @@ Model generation is known to be sometimes incomplete in the presence of arrays. ``` and the command `alt-ergo INPUT.smt2` produces the output model - ``` + ```smt-lib unknown ( (define-fun a () Int 0) @@ -168,7 +168,7 @@ Model generation is known to be sometimes incomplete in the presence of arrays. done ``` we got the SMT-LIB file `INPUT.smt2`: - ``` + ```smt-lib (set-logic ALL) (declare-const i Int) (assert (and (< i 5) (not (< (+ i 1) 5)))) @@ -176,11 +176,11 @@ Model generation is known to be sometimes incomplete in the presence of arrays. (get-model) ``` Execute the command - ```sh + ```console alt-ergo --produce-models INPUT.smt2 ``` We got the output - ``` + ```smt-lib ; File "INPUT.smt2", line 4, characters 1-12: I don't know (0.6689) (2 steps) (goal g_1) unknown @@ -199,7 +199,7 @@ Model generation is known to be sometimes incomplete in the presence of arrays. end ``` and fix our SMT-LIB input accordingly: - ``` + ```smt-lib (set-logic ALL) (declare-const i Int) (assert (and (< i 5) (not (<= (+ i 1) 5)))) @@ -214,20 +214,3 @@ Model generation is known to be sometimes incomplete in the presence of arrays. (error "No model produced.") ``` Our invariant is valid! - -### Output -The results of an Alt-ergo's execution have the following form : -``` -File "/", line , characters : (