GaloisInc / cryptol

Cryptol: The Language of Cryptography
https://galoisinc.github.io/cryptol/master/RefMan.html
BSD 3-Clause "New" or "Revised" License
1.14k stars 126 forks source link

Update cryptol output in the "Programming Cryptol" book #523

Closed brianhuffman closed 6 years ago

brianhuffman commented 6 years ago

The book contains a lot of verbatim output, error messages, etc. which were copied from the cryptol REPL. Much of this text is now out of date. We should make a pass over the book to update all of the verbatim REPL output before the next official Cryptol release.

brianhuffman commented 6 years ago

A reminder: Make sure to update the generated ProgrammingCryptol.pdf in the repo when we prepare the next release.

atomb commented 6 years ago

This probably won't be a near-term possibility, but in the past I've sometimes set up documentation using markup and tools (usually custom to that particular document, though something general would be nice) that automatically run the program being documented and capture the current output. Would it be worth trying something like that here? In particular, Appendix A has a lot of output which will be somewhat tedious to update.

atomb commented 6 years ago

I made a pass over it, and I think everything's up to date, with several caveats:

atomb commented 6 years ago

I'm going to close this, as I think we've done what we need to for the 2.6.0 release. We could perhaps consider migrating to a more automatically-checked or automatically-updated version in the longer term.