ROADMAP 30.7 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
== Papers to write ==
Jean-Christophe Filliatre's avatar
Jean-Christophe Filliatre committed
6

7 8 9 10
  * paper on the module system, its semantics, realizations, avec en
    particulier la solution avec les types classes qui reste a
    implanter

MARCHE Claude's avatar
MARCHE Claude committed
11 12
  * paper on the proof management system

13
  * DONE Encodings and transformations (Andrei+Francois FroCos 11)
14
  * DONE Why presentation at the IVL workshop of CADE:
15 16
    (http://research.microsoft.com/en-us/um/people/moskal/boogie2011/)
    deadline: May 1st
Jean-Christophe Filliatre's avatar
Jean-Christophe Filliatre committed
17 18
  * Caml code ?
  * logic language for talking to provers
19 20 21
    - DONE (Boogie 11)
    - DONE FOL + poly (FroCos 11)
    -  alg + ind + rec ? + theories
Jean-Christophe Filliatre's avatar
Jean-Christophe Filliatre committed
22
  * VACID-0
MARCHE Claude's avatar
MARCHE Claude committed
23
  * system description (e.g. at CADE, TACAS)
Jean-Christophe Filliatre's avatar
Jean-Christophe Filliatre committed
24
  * rapports recherche ?
MARCHE Claude's avatar
MARCHE Claude committed
25

MARCHE Claude's avatar
MARCHE Claude committed
26
== stages ==
MARCHE Claude's avatar
MARCHE Claude committed
27

MARCHE Claude's avatar
MARCHE Claude committed
28
* M1. preuve d'un petit compilateur, pas de pb de lieur,
MARCHE Claude's avatar
MARCHE Claude committed
29 30
   eventuellement outils pour les preuves par recurrence
   a la Leino, + fct size automatique
MARCHE Claude's avatar
MARCHE Claude committed
31
* M2. Lieur en Why3, POPLmark challenge. vers
MARCHE Claude's avatar
MARCHE Claude committed
32
   un theorie et/ou un module réutilisable de lieurs
MARCHE Claude's avatar
MARCHE Claude committed
33
* (M2?) Stage Airbus, "TIP" avec Frama-C/Jessie ou WP/Why/Coq
MARCHE Claude's avatar
MARCHE Claude committed
34
   besoin de la tactique Coq?
35

MARCHE Claude's avatar
MARCHE Claude committed
36
== new major features ==
MARCHE Claude's avatar
MARCHE Claude committed
37

MARCHE Claude's avatar
MARCHE Claude committed
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
* 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
 - Fast WP a la Leino
 - 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


66 67 68 69 70 71
* 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
72 73
** support de Yices 2 ? interesserait Cesar

74

75 76
==================== Roadmap for release 0.81 ========================

MARCHE Claude's avatar
MARCHE Claude committed
77
scheduled on March 2013
78 79 80

== New Features to announce ==

MARCHE Claude's avatar
MARCHE Claude committed
81 82 83 84 85 86 87 88 89 90 91 92
  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.
93
  o [why3ide] allow several files on the command-line
94
  o [ocaml API] incompatible changes in Set/Map/Hashtbl modules
MARCHE Claude's avatar
MARCHE Claude committed
95
  o [ocaml API] examples in the manual extended to API for Why3ml programs
MARCHE Claude's avatar
MARCHE Claude committed
96
  o [stdlib] fixed inconsistency in map.MapPermut theory
MARCHE Claude's avatar
MARCHE Claude committed
97
  o [prover] fixed Coq 8.4 support for theory real.Trigonometry
MARCHE Claude's avatar
MARCHE Claude committed
98
  o [prover] support for Gappa up to 0.16.6
99
  o [prover] support for Z3 4.2, 4.3.*
MARCHE Claude's avatar
MARCHE Claude committed
100
  o [prover] support for Alt-Ergo 0.95.1
MARCHE Claude's avatar
MARCHE Claude committed
101
  o [prover] support for CVC4
102 103 104 105 106
  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
MARCHE Claude's avatar
MARCHE Claude committed
107

108 109 110 111 112 113 114
== 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)
MARCHE Claude's avatar
MARCHE Claude committed
115
* put 0.81 in file Version
116 117 118 119 120 121
* 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"
MARCHE Claude's avatar
MARCHE Claude committed
122
* test distrib/why3-0.81.tar.gz
123 124 125 126 127
* 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
128 129 130 131 132
   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

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

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

