ROADMAP 57.5 KB
Newer Older
MARCHE Claude's avatar
MARCHE Claude committed
1

MARCHE Claude's avatar
MARCHE Claude committed
2

MARCHE Claude's avatar
MARCHE Claude committed
3
============ Long-term Roadmap (see below for roadmaps to next release) ===========
MARCHE Claude's avatar
MARCHE Claude committed
4

MARCHE Claude's avatar
MARCHE Claude committed
5

MARCHE Claude's avatar
MARCHE Claude committed
6
== long-term projects ==
MARCHE Claude's avatar
MARCHE Claude committed
7

MARCHE Claude's avatar
MARCHE Claude committed
8 9
* entiers machines

MARCHE Claude's avatar
MARCHE Claude committed
10
* modules, raffinement (these de Leon)
MARCHE Claude's avatar
MARCHE Claude committed
11

MARCHE Claude's avatar
MARCHE Claude committed
12 13 14 15
* support for higher-order

* extraction, more generally how to turn Why3 into a real programming language (these de Martin)

MARCHE Claude's avatar
MARCHE Claude committed
16 17 18 19 20
* rapprocher la logique et les programmes
** variant dans la logique ?
** monter les fonctions de programmes pures dans la logique ?


MARCHE Claude's avatar
MARCHE Claude committed
21 22 23 24 25 26 27 28 29 30
* internal interpreter, test of specifications, quickcheck

* BWare project, support for rewrite rules, improved support for provers,
  extensions of set theory and their Coq realizations.

* LABCOM avec Adacore
** calculs non-linéaires, calculs en virgule flottante
** production de contre-exemples de preuves solides et exprimés dans le langage d’origine
** support efficace des invariants de données
** développer des composants réutilisables prouvés.
MARCHE Claude's avatar
MARCHE Claude committed
31

MARCHE Claude's avatar
MARCHE Claude committed
32 33
* jessie3

MARCHE Claude's avatar
MARCHE Claude committed
34
== Papers to write ==
Jean-Christophe Filliatre's avatar
Jean-Christophe Filliatre committed
35

36
  * paper on the module system, its semantics, realizations, avec en
MARCHE Claude's avatar
MARCHE Claude committed
37
    particulier la solution avec les types classes
38

MARCHE Claude's avatar
MARCHE Claude committed
39
  * DONE paper on the proof management system
MARCHE Claude's avatar
MARCHE Claude committed
40

41
  * DONE Encodings and transformations (Andrei+Francois FroCos 11)
MARCHE Claude's avatar
MARCHE Claude committed
42

43
  * DONE Why presentation at the IVL workshop of CADE:
44 45
    (http://research.microsoft.com/en-us/um/people/moskal/boogie2011/)
    deadline: May 1st
MARCHE Claude's avatar
MARCHE Claude committed
46

Jean-Christophe Filliatre's avatar
Jean-Christophe Filliatre committed
47
  * Caml code ?
MARCHE Claude's avatar
MARCHE Claude committed
48

Jean-Christophe Filliatre's avatar
Jean-Christophe Filliatre committed
49
  * logic language for talking to provers
50 51 52
    - DONE (Boogie 11)
    - DONE FOL + poly (FroCos 11)
    -  alg + ind + rec ? + theories
MARCHE Claude's avatar
MARCHE Claude committed
53

Jean-Christophe Filliatre's avatar
Jean-Christophe Filliatre committed
54
  * VACID-0
MARCHE Claude's avatar
MARCHE Claude committed
55 56 57

  * system description (e.g. at CADE, TACAS) DONE at ESOP

Jean-Christophe Filliatre's avatar
Jean-Christophe Filliatre committed
58
  * rapports recherche ?
MARCHE Claude's avatar
MARCHE Claude committed
59

MARCHE Claude's avatar
MARCHE Claude committed
60
== stages ==
MARCHE Claude's avatar
MARCHE Claude committed
61

MARCHE Claude's avatar
MARCHE Claude committed
62
* M1. preuve d'un petit compilateur, pas de pb de lieur,
MARCHE Claude's avatar
MARCHE Claude committed
63 64
   eventuellement outils pour les preuves par recurrence
   a la Leino, + fct size automatique
MARCHE Claude's avatar
MARCHE Claude committed
65
  DONE (Stage M1 de Leon)
MARCHE Claude's avatar
MARCHE Claude committed
66

MARCHE Claude's avatar
MARCHE Claude committed
67
* M2. Lieur en Why3, POPLmark challenge. vers
MARCHE Claude's avatar
MARCHE Claude committed
68
   un theorie et/ou un module réutilisable de lieurs
MARCHE Claude's avatar
MARCHE Claude committed
69 70
  DONE (Stage M2 de Martin)

MARCHE Claude's avatar
MARCHE Claude committed
71
* (M2?) Stage Airbus, "TIP" avec Frama-C/Jessie ou WP/Why/Coq
MARCHE Claude's avatar
MARCHE Claude committed
72
   besoin de la tactique Coq?
73

MARCHE Claude's avatar
MARCHE Claude committed
74
== new major features ==
MARCHE Claude's avatar
MARCHE Claude committed
75

MARCHE Claude's avatar
MARCHE Claude committed
76 77 78 79 80 81 82 83 84
* Logic language
 - support for higher-order logic
 - rename andb, orb, xorb and notb into and, or, xor and not

* more libraries (theories and modules)

* A true Jessie3 front-end

* Why3ML
MARCHE Claude's avatar
MARCHE Claude committed
85
 - Fast WP a la Leino (DONE ?)
MARCHE Claude's avatar
MARCHE Claude committed
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
 - assert qui ne donne pas une hypothese dans la suite -> "check"
   also: in a black box

* Add more examples in the regression tests and in the proval gallery

* A literate programming tool for Why3 (JCF)


* IDE:
 - edition, navigation (partially done)
 - saving session: add shortcut "ctrl-S", but beware of confusion with saving the input file
 - reimplement "hide proved goals" feature
  + suggested solution: replace model + filter_model by a custom model
  (JC + ?)
 - restore provers detection in the middle of a session.
 - commentaires dans les sessions, attachés a chaque ligne


104 105 106 107 108 109
* Projets interessant Cesar ?
** Preuve de prog flottants avec Frama-C+WP+Why3+PVS
** Generation d'annotations
** porter multirounding a jessie->Why3. Completer le mode full et faire passer
   interval_arith.c. Completer la galerie
** preuve sur l'assembleur
MARCHE Claude's avatar
MARCHE Claude committed
110 111
** support de Yices 2 ? interesserait Cesar

112

MARCHE Claude's avatar
MARCHE Claude committed
113
==================== Roadmap for next releases ========================
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140

HighOrd: Coq output and OCaml extraction should produce lambda's from lambda's
and no epsilon

* terminaison
** generer une obligation de preuve de well-foundedness quand on utilise
   un variant avec "with R" (une seule fois pour chaque R !)
** quand une definition logique recursive ne peut pas etre verifiee
   bien-fondee statiquement, generer une obligation de preuve
   (feature wish de F Besson)

* Coq tactic
** ajout de bases de hint

* replayer
** deplacer option -bench dans une commande de why3session

* IDE
** todo: run detection immediately at start up if conf file absent or
    outdated. should become doable with the new Session module
** "detect provers" menu

* Contre-exemples de Alt-Ergo

* detect editors
*** check if coqide and also emacs/proof-general is installed

MARCHE Claude's avatar
MARCHE Claude committed
141
* documentation des nouvelles features higher-order
142

MARCHE Claude's avatar
MARCHE Claude committed
143 144 145 146 147 148
* eliminate_match:
** faire un cas particulier pour "bool", le match pouvant se traduire
   vers ite qui est supporté par pas mal de prouveurs
** introduire des symboles _match non polymorphes differents pour
   chaque instance necessaires. plutot qu'un seul symbole _match
   polymorphe.
149

150
==================== Roadmap for release 0.88 ========================
151

152 153
DATE : au plus tard en novembre 2016, pour que ce soit dispo pour les
etudiants MPRI (pour la feature strategies en particulier)
154

155
* integrate server feature done by Johannes
156

MARCHE Claude's avatar
MARCHE Claude committed
157 158 159 160
* Document src/core/trans.mli, and fill the paragraph on
  transformations in the tutorial: doc/api.tex, section 4.7 "Applying
  transformations"

161
* fix bug 18953 : (<>) not allowed as prefix form
162

163 164 165
  solution possible: symbol builtin t_neq, inlining systematique au typage
  (ou laisser inline_trivial le faire)

166 167
* make counter-examples feature more robust

168 169 170 171
* use the file generated by altgr-ergo to replay proofs edited by altgr-ergo

  alt-ergo -replay <file>.agr

172 173
  -> on pourrait le faire en considerant altgr-ergo comme un prouveur interactif

174
* DONE make the strategy feature public and documented. Possibly generate
MARCHE Claude's avatar
MARCHE Claude committed
175
  default strategies dynamically at the time of why3 config --detect,
176 177 178 179 180 181
  using the provers detected : for that, we can annotated the provers in
  prover-detection-data.conf to tell if they should be used in the strategies,
  with which priority

  2 possible default strategies

182
  . favor use of many prover before splitting or increasing timeout
183 184 185

  . or, on the contrary, favor splitting

MARCHE Claude's avatar
MARCHE Claude committed
186
  . or, favor timelimit increase...
187

188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
* take some time to fix some bugs of the BTS: 18029 at least


==================== Roadmap for release 0.87 ========================

DATE : mars 2016

Release Notes (details in file CHANGES):

== TODO ==

* DONE finalize detect_polymorphism. Allow polymorphic tuples (supported by SMT ?)

  C'est finalisé. Mais les tuples restent polymorphes.

* DONE Coq realization of bitvector theory

* DONE support for both isabelle 2014 and 2015
  + bugfix for installation

* DONE review support for division operators by SMT provers
209 210 211 212




MARCHE Claude's avatar
MARCHE Claude committed
213 214
==================== Roadmap for release 0.86 ========================

MARCHE Claude's avatar
MARCHE Claude committed
215
DATE : fin avril / début mai
MARCHE Claude's avatar
MARCHE Claude committed
216 217 218 219

Release Notes (details in file CHANGES):

* Support for new provers or new versions of provers
MARCHE Claude's avatar
MARCHE Claude committed
220 221
* Stdlib: new theories for sequences and bitvectors
* bug fixes
MARCHE Claude's avatar
MARCHE Claude committed
222 223 224

== TODO ==

MARCHE Claude's avatar
MARCHE Claude committed
225 226 227 228
* decide if GUI with tabs is convenient enough
-> onglets dans why3 ide : est-ce apprécié ? OUI
    mais enlever l'onglet "Counterexamples" avant la release

MARCHE Claude's avatar
MARCHE Claude committed
229 230
* for next release: complete realization of bitvector library

MARCHE Claude's avatar
MARCHE Claude committed
231 232
== DONE ==

MARCHE Claude's avatar
MARCHE Claude committed
233 234 235 236 237
* clean up the support for SMTLIB bitvectors: there are 2 theories in the stdlib: thoeries/bv.why and modules/bitvectors.mlw
-> not anymore, but more cleaning can be done: no need to separate all theories in drivers for Z3 and CVC4, since the same theory can be put several times in a driver (or imported sub-drivers)

* DONE plusieurs drivers acceptés sur la ligne de commande (AP)

238 239 240 241
* solve issues with metitarski
. DONE theory PowerReal
. DONE crashes when applied on a WP (see examples/my_cosine.mlw)

242 243 244 245 246 247 248 249 250 251 252 253 254
* determine which is the minumum version of Ocaml to compile, and then
updated configure.in and the manual
-> vérification compilation avec OCaml 3.12 -> Claude va le faire

  . 3.11.2: opam install menhir plante car ocamlfind ne compile pas
  . 3.12.1: Why3 ne compile pas:
    File "src/core/ident.ml", line 208, characters 2-14:
    Error: Unbound value String.iteri
  . 4.00.0: pas teste, et sans doute pas recommande
  . 4.00.1: ca fonctionne

-> ocaml minimal = 4.00.1

MARCHE Claude's avatar
MARCHE Claude committed
255
DONE * sauvegarde de la configuration : à quel endroit dans l'IDE ?
MARCHE Claude's avatar
MARCHE Claude committed
256 257
-> Claude le met dans la fenetre preferences a cote du bouton "Close"

MARCHE Claude's avatar
MARCHE Claude committed
258 259 260 261 262
* support for veriT recent
-> DONE: version 201410

* support for Yices2 recent
-> DONE: 2.3.0, but still does not support quantifiers
MARCHE Claude's avatar
MARCHE Claude committed
263 264 265 266


== Final preparation ==

Guillaume Melquiond's avatar
Guillaume Melquiond committed
267
* check the BTS
MARCHE Claude's avatar
MARCHE Claude committed
268 269 270 271
* do "make update-coq" and "make", fix Coq realizations if needed
* check that nightly bench is OK
* check that "make xml-validate-local" is OK
  (see below : copy the dtd on the web)
Guillaume Melquiond's avatar
Guillaume Melquiond committed
272

MARCHE Claude's avatar
MARCHE Claude committed
273 274 275 276 277 278
* put 0.86 in file Version, and then run ./config.status
* check/update the content of the About dialog in src/ide/gconfig.ml
  around lines 550-600
* check headers
* check the file CHANGES, add the release date

Guillaume Melquiond's avatar
Guillaume Melquiond committed
279 280 281 282 283 284 285
* generate documentation
 - update the date in doc/manual.tex (near \whyversion{})
 - check that macro \todo is commented out in doc/macros.tex
 - do "make doc"
   (check that manual in HTML is also generated, doc/html/index.html)
 - do "make stdlibdoc"
 - do "make apidoc"
MARCHE Claude's avatar
MARCHE Claude committed
286

Guillaume Melquiond's avatar
Guillaume Melquiond committed
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
* make a last commit:
 - git commit -am "release 0.86"
 - git tag 0.86
* do "make dist"
* test distrib/why3-0.86.tar.gz
* push the commit:
 - git push
 - git push --tags
* upload distrib/why3-0.86.tar.gz to https://gforge.inria.fr/frs/?group_id=2990

* upload the documentation on the web page
 - cp doc/manual.pdf /users/www-perso/projets/why3/download/manual-0.86.pdf
 - cp -r doc/html /users/www-perso/projets/why3/doc-0.86
 - cp share/why3session.dtd /users/www-perso/projets/why3/
 - cp -r doc/stdlibdoc /users/www-perso/projets/why3/stdlib-0.86
302
   ln -s -n -f stdlib-0.86 /users/www-perso/projets/why3/stdlib
Guillaume Melquiond's avatar
Guillaume Melquiond committed
303
 - cp -r doc/apidoc /users/www-perso/projets/why3/api-0.86
304
   ln -s -n -f api-0.86 /users/www-perso/projets/why3/api
MARCHE Claude's avatar
MARCHE Claude committed
305

Guillaume Melquiond's avatar
Guillaume Melquiond committed
306 307 308 309 310
* update the main HTML page (sources are in repository why3-www)
 - edit index.html, change at least all occurrences of 0.85 by 0.86, and
   update the url for download
 - make (to check validity)
 - make export
MARCHE Claude's avatar
MARCHE Claude committed
311 312 313 314

* add a new version to the bugtracker:
  https://gforge.inria.fr/tracker/admin/?group_id=2990&atid=10293&add_extrafield=1

MARCHE Claude's avatar
MARCHE Claude committed
315
* The next commit : add +git to the version in file Version
MARCHE Claude's avatar
MARCHE Claude committed
316

MARCHE Claude's avatar
MARCHE Claude committed
317
* prepare the OPAM package
Guillaume Melquiond's avatar
Guillaume Melquiond committed
318
 - update opam/why3-base/url: url and checksum of why-0.86.tar.gz
MARCHE Claude's avatar
MARCHE Claude committed
319
   (use "md5sum distrib/why3-0.86.tar.gz")
Guillaume Melquiond's avatar
Guillaume Melquiond committed
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
 - update opam/why3-base/descr and opam/why3/descr if necessary
 - update opam/why3-base/opam with correct dependencies
 - update opam/why3/opam with the dependency on why3-base
 - test with "opam pin add why3 --kind=git .../why3/.git"
   (it runs "opam install why3")

* upload the OPAM package
 - clone https://github.com/ocaml/opam-repository
   git clone git@github.com:.../opam-repository.git
   cd opam-repository/
   git remote add opam https://github.com/ocaml/opam-repository.git
 - reinitialize the repository if not fresh:
   git fetch opam
   git reset --hard opam/master
   git push
 - cd packages/why3-base; cp -r .../opam/why3-base why3-base.0.86
 - cd packages/why3; cp -r .../opam/why3 why3.0.86
 - commit and push
 - make a pull request on github
MARCHE Claude's avatar
MARCHE Claude committed
339

MARCHE Claude's avatar
MARCHE Claude committed
340 341 342
* inform Jerry James <loganjerry@gmail.com> so that he can produce the
  Fedora package

MARCHE Claude's avatar
MARCHE Claude committed
343
* produce the Why3 part of Toccata gallery
344 345 346 347 348 349 350 351 352 353 354 355 356 357
  - have GALLERYDIR set to the sub-directory gallery/ of the git sources
    of the Toccata web site, e.g.
    export GALLERYDIR=/users/vals/filliatr/toccata/web/gallery
  - in Why3 sources, do "make gallery"; it exports to GALLERYDIR all
    Why3 programs for which there is a session
  - now move to the Toccata web site sources, and
    - update web/gallery/examples.rc to include new examples
    - "git add" the files for these new examples (those currently untracked
      in git) or simply remove them if they should not go on-line
    - do "make" in web/gallery/
    - do "make install-gallery" in web/

* Once the OPAM package is pulled in the main OPAM repository:
  announce the distrib
MARCHE Claude's avatar
MARCHE Claude committed
358
  What to put in the announcement: see New Features above
MARCHE Claude's avatar
MARCHE Claude committed
359

MARCHE Claude's avatar
MARCHE Claude committed
360 361


MARCHE Claude's avatar
MARCHE Claude committed
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
==================== Roadmap for release 0.85 ========================

Release Notes:

Mainly a bug-fix release, in particular to fix two soundness bugs

See CHANGES

== Final preparation ==

* faire une passe sur le BTS
* do "make update-coq" and "make", fix Coq realizations if needed
* check that nightly bench is OK
* check that "make xml-validate-local" is OK
  (see below : copy the dtd on the web)
* put 0.85 in file Version, and then run ./config.status
* check/update the content of the About dialog in src/ide/gconfig.ml
  around lines 550-600
* check headers
* check the file CHANGES, add the release date
* manual in PDF:
** update the date in doc/manual.tex (near \whyversion{})
** check that macro \todo is commented out in doc/macros.tex
** and then "make doc"
  (check that manual in HTML is also generated, doc/html/index.html)
* do "make dist"
* test distrib/why3-0.85.tar.gz
* put on the web page why3-0.85.tar.gz:
  cp distrib/why3-0.85.tar.gz /users/www-perso/projets/why3/download
* inform Jerry James <loganjerry@gmail.com> so that he can test the
  Fedora package
* install web page for why2 which includes an updated page for the
  quick migration guide. (sources are in CVS repository
  ~filliatr/ARCHIVE/www/why).
* move distrib from Why3 site to Inria forge:
** remove /users/www-perso/projets/why3/download/why3-0.85.tar.gz
** upload distrib/why3-0.85.tar.gz to https://gforge.inria.fr/frs/?group_id=2990
* put on the web page
 - the manual in PDF
   cp doc/manual.pdf /users/www-perso/projets/why3/download/manual-0.85.pdf

 - the HTML version of the manual (content of doc/html)
   cp -r doc/html /users/www-perso/projets/why3/doc-0.85

 - why3session.dtd
   cp -f share/why3session.dtd /users/www-perso/projets/why3/

 - standard library online, using why3doc, to http://why3.lri.fr/stdlib/
   make stdlibdoc
   cp -r doc/stdlibdoc /users/www-perso/projets/why3/stdlib-0.85
   rm /users/www-perso/projets/why3/stdlib
   ln -s /users/www-perso/projets/why3/stdlib-0.85 \
            /users/www-perso/projets/why3/stdlib
 - API doc, produced using ocamldoc, to http://why3.lri.fr/api/
    make apidoc
    cp -r doc/apidoc /users/www-perso/projets/why3/api-0.85
    rm /users/www-perso/projets/why3/api
    ln -s /users/www-perso/projets/why3/api-0.85 \
      /users/www-perso/projets/why3/api

 - update the main HTML page (sources are in repository why3-www)
   edit index.html
   make (to check validity)
   make export

 - add links to extra resources like
   http://why3.lri.fr/jfla-2012/, http://www.lri.fr/~marche/MPRI-2-36-1/,
   page du cours de l'X (in french ? using Krakatoa/why3 bridge)

 - make everything writeable for the group
   chmod -R g+w /users/www-perso/projets/why3

* prepare for the OPAM package

. update opam/url: url and checksum of why-0.85.tar.gz
   (use "md5sum distrib/why3-0.85.tar.gz")
. update opam/descr if necessary
. update opam/opam with correct dependencies and such

* make a last commit:
 - git commit -am "release 0.85"
 - add tag 0.85 to the git repository, using
   git tag 0.85
 - do not forget to push it using
   git push
   git push --tags

* add a new version to the bugtracker:
  https://gforge.inria.fr/tracker/admin/?group_id=2990&atid=10293&add_extrafield=1


* test the OPAM package

  . with opam 1.2:
    opam pin add why3 --kind=git <...>/why3/.git
    (it runs "opam install why3")
  . with opam < 1.2:

    - first step: have a local copy of opam-repository if not done yet, e.g.:

        git clone git@github.com:claudemarche/opam-repository.git
        cd opam-repository/
        git remote add opam https://github.com/ocaml/opam-repository.git

      or, if you already have one, make sure it is up-to-date:

468 469 470
        git fetch opam
        git reset --hard opam/master
        git push
MARCHE Claude's avatar
MARCHE Claude committed
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490

    - second step: copy why3 opam files into it :

      cd packages/why3
      cp -r <source why3>/opam why3.0.85

    - second step:

      opam repository add local <...>/opam-repository
      opam install why3
      (* test it, e.g.
         cp example/quicksort.mlw ~/tmp
         why3 ide ~/tmp/quicksort.mlw *)
      opam remove why3
      opam repository remove local


* make a pull request on OPAM

  git add why3.0.85
491 492
  git commit -am "new package version why3 0.85"
  git push
MARCHE Claude's avatar
MARCHE Claude committed
493 494 495 496 497 498 499 500 501 502
  sur github: creer un pull request

* produce the Why3 part of Toccata gallery
  -> add also a tar.gz and a ZIP file of it (this is done by doing
  "make gallery-files" in the sources of the Toccata web pages)
* Announce the distrib
 - What to put in the announcement: see New Features above
* The next commit : add +git to the version in file Version


Guillaume Melquiond's avatar
Guillaume Melquiond committed
503
==================== Roadmap for release 0.84 ========================
MARCHE Claude's avatar
MARCHE Claude committed
504

MARCHE Claude's avatar
MARCHE Claude committed
505 506 507 508 509 510
== TODOs ==

* verifier support des nouveaux prouveurs: Coq8.4pl4, Isabelle-2014,
  CVC4 1.4, yices2 (quantifiers ?)  beagle ? driver TPTP TFA ? autres ?

* completer le fichier CHANGES
MARCHE Claude's avatar
MARCHE Claude committed
511 512 513 514 515 516
** nouvelle facon d'appeler les outils "why3 xxx ..." DONE
** strategies de preuve, NO for next release only
** transformation "compute_in_goal", DONE, but rewrite rules not documented
** support de nouveaux prouveurs, DONE
** nouvelle structure des fichiers de session et de shape (compatibilité), DONE
** new examples ? BOF
MARCHE Claude's avatar
MARCHE Claude committed
517 518

* ajouter dans les instructions de release ci-dessous la procedure de
MARCHE Claude's avatar
MARCHE Claude committed
519
  fabrication du paquet opam DONE
MARCHE Claude's avatar
MARCHE Claude committed
520

521 522
== New Features to announce ==

MARCHE Claude's avatar
MARCHE Claude committed
523 524 525 526 527 528 529 530 531 532 533
Release Notes:

A major visible change in this release is the way Why3 commands are
invoked: instead of several executables why3, why3config, why3ide,
why3replay, why3session, etc., there is only one Why3 executable
called why3, and the former executables are available as commands given
as first argument, e.g. "why3 config", "why3 ide", etc.

Another quite visible change is that session files are split in two
parts, as detailed below in the detailed changes.

MARCHE Claude's avatar
MARCHE Claude committed
534
See CHANGES
535

MARCHE Claude's avatar
MARCHE Claude committed
536 537 538 539 540 541 542
== Final preparation ==

* faire une passe sur le BTS
* do "make update-coq" and "make", fix Coq realizations if needed
* check that nightly bench is OK
* check that "make xml-validate-local" is OK
  (see below : copy the dtd on the web)
MARCHE Claude's avatar
MARCHE Claude committed
543
* put 0.84 in file Version, and then run ./config.status
MARCHE Claude's avatar
MARCHE Claude committed
544 545 546 547
* check/update the content of the About dialog in src/ide/gconfig.ml
  around lines 550-600
* check headers
* check the file CHANGES, add the release date
MARCHE Claude's avatar
MARCHE Claude committed
548 549 550 551
* manual in PDF:
** update the date in doc/manual.tex (near \whyversion{})
** check that macro \todo is commented out in doc/macros.tex
** and then "make doc"
MARCHE Claude's avatar
MARCHE Claude committed
552 553 554
  (check that manual in HTML is also generated, doc/html/index.html)
* do "make dist"
* test distrib/why3-0.84.tar.gz
MARCHE Claude's avatar
MARCHE Claude committed
555 556
* put on the web page why3-0.84.tar.gz:
  cp distrib/why3-0.84.tar.gz /users/www-perso/projets/why3/download
MARCHE Claude's avatar
MARCHE Claude committed
557 558
* inform Jerry James <loganjerry@gmail.com> so that he can test the
  Fedora package
MARCHE Claude's avatar
MARCHE Claude committed
559 560
* install web page for why2 which includes an updated page for the
  quick migration guide. (sources are in CVS repository
Guillaume Melquiond's avatar
Guillaume Melquiond committed
561
  ~filliatr/ARCHIVE/www/why).
MARCHE Claude's avatar
MARCHE Claude committed
562 563 564
* move distrib from Why3 site to Inria forge:
** remove /users/www-perso/projets/why3/download/why3-0.84.tar.gz
** upload distrib/why3-0.84.tar.gz to https://gforge.inria.fr/frs/?group_id=2990
MARCHE Claude's avatar
MARCHE Claude committed
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
* put on the web page
 - the manual in PDF
   cp doc/manual.pdf /users/www-perso/projets/why3/download/manual-0.84.pdf

 - the HTML version of the manual (content of doc/html)
   cp -r doc/html /users/www-perso/projets/why3/doc-0.84

 - why3session.dtd
   cp share/why3session.dtd /users/www-perso/projets/why3/

 - standard library online, using why3doc, to http://why3.lri.fr/stdlib/
   make stdlibdoc
   cp -r doc/stdlibdoc /users/www-perso/projets/why3/stdlib-0.84
   rm /users/www-perso/projets/why3/stdlib
   ln -s /users/www-perso/projets/why3/stdlib-0.84 \
            /users/www-perso/projets/why3/stdlib
 - API doc, produced using ocamldoc, to http://why3.lri.fr/api/
    make apidoc
    cp -r doc/apidoc /users/www-perso/projets/why3/api-0.84
    rm /users/www-perso/projets/why3/api
    ln -s /users/www-perso/projets/why3/api-0.84 \
      /users/www-perso/projets/why3/api
   (PROBLEME avec style.css ? Ou est le probleme ?)

 - update the main HTML page (sources are in repository why3-www)
   edit index.html
MARCHE Claude's avatar
MARCHE Claude committed
591
   make (to check validity)
MARCHE Claude's avatar
MARCHE Claude committed
592
   make export
593

MARCHE Claude's avatar
MARCHE Claude committed
594 595 596
 - add links to extra resources like
   http://why3.lri.fr/jfla-2012/, http://www.lri.fr/~marche/MPRI-2-36-1/,
   page du cours de l'X (in french ? using Krakatoa/why3 bridge)
597

MARCHE Claude's avatar
MARCHE Claude committed
598 599
 - make everything writeable for the group
   chmod -R g+w /users/www-perso/projets/why3
MARCHE Claude's avatar
MARCHE Claude committed
600

601 602
* prepare for the OPAM package

MARCHE Claude's avatar
MARCHE Claude committed
603
. update opam/url: url and checksum of why-0.84.tar.gz
604 605 606 607
   (use "md5sum distrib/why3-0.84.tar.gz")
. update opam/descr if necessary
. update opam/opam with correct dependencies and such

MARCHE Claude's avatar
MARCHE Claude committed
608
* make a last commit:
MARCHE Claude's avatar
MARCHE Claude committed
609
 - git commit -am "release 0.84"
MARCHE Claude's avatar
MARCHE Claude committed
610 611 612 613 614
 - add tag 0.84 to the git repository, using
   git tag 0.84
 - do not forget to push it using
   git push
   git push --tags
MARCHE Claude's avatar
MARCHE Claude committed
615

MARCHE Claude's avatar
MARCHE Claude committed
616 617 618
* add a new version to the bugtracker:
  https://gforge.inria.fr/tracker/admin/?group_id=2990&atid=10293&add_extrafield=1

619 620 621 622 623 624 625

* test the OPAM package

  . with opam 1.2:
    opam pin add why3 --kind=git <...>/why3/.git
    (it runs "opam install why3")
  . with opam < 1.2:
MARCHE Claude's avatar
MARCHE Claude committed
626

627 628
    - first step: have a local copy of opam-repository if not done yet, e.g.:

MARCHE Claude's avatar
MARCHE Claude committed
629 630 631
        git clone git@github.com:claudemarche/opam-repository.git
        cd opam-repository/
        git remote add opam https://github.com/ocaml/opam-repository.git
632 633 634

      or, if you already have one, make sure it is up-to-date:

MARCHE Claude's avatar
MARCHE Claude committed
635 636 637 638 639 640
        git pull --ff-only opam master

    - second step: copy why3 opam files into it :

      cd packages/why3
      cp -r <source why3>/opam why3.0.84
641 642

    - second step:
MARCHE Claude's avatar
MARCHE Claude committed
643

MARCHE Claude's avatar
MARCHE Claude committed
644
      opam repository add local <...>/opam-repository
645
      opam install why3
MARCHE Claude's avatar
MARCHE Claude committed
646
      (* test it, e.g.
647
         cp example/quicksort.mlw ~/tmp
MARCHE Claude's avatar
MARCHE Claude committed
648
         why3 ide ~/tmp/quicksort.mlw *)
649 650 651 652 653 654 655 656 657 658
      opam remove why3
      opam repository remove local


* make a pull request on OPAM

  git add why3.0.84
  commit et push
  sur github: creer un pull request

MARCHE Claude's avatar
MARCHE Claude committed
659 660 661 662 663 664
* produce the Why3 part of Toccata gallery
  -> add also a tar.gz and a ZIP file of it (this is done by doing
  "make gallery-files" in the sources of the Toccata web pages)
* Announce the distrib
 - What to put in the announcement: see New Features above
* The next commit : add +git to the version in file Version
MARCHE Claude's avatar
MARCHE Claude committed
665 666


MARCHE Claude's avatar
MARCHE Claude committed
667 668 669 670 671 672

==================== Roadmap for release 0.83 ========================

== New Features to announce ==

See CHANGES
673 674 675

== Final preparation ==

676 677
* inform Jerry James <loganjerry@gmail.com> so that he can test the
  Fedora package
678 679 680 681 682
* faire une passe sur le BTS
* do "make update-coq" and "make", fix Coq realizations if needed
* check that nightly bench is OK
* check that "make xml-validate-local" is OK
  (see below : copy the dtd on the web)
683
* put 0.83 in file Version
684 685
* check/update the content of the About dialog in src/ide/gconfig.ml
  around lines 550-600
686 687 688 689 690 691
* check headers
* check the file CHANGES, add the release date
* manual in PDF: check that macro \todo is commented out
    in ./macros.tex, and then "make doc"
  (check that manual in HTML is also generated, doc/html/index.html)
* do "make dist"
692
* test distrib/why3-0.83.tar.gz
693 694
* install web page for why2 which includes an updated page for the
  quick migration guide. (sources are in CVS repository
695
  ~filliatr/ARCHIVE/www/why). ADD a colon on new syntax for 0.83. Change Proval into Toccata
696
* put on the web page
697 698
 - why3-0.83.tar.gz
   cp distrib/why3-0.83.tar.gz /users/www-perso/projets/why3/download
699 700

 - the manual in PDF
701
   cp doc/manual.pdf /users/www-perso/projets/why3/download/manual-0.83.pdf
702 703

 - the HTML version of the manual (content of doc/html)
704
   cp -r doc/html /users/www-perso/projets/why3/doc-0.83
705 706 707 708 709 710

 - why3session.dtd
   cp share/why3session.dtd /users/www-perso/projets/why3/

 - standard library online, using why3doc, to http://why3.lri.fr/stdlib/
   make stdlibdoc
711
   cp -r doc/stdlibdoc /users/www-perso/projets/why3/stdlib-0.83
712
   rm /users/www-perso/projets/why3/stdlib
713
   ln -s /users/www-perso/projets/why3/stdlib-0.83 \
714 715 716
            /users/www-perso/projets/why3/stdlib
 - API doc, produced using ocamldoc, to http://why3.lri.fr/api/
    make apidoc
717
    cp -r doc/apidoc /users/www-perso/projets/why3/api-0.83
718
    rm /users/www-perso/projets/why3/api
719
    ln -s /users/www-perso/projets/why3/api-0.83 \
720 721
      /users/www-perso/projets/why3/api
   (PROBLEME avec style.css ? Ou est le probleme ?)
722

723 724 725 726 727 728 729 730 731 732 733 734
 - update the main HTML page (sources are in repository why3-www)
   edit index.html
   make export

 - add links to extra resources like
   http://why3.lri.fr/jfla-2012/, http://www.lri.fr/~marche/MPRI-2-36-1/,
   page du cours de l'X (in french ? using Krakatoa/why3 bridge)

 - make everything writeable for the group
   chmod -R g+w /users/www-perso/projets/why3

* make a last commit:
735 736 737
 - git commit -m "release 0.83"
 - add tag 0.83 to the git repository, using
   git tag 0.83
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
 - do not forget to push it using
   git push
   git push --tags

* add a new version to the bugtracker:
  https://gforge.inria.fr/tracker/admin/?group_id=2990&atid=10293&add_extrafield=1

* produce the Why3 part of Toccata gallery
  -> add also a tar.gz and a ZIP file of it (this is done by doing
  "make gallery-files" in the sources of the Toccata web pages)
* Announce the distrib
 - What to put in the announcement: see New Features above
* The next commit : add +git to the version in file Version


MARCHE Claude's avatar
MARCHE Claude committed
753 754
== TODOs ==

MARCHE Claude's avatar
MARCHE Claude committed
755
* DONE replayer: replay should be considered failed if new goals appeared.
MARCHE Claude's avatar
MARCHE Claude committed
756

MARCHE Claude's avatar
MARCHE Claude committed
757
* DONE ? fix problems with installed scripts that are missing a proper executable right (mails Frederic Boulanger)
MARCHE Claude's avatar
MARCHE Claude committed
758 759

* Isabelle Support:
MARCHE Claude's avatar
MARCHE Claude committed
760
** DONE ? fix the problem with why3_jedit script missing executable bit
MARCHE Claude's avatar
MARCHE Claude committed
761
** DONE add a documentation: start "isabelle why3_jedit" before why3ide, use "Close C-w" to signal the end of edit to why3"
MARCHE Claude's avatar
MARCHE Claude committed
762

MARCHE Claude's avatar
MARCHE Claude committed
763
* extraction vers Caml
764
** DONE utiliser ZArith
MARCHE Claude's avatar
MARCHE Claude committed
765

MARCHE Claude's avatar
MARCHE Claude committed
766
==================== Roadmap for release 0.82 ========================
767

MARCHE Claude's avatar
MARCHE Claude committed
768
Scheduled for 9 december 2013
769

770 771
== New Features to announce ==

MARCHE Claude's avatar
MARCHE Claude committed
772 773 774
* input language
** lemma functions
** polymorphic recursion permitted
MARCHE Claude's avatar
MARCHE Claude committed
775
** types "opaques" TODO ???
MARCHE Claude's avatar
MARCHE Claude committed
776

MARCHE Claude's avatar
MARCHE Claude committed
777

MARCHE Claude's avatar
MARCHE Claude committed
778
* new provers:
MARCHE Claude's avatar
MARCHE Claude committed
779
** veriT 201310
MARCHE Claude's avatar
MARCHE Claude committed
780
** Metitarski 2.2 (contribution by Piotr Trojanek)
MARCHE Claude's avatar
MARCHE Claude committed
781 782 783 784
** Metis 2.3
** Beagle 0.4.1
** Princess 2013-05-13
** Yices2 2.0.4
MARCHE Claude's avatar
MARCHE Claude committed
785
** Isabelle 2013-2 (contribution by Stefan Berghofer)
MARCHE Claude's avatar
MARCHE Claude committed
786 787

* new versions of provers:
MARCHE Claude's avatar
MARCHE Claude committed
788
** Alt-Ergo 0.95.2
MARCHE Claude's avatar
MARCHE Claude committed
789
** CVC4 1.1 & 1.2 & 1.3
MARCHE Claude's avatar
MARCHE Claude committed
790
** Coq 8.4pl2
MARCHE Claude's avatar
MARCHE Claude committed
791
** gappa 1.0.0
MARCHE Claude's avatar
MARCHE Claude committed
792 793 794
** SPASS 3.8ds

* API: more examples of use in  examples/use_api/
MARCHE Claude's avatar
MARCHE Claude committed
795

MARCHE Claude's avatar
MARCHE Claude committed
796
* emacs support: why.el renamed into why3.el
MARCHE Claude's avatar
MARCHE Claude committed
797 798 799 800

* why3session
** --stats: changed (detailler, temps, distinction root et subgoals, CLAUDE)

MARCHE Claude's avatar
MARCHE Claude committed
801
* bug fixes:
MARCHE Claude's avatar
MARCHE Claude committed
802
** remove extra leading zeros in decimal literals when a prover don't like them
MARCHE Claude's avatar
MARCHE Claude committed
803 804 805
** PVS output: types are always non-empty
** PVS: fixed configuration and installation process
** improved shape mecanism for session updates (see VSTTE'13 paper).
806 807
  Compatibility with session files from version 0.81 and earlier is
  assured.
MARCHE Claude's avatar
MARCHE Claude committed
808 809
** Coq tactic: now loads dynamic plug-ins
** Coq output: fixed printing of polymorphic recursive datatypes
MARCHE Claude's avatar
MARCHE Claude committed
810 811 812 813 814
** bug #15493: correct Coq output for polymorphic algebraic data types
** wish #15053: Remove proof time from "Goals proved by only one prover" section of why3session info --stats
** bug #13736: why3ml was slow when there are many inclusions
** bug #16488: decimals in TPTP syntax
** bug #16454: do not send arithmetic triggers anymore to alt-Ergo
MARCHE Claude's avatar
MARCHE Claude committed
815 816
** syntax highlighting bugs: should be fixed by removing the old language
   file alt-ergo.lang from alt-ergo distribution
MARCHE Claude's avatar
MARCHE Claude committed
817

818 819 820 821 822
== Final preparation ==

* faire une passe sur le BTS
* do "make update-coq" and "make", fix Coq realizations if needed
* check that nightly bench is OK
MARCHE Claude's avatar
MARCHE Claude committed
823
* check that "make xml-validate-local" is OK
824
  (see below : copy the dtd on the web)
MARCHE Claude's avatar
MARCHE Claude committed
825
* put 0.82 in file Version
826 827 828 829
* check headers
* check the file CHANGES, add the release date
* manual in PDF: check that macro \todo is commented out
    in ./macros.tex, and then "make doc"
MARCHE Claude's avatar
MARCHE Claude committed
830 831
  (check that manual in HTML is also generated, doc/html/index.html)
* do "make dist"
MARCHE Claude's avatar
MARCHE Claude committed
832
* test distrib/why3-0.82.tar.gz
833 834 835 836
* install web page for why2 which includes an updated page for the
  quick migration guide. (sources are in CVS repository
  ~filliatr/ARCHIVE/www/why)
* put on the web page
MARCHE Claude's avatar
MARCHE Claude committed
837 838
 - why3-0.82.tar.gz
   cp distrib/why3-0.82.tar.gz /users/www-perso/projets/why3/download
839 840

 - the manual in PDF
MARCHE Claude's avatar
MARCHE Claude committed
841
   cp doc/manual.pdf /users/www-perso/projets/why3/download/manual-0.82.pdf
842

843
 - the HTML version of the manual (content of doc/html)
MARCHE Claude's avatar
MARCHE Claude committed
844
   cp -r doc/html /users/www-perso/projets/why3/doc-0.82
845

846
 - why3session.dtd
847 848
   cp share/why3session.dtd /users/www-perso/projets/why3/

849 850
 - standard library online, using why3doc, to http://why3.lri.fr/stdlib/
   make stdlibdoc
MARCHE Claude's avatar
MARCHE Claude committed
851
   cp -r doc/stdlibdoc /users/www-perso/projets/why3/stdlib-0.82
852
   rm /users/www-perso/projets/why3/stdlib
MARCHE Claude's avatar
MARCHE Claude committed
853
   ln -s /users/www-perso/projets/why3/stdlib-0.82 \
854 855 856
            /users/www-perso/projets/why3/stdlib
 - API doc, produced using ocamldoc, to http://why3.lri.fr/api/
    make apidoc
MARCHE Claude's avatar
MARCHE Claude committed
857
    cp -r doc/apidoc /users/www-perso/projets/why3/api-0.82
858
    rm /users/www-perso/projets/why3/api
MARCHE Claude's avatar
MARCHE Claude committed
859
    ln -s /users/www-perso/projets/why3/api-0.82 \
860
      /users/www-perso/projets/why3/api
MARCHE Claude's avatar
MARCHE Claude committed
861
   (PROBLEME avec style.css ? Ou est le probleme ?)
MARCHE Claude's avatar
MARCHE Claude committed
862
 - update the main HTML page (sources are in repository why3-www)
863 864 865
   edit index.html
   make export

MARCHE Claude's avatar
MARCHE Claude committed
866 867 868 869
 - add links to extra resources like
   http://why3.lri.fr/jfla-2012/, http://www.lri.fr/~marche/MPRI-2-36-1/,
   page du cours de l'X (in french ? using Krakatoa/why3 bridge)

870 871 872
 - make everything writeable for the group
   chmod -R g+w /users/www-perso/projets/why3

MARCHE Claude's avatar
MARCHE Claude committed
873
* make a last commit:
MARCHE Claude's avatar
MARCHE Claude committed
874 875 876
 - git commit -m "release 0.82"
 - add tag 0.82 to the git repository, using
   git tag 0.82
MARCHE Claude's avatar
MARCHE Claude committed
877 878 879 880
 - do not forget to push it using
   git push
   git push --tags

Guillaume Melquiond's avatar
Guillaume Melquiond committed
881 882
* add a new version to the bugtracker:
  https://gforge.inria.fr/tracker/admin/?group_id=2990&atid=10293&add_extrafield=1
883

MARCHE Claude's avatar
MARCHE Claude committed
884
* produce the Why3 part of Toccata gallery
885
  -> add also a tar.gz and a ZIP file of it (this is done by doing
MARCHE Claude's avatar
MARCHE Claude committed
886
  "make gallery-files" in the sources of the Toccata web pages)
887 888 889 890 891 892
* Announce the distrib
 - What to put in the announcement: see New Features above
* The next commit : add +git to the version in file Version

== TODOs ==

MARCHE Claude's avatar
MARCHE Claude committed
893
* DONE Patch de johannes pour les noms de fichier pour Isabelle
MARCHE Claude's avatar
MARCHE Claude committed
894

MARCHE Claude's avatar
MARCHE Claude committed
895
* DONE discriminate, mettre les bons arguments par defaut (ANDREI)
MARCHE Claude's avatar
MARCHE Claude committed
896

MARCHE Claude's avatar
MARCHE Claude committed
897
* DONE efficiency issues
MARCHE Claude's avatar
MARCHE Claude committed
898 899 900 901 902 903
** understand problems when large number of goals (cf D Mentré examples)
** prouveur de Martin
** tester avant la release sur
*** BWare
*** Prouveur de Martin
*** examples de Frama-C/Jessie et Krakatoa
904

905
* DONE Coq detection (et PVS) (CLAUDE, champ supplementaire compile_support = yes dans le prover-detection-data)
906 907 908
** refuser de detecter Coq si on n'a pas compilé avec le support de Coq
   (i.e. si Coq a ete installé apres)

MARCHE Claude's avatar
MARCHE Claude committed
909
* Coq tactic (CLAUDE, GUILLAUME, JCF, ANDREI)
MARCHE Claude's avatar
MARCHE Claude committed
910
** DONE bug Prod(_,_,_) -> traiter le cas
MARCHE Claude's avatar
MARCHE Claude committed
911

912 913
* Smoke detector and absurd: on pourrait mettre un label particulier
  sur le "false" genéré par absurd, pour indiquer que c'est
MARCHE Claude's avatar
MARCHE Claude committed
914
  intentionel que l'on veuille prouver false. FAIT
MARCHE Claude's avatar
MARCHE Claude committed
915
  Un tel cas pourrait etre
916 917
  traité de facon speciale par le smoke detector avec option "deep",
  pour eviter une fausse alarme.
MARCHE Claude's avatar
MARCHE Claude committed
918
  PAS FAIT
919 920

* faire le menage dans les transformations d'induction : _int _ty
MARCHE Claude's avatar
MARCHE Claude committed
921
  _ty_lex, FAIT et documenter PAS FAIT
922 923 924

* Documentation
 - (ANDREI) make the glossary available
MARCHE Claude's avatar
MARCHE Claude committed
925
 - (CLAUDE) complete api.tex: explain how to build/apply
MARCHE Claude's avatar
MARCHE Claude committed
926
   transformations, write new functions on terms
MARCHE Claude's avatar
MARCHE Claude committed
927 928
 - LEON: add a section "further reading"

MARCHE Claude's avatar
MARCHE Claude committed
929
* DONE bug fix: 16454 (ne pas envoyer des triggers arithmetiques) (GUILLAUME)
MARCHE Claude's avatar
MARCHE Claude committed
930

MARCHE Claude's avatar
MARCHE Claude committed
931
* DONE bug fix: 15652 (ghost code detection)
MARCHE Claude's avatar
MARCHE Claude committed
932 933 934

* support for new provers
** Alt-Ergo 0.95.2 DONE
MARCHE Claude's avatar
MARCHE Claude committed
935
** CVC4 1.2 DONE: pb avec les booleens
MARCHE Claude's avatar
MARCHE Claude committed
936
** DONE Coq 8.4pl2: probleme tactique Why3
MARCHE Claude's avatar
MARCHE Claude committed
937
** DONE Metitarski: improve it (CLAUDE, GUILLAUME)
MARCHE Claude's avatar
MARCHE Claude committed
938

MARCHE Claude's avatar
MARCHE Claude committed
939

MARCHE Claude's avatar
MARCHE Claude committed
940
* DONE simplification de (a && false) ne devrait pas etre false
MARCHE Claude's avatar
MARCHE Claude committed
941

MARCHE Claude's avatar
MARCHE Claude committed
942

943

Guillaume Melquiond's avatar
Guillaume Melquiond committed
944

MARCHE Claude's avatar
MARCHE Claude committed
945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060

==================== Roadmap for release 0.81 ========================

released on March 25th, 2013

== New Features to announce ==

  o [logic] accept type expressions in clone substitutions
  o [whyml] support for relation chains (e.g., "e1 = e2 < e3")
  * [whyml] every exception raised in a function must be listed
    in as "raises { ... }" clause. A postcondition may be omitted
    and equals to "true" by default.
  * [whyml] if a function definition contains a "writes { ... }"
    clause, then every write effect must be listed. If a function
    definition contains a "reads { ... }" clause, then every read
    _and_ write effect must be listed.
  * [drivers] syntax rules, metas, and preludes are inherited
    through cloning. Keyword "cloned" becomes unnecessary and
    is not accepted anymore.
  o [why3ide] allow several files on the command-line
  o [ocaml API] incompatible changes in Set/Map/Hashtbl modules
  o [ocaml API] examples in the manual extended to API for Why3ml programs
  o [stdlib] fixed inconsistency in map.MapPermut theory
  o [prover] fixed Coq 8.4 support for theory real.Trigonometry
  o [prover] support for Gappa up to 0.16.6
  o [prover] support for Z3 4.2, 4.3.*
  o [prover] support for Alt-Ergo 0.95.1
  o [prover] support for CVC4
  o [prover] support for PVS 6
  o [prover] experimental support for mathematica
  o [prover] experimental support for MathSAT5
  o [examples] several new examples, including solutions to the
    VerifyThis@fm2012 challenges

== Final preparation ==

* faire une passe sur le BTS
* do "make update-coq" and "make", fix Coq realizations if needed
* check that nightly bench is OK
* check that "make xml-validate" is OK
  (see below : copy the dtd on the web)
* put 0.81 in file Version
* check headers
* check the file CHANGES, add the release date
* manual in PDF: check that macro \todo is commented out
    in ./macros.tex, and then "make doc"
* manual in HTML: "make doc/html/index.html"
* do "make distrib"
* test distrib/why3-0.81.tar.gz
* install web page for why2 which includes an updated page for the
  quick migration guide. (sources are in CVS repository
  ~filliatr/ARCHIVE/www/why)
* put on the web page
 - why3-0.81.tar.gz
   cp distrib/why3-0.81.tar.gz /users/www-perso/projets/why3/download

 - the manual in PDF
   cp doc/manual.pdf /users/www-perso/projets/why3/download/manual-0.81.pdf

 - the HTML version of the manual (content of doc/html)
   cp -r doc/html /users/www-perso/projets/why3/doc-0.81

 - why3session.dtd
   cp share/why3session.dtd /users/www-perso/projets/why3/

 - standard library online, using why3doc, to http://why3.lri.fr/stdlib/
   make stdlibdoc
   cp -r doc/stdlibdoc /users/www-perso/projets/why3/stdlib-0.81
   rm /users/www-perso/projets/why3/stdlib
   ln -s /users/www-perso/projets/why3/stdlib-0.81 \
            /users/www-perso/projets/why3/stdlib
 - API doc, produced using ocamldoc, to http://why3.lri.fr/api/
    make apidoc
    cp -r doc/apidoc /users/www-perso/projets/why3/api-0.81
    rm /users/www-perso/projets/why3/api
    ln -s /users/www-perso/projets/why3/api-0.81 \
      /users/www-perso/projets/why3/api
   PROBLEME avec style.css
 - update the main HTML page (sources are in repository why3-www)
   edit index.html
   make export

 - add links to extra resources like
   http://why3.lri.fr/jfla-2012/, http://www.lri.fr/~marche/MPRI-2-36-1/,
   page du cours de l'X (in french ? using Krakatoa/why3 bridge)

 - make everything writeable for the group
   chmod -R g+w /users/www-perso/projets/why3

* make a last commit:
 - git commit -m "release 0.81"
 - add tag 0.81 to the git repository, using
   git tag 0.81
 - do not forget to push it using
   git push
   git push --tags

* add a new version to the bugtracker:
  https://gforge.inria.fr/tracker/admin/?group_id=2990&atid=10293&add_extrafield=1

* produce the Why3 part of Toccata gallery
  -> add also a tar.gz and a ZIP file of it (this is done by doing
  "make gallery-files" in the sources of the Toccata web pages)
* Announce the distrib
 - What to put in the announcement: see New Features above
* The next commit : add +git to the version in file Version

== TODOs ==

* extraction vers Caml
 - PRIORITAIRE, JCF, ANDREI

* Documentation
 - (CLAUDE) complete api.tex: explain how to build theories


1061 1062 1063
==================== Roadmap for release 0.80 ========================

Change in programs' input syntax deserves incrementing version to 0.80
1064

1065
scheduled on Oct 2012
1066

MARCHE Claude's avatar
MARCHE Claude committed
1067 1068
== New Features to announce ==

1069 1070
Programs:
  o new concrete syntax for programs
1071
  o new API for programs
1072
  o type invariants
1073
  o ghost code
1074

1075
Transformations:
1076 1077
  o induction (experimental, undocumented)
  o bisection (experimental, undocumented)
1078

1079
Provers support:
1080
  o support for Coq 8.4
1081
  o dropped support for Coq 8.2
1082
  o support for forthcoming PVS 6.0, including realizations
1083
  o support for iProver and Zenon
1084

1085
Misc:
Claude Marche's avatar
Claude Marche committed
1086
  o improved output of "why3session latex"
MARCHE Claude's avatar
MARCHE Claude committed
1087
    (incompatible changes in LaTeX macros)
Claude Marche's avatar
Claude Marche committed
1088
  o [replayer] new option -q for running quietly
1089 1090 1091 1092 1093
  o a warning is emitted for unused bound logic variables in "forall",
    "exists" and "let"
  o a warning is emitted for any occurrence of a formula of the form
    "exists x, P -> Q". Formulas of this form are usually a user
    mistake. If this is intended, one can write "exists x, not P \/ Q"
Claude Marche's avatar
Claude Marche committed
1094
    instead
MARCHE Claude's avatar
MARCHE Claude committed
1095

1096
Bug fixes:
1097
  o Coq output uses type classes to ensure Why3 types are inhabited
MARCHE Claude's avatar
MARCHE Claude committed
1098 1099 1100 1101
  o fixed bug on merging config files which prevented the use
    of Why3 back-end of the Frama-C/Jessie plugin when Coq is
    not installed. (Bug 14672 of the Bug Tracking System)
  o fixed bugs 13503 and 13375 of the Bug Tracking System
MARCHE Claude's avatar
MARCHE Claude committed
1102 1103 1104

== Final preparation ==

MARCHE Claude's avatar
MARCHE Claude committed
1105
* faire une passe sur le BTS
1106
* do "make update-coq" and "make", fix Coq realizations if needed
MARCHE Claude's avatar
MARCHE Claude committed
1107 1108
* check that nightly bench is OK
* check that "make xml-validate" is OK
MARCHE Claude's avatar
MARCHE Claude committed
1109
  (see below : copy the dtd on the web)
MARCHE Claude's avatar
MARCHE Claude committed
1110
* put 0.80 in file Version
MARCHE Claude's avatar
MARCHE Claude committed
1111
* check headers
1112
* check the file CHANGES, add the release date
MARCHE Claude's avatar
MARCHE Claude committed
1113 1114
* manual in PDF: check that macro \todo is commented out
    in ./macros.tex, and then "make doc"
1115
* manual in HTML: "make doc/html/index.html"
MARCHE Claude's avatar
MARCHE Claude committed
1116
* do "make distrib"
MARCHE Claude's avatar
MARCHE Claude committed
1117
* test the distrib why3-0.80.tar.gz
MARCHE Claude's avatar
MARCHE Claude committed
1118
* make a last commit:
1119
 - add tag 0.80 to the git repository, using git tag 0.80
MARCHE Claude's avatar
MARCHE Claude committed
1120
 - do not forget to push it using git push --tags
1121 1122 1123
* install web page for why2 which includes an updated page for the
  quick migration guide. (sources are in CVS repository
  ~filliatr/ARCHIVE/www/why)
MARCHE Claude's avatar
MARCHE Claude committed
1124
* put on the web page
MARCHE Claude's avatar
MARCHE Claude committed
1125
 - why3-0.80.tar.gz
1126
 - the HTML version of the manual (content of doc/html)
MARCHE Claude's avatar
MARCHE Claude committed
1127
 - why3session.dtd
MARCHE Claude's avatar
MARCHE Claude committed
1128
 - standard library online, using why3doc, to http://why3.lri.fr/stdlib/
1129 1130 1131 1132 1133
   make stdlibdoc
   cp -r doc/stdlibdoc /users/www-perso/projets/why3/stdlib-0.80
   rm /users/www-perso/projets/why3/stdlib)
   ln -s /users/www-perso/projets/why3/stdlib-0.80 \
            /users/www-perso/projets/why3/stdlib
MARCHE Claude's avatar
MARCHE Claude committed
1134
 - API doc, produced using ocamldoc, to http://why3.lri.fr/api/
1135 1136 1137
    make apidoc
    cp -r doc/apidoc /users/www-perso/projets/why3/api-0.80
    rm /users/www-perso/projets/why3/api
MARCHE Claude's avatar
MARCHE Claude committed
1138
    ln -s /users/www-perso/projets/why3/api-0.80 \
1139 1140
      /users/www-perso/projets/why3/api
   PROBLEME avec style.css
MARCHE Claude's avatar
MARCHE Claude committed
1141 1142
 - update the main HTML page (sources are in why3-papers/www)

1143
* produce the Why3 part of ProVal gallery
1144
  -> add also a tar.gz and a ZIP file of it (this is done by doing
MARCHE Claude's avatar
MARCHE Claude committed
1145
  "make gallery-files" in the sources of the web pages)
MARCHE Claude's avatar
MARCHE Claude committed
1146 1147 1148 1149 1150 1151
* Announce the distrib
 - What to put in the announcement: see New Features above
* The next commit : add +git to the version in file Version

== TODOs ==

1152
* DONE (JCF) reject global "val"s in typing environment for logic decls.
MARCHE Claude's avatar
MARCHE Claude committed
1153

1154
* DONE appliquer les changements de syntaxe des programmes dans la doc : aussi bien dans le tutorial que dans la BNF des manpages
1155 1156


1157
* DONE Sortie PVS, avec mecanisme de realization
1158

MARCHE Claude's avatar
MARCHE Claude committed
1159
* DONE mettre au propre les loc des fichiers de sessions, en particulier
MARCHE Claude's avatar
MARCHE Claude committed
1160 1161
  les noms de fichiers doivent etre relatifs au fichier de session
  lui-meme. Utiliser Sysutil.relativize_filename a bon escient.
MARCHE Claude's avatar
MARCHE Claude committed
1162

1163 1164
* DONE sessions: mettre la dtd sur le web et changer l'entête des sessions pour qu'elles
   pointent dessus
1165 1166


1167
* DONE (PRIORITAIRE) Coq output
1168 1169 1170 1171 1172 1173
 - corriger l'incoherence, comprendre si on veut vraiment accepter

  function x : 'a
  (cf: en caml cela ne marche pas)
 Solution proposee: utiliser des types classes, en particulier Inhabited

1174
* DONE (PRIORITAIRE), JCF et ANDREI, clone de module
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
 - demarche: ecrire une API avec smart constructors garantissant
   le bon typage, et clone sera en premier lieu un de ces constructors
 - cas d'utilisation: range d'entiers de Jessie, Flottants -> double ou single
   containeurs pour Adacore et Claire
 - NON PRIORITAIRE ?
  + regions : strong update
  + ghost code
  + logic symbols used in programs






MARCHE Claude's avatar
MARCHE Claude committed
1189 1190 1191 1192 1193 1194 1195 1196 1197
==================== Roadmap for release 0.73 ========================

== New Features to announce ==

New features:
  o [Why3ml] new construct "abstract e { q }"
  o [Coq output] default tactic is now "intros ..." with a pattern
    that matches the structure of the goal
  o [why3replayer] option -obsolete-only
MARCHE Claude's avatar
MARCHE Claude committed
1198
  o co-inductive predicates
MARCHE Claude's avatar
MARCHE Claude committed
1199 1200
  o new option -e for "why3session latex" allows to specify when to
    split tables in parts
MARCHE Claude's avatar
MARCHE Claude committed
1201 1202 1203 1204
  o [Sessions] a small change in the format. This hopefully improves
    the association of old goals and new goals when the input is
    modified.  For compatibility, Why3 is still able to read session
    files in the old format.
1205
  o [Provers] support for Z3 4.0
MARCHE Claude's avatar
MARCHE Claude committed
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224

Bug fix:
  o completed support for the "Out Of Memory" prover result
  o [Coq output] quotes in identifiers remain quotes in Coq
  o workaround for a bug about modulo operator in Alt-Ergo 0.94
  o fixed a consistency issue with set.Fset theory


== Final preparation ==

* check that nightly bench is OK
* put 0.73 in file Version
* check headers
* check the file CHANGES
* manual in PDF: check that macro \todo is commented out
    in ./macros.tex
* do "make distrib"
* test the distrib why3-0.73.tar.gz
* make a last commit:
1225
 - add tag 0.73 to the git repository
1226 1227
 - do not forget to push it using git push --tags

MARCHE Claude's avatar
MARCHE Claude committed
1228 1229
* put on the web page
 - why3-0.73.tar.gz
1230 1231 1232 1233 1234 1235
 - standard library online, using why3doc, to http://why3.lri.fr/stdlib/
   (make stdlibdoc ;
    cp -r doc/stdlibdoc /users/www-perso/projets/why3/stdlib-0.73;
    ln -s /users/www-perso/projets/why3/stdlib-0.73 \
            /users/www-perso/projets/why3/stdlib)
 - API doc, produced using ocamldoc, to http://why3.lri.fr/api/
MARCHE Claude's avatar
MARCHE Claude committed
1236
    Note: check that URL of API doc is correct in doc/api.tex line 9.
1237 1238 1239 1240
     (make apidoc ;
    cp -r doc/apidoc /users/www-perso/projets/why3/api-0.73;
    ln -s /users/www-perso/projets/why3/api-0.73 \
            /users/www-perso/projets/why3/api    )
MARCHE Claude's avatar
MARCHE Claude committed
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
 - update the main HTML page (sources are in why3-papers/www)

* produce the Why3 part of ProVal gallery ?
* Announce the distrib
 - What to put in the announcement: see New Features above
* The next commit : add +git to the version in file Version

== TODOs ==

* DONE Ajouter un result de prouveur "outofmemory" analogue a "timeout"

* Why3ML new language constructs
** NOT NEEDED ANYMORE sandbox
** DONE abstract e { q }
** DELAYED contract e { q }

* replayer
** DONE option pour ne rejouer que si obsolete

* Documentation
MARCHE Claude's avatar
MARCHE Claude committed
1261
 - DELAYED document co-inductive predicates
MARCHE Claude's avatar
MARCHE Claude committed
1262 1263
 - DONE (CLAUDE) revoir documentation du smoke detector

MARCHE Claude's avatar
MARCHE Claude committed
1264 1265
==================== Roadmap for release 0.72 ========================

1266
== New Features to announce ==
MARCHE Claude's avatar
MARCHE Claude committed
1267

1268 1269 1270 1271 1272 1273
* Coq realizations. See manual Chapter xx
* Coq tactic. See manual Chapter xx
* tool why3session, including commands latex, html, stats. See manual Section xx
* tool why3doc. See manual Section xx
* Support for several versions of the same prover, for prover upgrade.
See manual Section xx
MARCHE Claude's avatar
MARCHE Claude committed
1274
* Improved IDE:
1275
 - left scrollbar, selection of shown or hidden provers, font enlargement
1276 1277
 - integration of the support for prover upgrade
 - support for selection of alternate editors
1278 1279
* Complete support for limiting provers' memory usage
* Improved support of Microsoft Windows OS
MARCHE Claude's avatar
MARCHE Claude committed
1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
* what else ?
* see also the file CHANGES

== Final preparation ==

* check that nightly bench is OK
* put 0.72 in file Version
* increment the magic number in config (needed ???)
* check headers
* check the file CHANGES
* manual in PDF: check that macro \todo is commented out
    in ./macros.tex
* do "make distrib"
* test the distrib why3-0.72.tar.gz
* make a last commit:
 - add tag 0.72 to the git repository (do not forget to push it)
* put on the web page
 - why3-0.72.tar.gz
1298 1299
 - standard library online, using why3doc (make stdlibdoc),
   to http://why3.lri.fr/stdlib/
1300
 - API doc, produced using ocamldoc (make apidoc), to http://why3.lri.fr/api/
MARCHE Claude's avatar
MARCHE Claude committed
1301
    Note: check that URL of API doc is correct in doc/api.tex line 9.
1302
 - update the main HTML page (sources are in why3-papers/www)
MARCHE Claude's avatar
MARCHE Claude committed
1303

MARCHE Claude's avatar
MARCHE Claude committed
1304 1305 1306 1307
* produce the Why3 part of ProVal gallery ?
* Announce the distrib
 - What to put in the announcement: see New Features above
* The next commit : add +git to the version in file Version
1308
* Announce the why3 tactic on Coq Club
MARCHE Claude's avatar
MARCHE Claude committed
1309

MARCHE Claude's avatar
MARCHE Claude committed
1310 1311
== TODOs ==

1312

1313
* DONE bug CVC3 avec la division par 0, cf examples/tests-provers/cvc3.why
MARCHE Claude's avatar
MARCHE Claude committed
1314

1315 1316 1317
* DONE Document the Coq plugin and tactic
** DONE option timelimit <n>
** DONE renommer "coq-plugin" en "coq-tactic"
1318

1319
* DONE (JCF, ANDREI) add all examples from the VSTTE 2012 competition
MARCHE Claude's avatar
MARCHE Claude committed
1320

1321
* DONE (CLAUDE) Ajouter page provers sur le site web why3
MARCHE Claude's avatar
MARCHE Claude committed
1322
** !TODO! relire
1323

MARCHE Claude's avatar
MARCHE Claude committed
1324
* Documentation
MARCHE Claude's avatar
MARCHE Claude committed
1325

1326
 - DONE traiter les \todo :
1327

1328 1329 1330
 DONE install.tex:179:% \todo{que devient l'option -to-known-prover de why3session ?
 DONE manpages.tex:790:% \todo{A adapter en fonction de la decision sur l'upgrade de prover}
 DONE manpages.tex:809:\section{The \texttt{why3doc} tool} \todo{Documenter}
1331 1332


1333 1334 1335
 - (ANDREI) complete technical.tex: section "Drivers of external
   provers"

1336
 - DONE (GUILLAUME) Realisations Coq, comment fait l'utilisateur pour faire
MARCHE Claude's avatar
MARCHE Claude committed
1337 1338 1339 1340 1341 1342 1343 1344
   ses realisations ne pas oublier de dire que les dependances avec le
   .why ou .mlw: ne sera pas vérifié

 - DONE Documenter l'utilisation de plusieurs versions du meme
   prouveur comme CVC3 et Z3

 - DONE (ANDREI) ajouter option a why3config pour ajouter association
   ident-executable
1345
   DONE remplacer le ":" par " " (Arg.Tuple)
1346

1347
 - DONE (CLAUDE) Documenter les popups qui peuvent apparaitre dans why3ide
MARCHE Claude's avatar
MARCHE Claude committed
1348 1349
   quand les prouveurs ont changé. Et les mettre au point:

1350
   . DONE Lors d'un replay, le dialogue "replace proof" apparait un nombre
MARCHE Claude's avatar
MARCHE Claude committed
1351 1352 1353 1354
     important de fois, il faut absolument pouvoir interrompre, ou
     donner une reponse qui soit appliquée pour le reste.  (le 3e
     bouton "never replace..." ne semble pas jourer ce role...)

1355
   . DONE le dialogue "replace proof" est de toute facon trop large, et les
MARCHE Claude's avatar
MARCHE Claude committed
1356 1357
   choix possibles sont confus.

1358
 - DONE (CLAUDE) meme ordre d'idee: ne pas ecraser "default editor" et
MARCHE Claude's avatar
MARCHE Claude committed
1359
   "timelimit"
1360
   en fait c'était déjà le cas
MARCHE Claude's avatar
MARCHE Claude committed
1361

1362
* DONE permettre d'utiliser emacs/proof general a la place de coqide depuis
MARCHE Claude's avatar
MARCHE Claude committed
1363
  why3ide
1364
*** DONE allow to choose which one the IDE Preferences
1365

MARCHE Claude's avatar
MARCHE Claude committed
1366
* (CLAUDE) why3session
1367
 - DONE passe sur la documentation ecrite par Francois reecrite par Guillaume
1368
 - DONE "why3replayer -latex" remplacé par "why3session latex"
1369 1370
 - DONE "why3html" remplacé par "why3session html"
 - DONE "why3stats" (src/ide/stats.ml) remplacé par "why3session info --stats"
MARCHE Claude's avatar
MARCHE Claude committed
1371

1372
* (JCF) ameliorer why3doc
1373
 - DONE rajouter la production des liens
1374
 - DONE produire un index.html
MARCHE Claude's avatar
MARCHE Claude committed
1375

1376
* DONE provers
MARCHE Claude's avatar
MARCHE Claude committed
1377 1378 1379 1380 1381 1382 1383 1384
 - DONE (CLAUDE) Ensure that we kill a prover after some time
   (ressurect %T ? with a meaning like twice the value of %t ?),
   because we cannot be sure they always honor their own -timeout
   option.

 - DONE (ANDREI) better use of Alt-Ergo's builtin theories: records,
   enumeration types (Alt-Ergo >= 0.94) => at least two drivers for
   Alt-Ergo, depending on its version number
MARCHE Claude's avatar
MARCHE Claude committed
1385

1386
* DONE fix bugs and update the BTS
1387
 - DONE (CLAUDE) Refreshing the IDE pane for prover output
MARCHE Claude's avatar
MARCHE Claude committed
1388

1389
* DONE (CLAUDE) IDE:
MARCHE Claude's avatar
MARCHE Claude committed
1390
 - DONE enlarge font (menu + shortcut Ctrl-+)
1391
 - DONE Ctrl-A to select all rows
MARCHE Claude's avatar
MARCHE Claude committed
1392 1393 1394 1395
 - DONE Do not save if not needed
 - DONE ne pas ecrire saving sessions si on ne sauve pas la session
 - DONE add a scrollbar for the left panel

MARCHE Claude's avatar
MARCHE Claude committed
1396 1397
* DONE (FRANCOIS) move Session module and its dependencies into the
  Why3 library
MARCHE Claude's avatar
MARCHE Claude committed
1398 1399 1400 1401 1402
 - but avoid duplication with session_ro
 - avoid also duplication of type like prover_data record
 - do not include task and transf in the data type, so that
   one can reload, and redetect provers
 - session + session_ro -> session_data + session_dynamic
MARCHE Claude's avatar
MARCHE Claude committed
1403

MARCHE Claude's avatar
MARCHE Claude committed
1404
======================= Roadmap for release 0.71 ========================
MARCHE Claude's avatar
MARCHE Claude committed
1405

MARCHE Claude's avatar
MARCHE Claude committed
1406
* DONE Final preparation:
MARCHE Claude's avatar
MARCHE Claude committed
1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
** put on the web page