139 140 141
 - 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
142
   rm /users/www-perso/projets/why3/stdlib
143 144 145 146 147 148 149 150 151
   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
MARCHE Claude's avatar
MARCHE Claude committed
152
 - update the main HTML page (sources are in repository why3-www)
153 154 155
   edit index.html
   make export

MARCHE Claude's avatar
MARCHE Claude committed
156 157 158 159
 - 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)

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

MARCHE Claude's avatar
MARCHE Claude committed
163 164 165 166 167 168 169 170
* 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

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

MARCHE Claude's avatar
MARCHE Claude committed
174
* produce the Why3 part of Toccata gallery
175
  -> add also a tar.gz and a ZIP file of it (this is done by doing
MARCHE Claude's avatar
MARCHE Claude committed
176
  "make gallery-files" in the sources of the Toccata web pages)
177 178 179 180 181 182 183 184 185 186
* 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 ==

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


MARCHE Claude's avatar
MARCHE Claude committed
187
* extraction vers Caml
MARCHE Claude's avatar
MARCHE Claude committed
188
 - PRIORITAIRE, JCF, ANDREI
MARCHE Claude's avatar
MARCHE Claude committed
189

190 191 192 193 194 195 196 197 198 199 200
* 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 detection
** 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
201
* Coq tactic
202
** ajout de bases de hint
MARCHE Claude's avatar
MARCHE Claude committed
203 204

* efficiency issues
MARCHE Claude's avatar
MARCHE Claude committed
205 206
 - understand problems when large number of goals (cf D Mentré examples)
 - also: BTS 13736
MARCHE Claude's avatar
MARCHE Claude committed
207 208
https://gforge.inria.fr/tracker/index.php?func=detail&aid=13736&group_id=2990

209 210 211 212 213
* Smoke detector and absurd: on pourrait mettre un label particulier
  sur le "false" genéré par absurd, pour indiquer que c'est
  intentionel que l'on veuille prouver false. Un tel cas pourrait etre
  traité de facon speciale par le smoke detector avec option "deep",
  pour eviter une fausse alarme.
214

215 216 217 218 219 220 221
* 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
** syntax highlighting bugs ?
   some keywords are not colored in the bottom-right window
   (but they are in the top-right window)
Guillaume Melquiond's avatar
Guillaume Melquiond committed
222
   it is caused by the language file for alt-ergo superseding the one for why3
223 224 225 226 227 228 229 230 231 232 233 234 235

* faire le menage dans les transformations d'induction : _int _ty
  _ty_lex, et DOCUMENTER

* Contre-exemples de Alt-Ergo

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

* Documentation
 - (ANDREI) make the glossary available
 - (CLAUDE) complete api.tex: explain how to build theories, apply
   transformations, write new functions on terms (A)
236

Guillaume Melquiond's avatar
Guillaume Melquiond committed
237

238 239 240
==================== Roadmap for release 0.80 ========================

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

242
scheduled on Oct 2012
243

MARCHE Claude's avatar
MARCHE Claude committed
244 245
== New Features to announce ==

246 247
Programs:
  o new concrete syntax for programs
248
  o new API for programs
249
  o type invariants
250
  o ghost code
251

252
Transformations:
253 254
  o induction (experimental, undocumented)
  o bisection (experimental, undocumented)
255

256
Provers support:
257
  o support for Coq 8.4
258
  o dropped support for Coq 8.2
259
  o support for forthcoming PVS 6.0, including realizations
260
  o support for iProver and Zenon
261

262
Misc:
Claude Marche's avatar
Claude Marche committed
263
  o improved output of "why3session latex"
MARCHE Claude's avatar
MARCHE Claude committed
264
    (incompatible changes in LaTeX macros)
Claude Marche's avatar
Claude Marche committed
265
  o [replayer] new option -q for running quietly
266 267 268 269 270
  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
271
    instead
MARCHE Claude's avatar
MARCHE Claude committed
272

273
Bug fixes:
274
  o Coq output uses type classes to ensure Why3 types are inhabited
MARCHE Claude's avatar
MARCHE Claude committed
275 276 277 278
  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
279 280 281

== Final preparation ==

MARCHE Claude's avatar
MARCHE Claude committed
282
* faire une passe sur le BTS
283
* do "make update-coq" and "make", fix Coq realizations if needed
MARCHE Claude's avatar
MARCHE Claude committed
284 285
* check that nightly bench is OK
* check that "make xml-validate" is OK
MARCHE Claude's avatar
MARCHE Claude committed
286
  (see below : copy the dtd on the web)
MARCHE Claude's avatar
MARCHE Claude committed
287
* put 0.80 in file Version
MARCHE Claude's avatar
MARCHE Claude committed
288
* check headers
289
* check the file CHANGES, add the release date
MARCHE Claude's avatar
MARCHE Claude committed
290 291
* manual in PDF: check that macro \todo is commented out
    in ./macros.tex, and then "make doc"
292
* manual in HTML: "make doc/html/index.html"
MARCHE Claude's avatar
MARCHE Claude committed
293
* do "make distrib"
MARCHE Claude's avatar
MARCHE Claude committed
294
* test the distrib why3-0.80.tar.gz
MARCHE Claude's avatar
MARCHE Claude committed
295
* make a last commit:
296
 - add tag 0.80 to the git repository, using git tag 0.80
MARCHE Claude's avatar
MARCHE Claude committed
297
 - do not forget to push it using git push --tags
298 299 300
* 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
301
* put on the web page
MARCHE Claude's avatar
MARCHE Claude committed
302
 - why3-0.80.tar.gz
303
 - the HTML version of the manual (content of doc/html)
MARCHE Claude's avatar
MARCHE Claude committed
304
 - why3session.dtd
MARCHE Claude's avatar
MARCHE Claude committed
305
 - standard library online, using why3doc, to http://why3.lri.fr/stdlib/
306 307 308 309 310
   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
311
 - API doc, produced using ocamldoc, to http://why3.lri.fr/api/
312 313 314
    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
315
    ln -s /users/www-perso/projets/why3/api-0.80 \
316 317
      /users/www-perso/projets/why3/api
   PROBLEME avec style.css
MARCHE Claude's avatar
MARCHE Claude committed
318 319
 - update the main HTML page (sources are in why3-papers/www)

320
* produce the Why3 part of ProVal gallery
321
  -> add also a tar.gz and a ZIP file of it (this is done by doing
MARCHE Claude's avatar
MARCHE Claude committed
322
  "make gallery-files" in the sources of the web pages)
MARCHE Claude's avatar
MARCHE Claude committed
323 324 325 326 327 328
* 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 ==

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

331
* DONE appliquer les changements de syntaxe des programmes dans la doc : aussi bien dans le tutorial que dans la BNF des manpages
332 333


334
* DONE Sortie PVS, avec mecanisme de realization
335

MARCHE Claude's avatar
MARCHE Claude committed
336
* DONE mettre au propre les loc des fichiers de sessions, en particulier
MARCHE Claude's avatar
MARCHE Claude committed
337 338
  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
339

340 341
* DONE sessions: mettre la dtd sur le web et changer l'entête des sessions pour qu'elles
   pointent dessus
342 343


344
* DONE (PRIORITAIRE) Coq output
345 346 347 348 349 350
 - 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

351
* DONE (PRIORITAIRE), JCF et ANDREI, clone de module
352 353 354 355 356 357 358 359 360 361 362 363 364 365
 - 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
366 367 368 369 370 371 372 373 374
==================== 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
375
  o co-inductive predicates
MARCHE Claude's avatar
MARCHE Claude committed
376 377
  o new option -e for "why3session latex" allows to specify when to
    split tables in parts
MARCHE Claude's avatar
MARCHE Claude committed
378 379 380 381
  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.
382
  o [Provers] support for Z3 4.0
MARCHE Claude's avatar
MARCHE Claude committed
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401

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:
402
 - add tag 0.73 to the git repository
403 404
 - do not forget to push it using git push --tags

MARCHE Claude's avatar
MARCHE Claude committed
405 406
* put on the web page
 - why3-0.73.tar.gz
407 408 409 410 411 412
 - 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
413
    Note: check that URL of API doc is correct in doc/api.tex line 9.
414 415 416 417
     (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
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
 - 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
438
 - DELAYED document co-inductive predicates
MARCHE Claude's avatar
MARCHE Claude committed
439 440
 - DONE (CLAUDE) revoir documentation du smoke detector

MARCHE Claude's avatar
MARCHE Claude committed
441 442
==================== Roadmap for release 0.72 ========================

443
== New Features to announce ==
MARCHE Claude's avatar
MARCHE Claude committed
444

445 446 447 448 449 450
* 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
451
* Improved IDE:
452
 - left scrollbar, selection of shown or hidden provers, font enlargement
453 454
 - integration of the support for prover upgrade
 - support for selection of alternate editors
455 456
* Complete support for limiting provers' memory usage
* Improved support of Microsoft Windows OS
MARCHE Claude's avatar
MARCHE Claude committed
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
* 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
475 476
 - standard library online, using why3doc (make stdlibdoc),
   to http://why3.lri.fr/stdlib/
477
 - API doc, produced using ocamldoc (make apidoc), to http://why3.lri.fr/api/
MARCHE Claude's avatar
MARCHE Claude committed
478
    Note: check that URL of API doc is correct in doc/api.tex line 9.
479
 - update the main HTML page (sources are in why3-papers/www)
MARCHE Claude's avatar
MARCHE Claude committed
480

MARCHE Claude's avatar
MARCHE Claude committed
481 482 483 484
* 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
485
* Announce the why3 tactic on Coq Club
MARCHE Claude's avatar
MARCHE Claude committed
486

MARCHE Claude's avatar
MARCHE Claude committed
487 488
== TODOs ==

489

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

492 493 494
* DONE Document the Coq plugin and tactic
** DONE option timelimit <n>
** DONE renommer "coq-plugin" en "coq-tactic"
495

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

498
* DONE (CLAUDE) Ajouter page provers sur le site web why3
MARCHE Claude's avatar
MARCHE Claude committed
499
** !TODO! relire
500

MARCHE Claude's avatar
MARCHE Claude committed
501
* Documentation
MARCHE Claude's avatar
MARCHE Claude committed
502

503
 - DONE traiter les \todo :
504

505 506 507
 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}
508 509


510 511 512
 - (ANDREI) complete technical.tex: section "Drivers of external
   provers"

513
 - DONE (GUILLAUME) Realisations Coq, comment fait l'utilisateur pour faire
MARCHE Claude's avatar
MARCHE Claude committed
514 515 516 517 518 519 520 521
   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
522
   DONE remplacer le ":" par " " (Arg.Tuple)
523

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

527
   . DONE Lors d'un replay, le dialogue "replace proof" apparait un nombre
MARCHE Claude's avatar
MARCHE Claude committed
528 529 530 531
     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...)

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

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

539
* DONE permettre d'utiliser emacs/proof general a la place de coqide depuis
MARCHE Claude's avatar
MARCHE Claude committed
540
  why3ide
541
*** DONE allow to choose which one the IDE Preferences
542

MARCHE Claude's avatar
MARCHE Claude committed
543
* (CLAUDE) why3session
544
 - DONE passe sur la documentation ecrite par Francois reecrite par Guillaume
545
 - DONE "why3replayer -latex" remplacé par "why3session latex"
546 547
 - DONE "why3html" remplacé par "why3session html"
 - DONE "why3stats" (src/ide/stats.ml) remplacé par "why3session info --stats"
MARCHE Claude's avatar
MARCHE Claude committed
548

549
* (JCF) ameliorer why3doc
550
 - DONE rajouter la production des liens
551
 - DONE produire un index.html
MARCHE Claude's avatar
MARCHE Claude committed
552

553
* DONE provers
MARCHE Claude's avatar
MARCHE Claude committed
554 555 556 557 558 559 560 561
 - 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
562

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

566
* DONE (CLAUDE) IDE:
MARCHE Claude's avatar
MARCHE Claude committed
567
 - DONE enlarge font (menu + shortcut Ctrl-+)
568
 - DONE Ctrl-A to select all rows
MARCHE Claude's avatar
MARCHE Claude committed
569 570 571 572
 - 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
573 574
* DONE (FRANCOIS) move Session module and its dependencies into the
  Why3 library
MARCHE Claude's avatar
MARCHE Claude committed
575 576 577 578 579
 - 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
580

MARCHE Claude's avatar
MARCHE Claude committed
581
======================= Roadmap for release 0.71 ========================
MARCHE Claude's avatar
MARCHE Claude committed
582

MARCHE Claude's avatar
MARCHE Claude committed
583
* DONE Final preparation:
MARCHE Claude's avatar
MARCHE Claude committed
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
** put on the web page
*** why3-0.71.tar.gz
*** manual in PDF: check that macro \todo is commented out
    in ./macros.tex
*** API doc in HTML (suggestion: http://why3.lri.fr/api/)
    Note: check that URL of API doc is correct in doc/api.tex line 9.
** What to put in the announcement:
*** traceability from front-ends work
    (see Krakatoa and Jessie of the next release 2.30 of Why2)
*** many new examples in examples/ and examples/programs
*** significantly improved efficiency of WP calculus
*** improved method for matching old and new goals in proof sessions
*** several bug fixes
*** see also the file CHANGES
** The last commit:
599
*** DONE increment the magic number in config
MARCHE Claude's avatar
MARCHE Claude committed
600
*** add a tag to the git repository
601
*** The next commit : increment why3 version
MARCHE Claude's avatar
MARCHE Claude committed
602

603 604 605
* misc
** DONE fix bug with term shapes, not taking triggers into account
** DONE remove prover coq-realize
MARCHE Claude's avatar
MARCHE Claude committed
606

MARCHE Claude's avatar
MARCHE Claude committed
607 608 609 610 611 612 613 614 615 616
* prover support
** DONE test/debug TPTP output, make Vampire work

* IDE:
** saving session
   * DONE add a "cancel" choice in the "ask" window

* DONE replayer: don't replay a goal that has changed, just display as an
  unsuccessful replay

MARCHE Claude's avatar
MARCHE Claude committed
617 618 619
* DONE reload: improve matching of new and old goals by use a kind a distance
  between some notion of shape of a goal

MARCHE Claude's avatar
MARCHE Claude committed
620
=== Roadmap for third release 0.70, july 2011 ========================
621

622 623
* Final preparation: put on the web page
** why3-0.70.tar.gz
624
** DONE manual in PDF: check that macro \todo can be commented out
625
   from ./macros.tex
626 627
** API doc in HTML (suggestion: http://why3.lri.fr/api/)
   Note: check that URL of API doc is correct in doc/api.tex line 9.
MARCHE Claude's avatar
MARCHE Claude committed
628 629 630 631 632 633
** What to put in the annoucement
   - WhyML VC generator to prove programs
   - new tool why3replayer
   - incompatible changes in syntax: function, predicate, and, or
   - session database in XML format instead of sqlite3
   - threads problem in IDE solved (by not using threads anymore)
MARCHE Claude's avatar
MARCHE Claude committed
634
   - IDE: not necessary to exit to change the input file: just use "reload"
635

636
* The last commit (A):
637
  ** DONE increment the magic number in config
638 639
  ** add a tag to the git repository
  ** The next commit : increment de why3 version
640

641 642
* DONE Distribution of examples: we should distribute those who have an xml file
  under git, and distribute the XML and Coq proofs (JC)
MARCHE Claude's avatar
MARCHE Claude committed
643

644 645
* DONE document "Make obsolete" (A+C)

646
* DONE update IDE section of starting.tex (C)
647

648
* DONE update doc for why3replayer
MARCHE Claude's avatar
MARCHE Claude committed
649

MARCHE Claude's avatar
MARCHE Claude committed
650 651 652
* DONE fix bug 12934 : Coq syntax
  https://gforge.inria.fr/tracker/index.php?func=detail&aid=12934&group_id=2990&atid=10293

653
* DONE document new IDE features (C)
MARCHE Claude's avatar
MARCHE Claude committed
654

655 656
* DONE doc: citer l'article Boogie 2011 quelque part

Andrei Paskevich's avatar
Andrei Paskevich committed
657 658 659 660 661
* DONE deplacer le bouton "Cancel" dans le menu "tools",
  le renommer en "make obsolete"

* DONE Check if remark in doc/api.tex line 80 is still valid (A)

662 663
* DONE put an up-to-date use_api.ml in the manual (C)

664 665 666 667 668 669
* DONE enlever les caracteres de tab des sources
  et les caracteres latin1 (A)

* DONE faire tourner headache pour refabriquer les headers (A)
  ** dans gappa.ml : ajouter Guillaume en dessous de l'entete

670 671 672 673
* DONE Rendre optionnel la question "would you like to save the session ?"
   (C) -> 3-state options (Yes/No/ask) dans la config
  + DONE dans le menu "file" : "save session" sans raccourci clavier

674
* DONE desactiver "Save" (et editable=false dans la fenetre)
675

676 677
* DONE mettre "Quit" en dernier (C)

678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
* DONE checkout frais, compilation (local ou non) et make bench chaque nuit sur moloch
  (?)

* DONE IDE: reload
  (claude)

* DONE BD : se passer de sqlite3
  (Claude)
  Solution: un unique fichier XML, qui est ecrit mais pas
  tres souvent (pas plus d'une fois par seconde)
  ne pas oublier neanmoins de mettre une action dans Timeout
  qui enregistre au bout d'un moment
  pb: n'est pas independant de l'IDE, peut-on faire un module
  independant de l'IDE ? qui serait utilisé par why3bench ?

* DONE IDE: avoir des transformations non codees en dur
  (Claude d'abord)

* DONE Bug des md5
  (Claude. pas reproductible ? Pb de duplication des buts ?)
MARCHE Claude's avatar
MARCHE Claude committed
698

699
* DONE IDE: no more threads
MARCHE Claude's avatar
MARCHE Claude committed
700

701 702 703 704 705
* DONE proof replay
  ** DONE IDE: replay all obsolete but previously successful proofs
  ** DONE in why3replay in whybench
  ** DONE add replay of existing proofs in "make bench" to detect regression
  ** DONE add automatic recompilation, install and bench every night on moloch
Jean-Christophe Filliatre's avatar
Jean-Christophe Filliatre committed
706

707
* DONE IDE: implement "inline" (use transformation inline_goal)
Jean-Christophe Filliatre's avatar
Jean-Christophe Filliatre committed
708
  ** problem 1: detect that transformation did nothing
MARCHE Claude's avatar
MARCHE Claude committed
709
  ** DONE problem 2: reimport from db does apply inline correctly
MARCHE Claude's avatar
MARCHE Claude committed
710

711 712
* DONE IDE: debug "remove" et "clean" qui provoquent des segfaults !!

Jean-Christophe Filliatre's avatar
Jean-Christophe Filliatre committed
713 714
* IDE: ajouter "invalid" comme cas de resultats de preuve
  (utiliser call_provers.proof_result dans gmain)
715
  DONE
MARCHE Claude's avatar
MARCHE Claude committed
716 717


718
=== Roadmap for second release 0.64 ========================================
719

Jean-Christophe Filliatre's avatar
Jean-Christophe Filliatre committed
720 721
* fix local installation
  ** fix local executables names (DONE)
722

Jean-Christophe Filliatre's avatar
Jean-Christophe Filliatre committed
723 724 725 726 727 728 729
* fix problems with .why.conf (DONE)
  ** if we distribute the current state, users who already have a ~/.why.conf
     will get a error message because of missing loadpath to modules
     Done? - the magic number will force to not use the old ~/.why.conf of
             the user
  ** generally speaking, we should rethink the design of that .why.conf: avoid
     absolute paths,
730
     Partially done - libdir, datadir, loadpath, ... are not written in
Jean-Christophe Filliatre's avatar
Jean-Christophe Filliatre committed
731
     why.conf if they correspond to the default value.
732 733


734
* IDE, file names in DB: use only file names relative to the db file
735
  DONE
736

Jean-Christophe Filliatre's avatar
Jean-Christophe Filliatre committed
737
=== Roadmap for December 2010 ================================================
MARCHE Claude's avatar
MARCHE Claude committed
738 739 740

== Documentation ==

MARCHE Claude's avatar
MARCHE Claude committed
741
1 Introduction (done: suppressed)
742
2 getting started (Claude: done, to be read by others)
MARCHE Claude's avatar
MARCHE Claude committed
743
3 Syntax, tutorial (done: Andrei)
744
4 tutorial for API:
745
** build a task (Claude: done, to be read by others)
MARCHE Claude's avatar
MARCHE Claude committed
746 747 748 749 750
** call a prover (Claude: done, to be read by others)
** apply a transformation (a completer plus tard)
** develop a new transformation (a completer plus tard)
5 syntax reference (a completer plus tard par typage et semantique)
6 Standard lib of theories:
751
  (Claude: done, although quite sparse, to be read by others)
752
7 Manpages
753 754
7.1 Compilation, Installation (done)
7.2 external provers (done)
MARCHE Claude's avatar
MARCHE Claude committed
755 756 757 758
7.3 why3config (done)
7.4 why3 (done)
7.5 whyml (done)
7.6 IDE (done)
François Bobot's avatar
François Bobot committed
759
7.7 whybench (done, to be read by others)
MARCHE Claude's avatar
MARCHE Claude committed
760 761 762
7.8 why.conf (done)
7.9 drivers (to be done later)
7.10 transformations (done)
763
8 API: Andrei + Francois
764
  (should we really add that in the doc ?)
MARCHE Claude's avatar
MARCHE Claude committed
765 766
** on remplace par la version HTML a mettre sur la forge INRIA (Francois)
** TODO: mettre un titre au HTML engendré
MARCHE Claude's avatar
MARCHE Claude committed
767 768 769 770 771

== IDE ==

(Claude)

MARCHE Claude's avatar
MARCHE Claude committed
772 773 774 775
* database, session save and restore (done)
* Coq output (done)
* Gappa output (done)
* debug hide goals (TODO)
776
* add "context" options (partially done)
MARCHE Claude's avatar
MARCHE Claude committed
777
** semantics not clear, should be clarified, documented and
778
   implemented accordingly
MARCHE Claude's avatar
MARCHE Claude committed
779
* add transf "inline goal" (to be done later)
780
* add button "remove"
MARCHE Claude's avatar
MARCHE Claude committed
781 782 783
** removing goals: done
** removing transformation: done, but subgoals stay in db (not critical)
* add button "replay" (to be done later)
784
** semantics: replay obsolete proofs
MARCHE Claude's avatar
MARCHE Claude committed
785 786 787

== Misc ==

MARCHE Claude's avatar
MARCHE Claude committed
788 789 790
* README (done)
* INSTALL (done)
* LICENSE (done)
MARCHE Claude's avatar
MARCHE Claude committed
791
* OCAML-LICENSE (done)
792
* TODO: licence pour les boomy icons
MARCHE Claude's avatar
MARCHE Claude committed
793

MARCHE Claude's avatar
MARCHE Claude committed
794 795
* debuguer cpulimit pour gappa (pb de return code)

MARCHE Claude's avatar
MARCHE Claude committed
796
* option --version a tous les executables (done, except IDE: bug 11604)
797
** + affichage dans l'IDE (done)
MARCHE Claude's avatar
MARCHE Claude committed
798
* Builtin arrays in provers (done)
MARCHE Claude's avatar
MARCHE Claude committed
799
* make install (done)
MARCHE Claude's avatar
MARCHE Claude committed
800
* make distrib (done)
MARCHE Claude's avatar
MARCHE Claude committed
801
* "make -j" (done)
802
* META for ocamlfind (done)
MARCHE Claude's avatar
MARCHE Claude committed
803
* headers (done)
MARCHE Claude's avatar
MARCHE Claude committed
804

MARCHE Claude's avatar
MARCHE Claude committed
805 806 807 808 809 810
== Mails announcement ==

----------------------- Why-discuss list ---------------------------

We are happy to announce the first public release of Why3, also known
as the Why platform next generation. It is a new project, independent
MARCHE Claude's avatar
MARCHE Claude committed
811
from Why versions 2.xx.
Andrei Paskevich's avatar
Andrei Paskevich committed
812 813

The home web page of Why3 is http://why3.gforge.inria.fr, where you
814
can find the source distribution and the manual. See the manual for
MARCHE Claude's avatar
MARCHE Claude committed
815 816
installation instructions and contact information.

MARCHE Claude's avatar
MARCHE Claude committed
817
The main new features with respect to Why 2.xx are the following.
MARCHE Claude's avatar
MARCHE Claude committed
818 819 820 821

1) Completely redesigned input syntax for logic declarations

* new syntax for terms and formulas
Andrei Paskevich's avatar
Andrei Paskevich committed
822 823 824
* enumerated and algebraic data types, pattern matching
* recursive definitions of logic functions and predicates,
  with termination checking
MARCHE Claude's avatar
MARCHE Claude committed
825
* inductive definitions of predicates
Andrei Paskevich's avatar
Andrei Paskevich committed
826 827
* declarations are structured in components called "theories",
  which can be reused and instantiated
MARCHE Claude's avatar
MARCHE Claude committed
828 829 830 831 832 833 834

2) More generic handling of goals and lemmas to prove

* concept of proof task
* generic concept of task transformation
* generic approach for communicating with external provers

Andrei Paskevich's avatar
Andrei Paskevich committed
835
3) Source code organized as a library with a documented API,
MARCHE Claude's avatar
MARCHE Claude committed
836
to allow access to Why3 features programmatically.
MARCHE Claude's avatar
MARCHE Claude committed
837 838 839 840 841 842

4) GUI with new features w.r.t. the former GWhy

* session save and restore
* prover calls in parallel
* splitting, and more generally applying task transformations, on demand
843
* ability to edit proofs for interactive provers (Coq only for the moment)
MARCHE Claude's avatar
MARCHE Claude committed
844 845 846 847 848 849 850 851
  on any subtask

5) Extensible architecture via plugins

* users can define new transformations
* users can add connections to additional provers


Andrei Paskevich's avatar
Andrei Paskevich committed
852
Beware that some Why features are not yet available in Why3:
MARCHE Claude's avatar
MARCHE Claude committed
853 854

* There is a VC generator distributed in Why3 in an experimental stage
Andrei Paskevich's avatar
Andrei Paskevich committed
855 856
  and intentionally undocumented in the current documentation (the input
  syntax for programs may change a lot in the future).
MARCHE Claude's avatar
MARCHE Claude committed
857 858 859 860

* There is no front-end for other languages like C or Java. However,
  the last release Why 2.28 is able to use Why3 as a back-end

MARCHE Claude's avatar
MARCHE Claude committed
861 862 863 864 865 866 867 868
Notice that Why3 is expected to replace Why2 in the future. As such,
it is the project where improvements and new features will be
implemented. As this is the first public release of Why3, it is likely
that missing features, and possibly bugs, will raise soon. Please
report those in the bug tracker, we will do our best to fix them and
provide new releases in a short time.


MARCHE Claude's avatar
MARCHE Claude committed
869 870 871 872 873 874 875 876



--------------------- Frama-C list ----------------------------


The first release of Why3, also known as the Why platform next
generation, is publicly available. Why3 is a new project, independent
MARCHE Claude's avatar
MARCHE Claude committed
877
from Why. The detailed announcement is attached below.
MARCHE Claude's avatar
MARCHE Claude committed
878 879 880 881 882 883 884 885

The Jessie plugin of the Why release 2.28 has the ability to use Why3
as back-end. You must install both Why 2.28 and Why3 for this to work.

Using the Why3 GUI on a C file is done as follows
  frama-c -jessie -jessie-atp why3ide <file>.c
(You can also run it in batch mode using
  frama-c -jessie -jessie-atp why3 <file>.c
886
and process the generated Why3 file "<file>.jessie/why/<file>_why3.why"
MARCHE Claude's avatar
MARCHE Claude committed
887 888 889 890 891 892 893
with Why3 batch tools).

The main new features of interest in the GUI are

* new provers available
* calling provers in parallel
* splitting on demand
MARCHE Claude's avatar
MARCHE Claude committed
894
* ability to call Coq on a given VC to provide a proof script. Incidentally,
MARCHE Claude's avatar
MARCHE Claude committed
895
  this feature can be used to analyse the VC to understand why it is
896
  not proved automatically.
MARCHE Claude's avatar
MARCHE Claude committed
897 898 899 900 901 902 903 904
* proof session saved and restored at startup

Any question, remark or bug report concerning only Why3 should be done
using the Why3 public discussion list and bug tracker.




MARCHE Claude's avatar
MARCHE Claude committed
905