cryptol/docs/ProgrammingCryptol
Ben Selfridge 861e9e9651
Feature/docs checking (#976)
* Adds a stub executable to cabal file for checking docs

* [WIP] Adds check-exercises executable

A program that checks that the exercises in Programming Cryptol actual work when
executed against an Cryptol REPL. Instead of using \begin{Verbatim}, we use
\begin{REPL} in both the exercise and the answer, which is rendered the same but
gets checked by this program.

This is a WIP -- we still need to do a number of things, including (but not
limited to):

* Move the "REPL" macro out of CrashCourse.tex and into some including latex
  file
* Change many of the "Verbatim"s into "REPL"s to test if this approach works in
  general

* Several updates

* Moves REPL command definitions into main latex file

* Generalizes repl commands

* Several improvements:

* documentation of CheckExercises.hs
* factoring out addReplData, addReplin, addReplout, nextLine functions
* took the IO out of P monad (shouldn't have been there)
* worked on annotating repls for many exercises/examples in crash course

* Adds a README for check-exercises

* Uses cryptol's -e option to detect errors

* updates ProgrammingCryptol.pdf

* Fixes main function

After changing to use the -e option to detect errors, I used cabal v2-exec which
apparently does not rebuild anything, but I thought it did. This just fixes the
code so it builds again.
2020-11-20 16:53:36 -08:00
..
aes Fix typo in definition of distributed property of gf28DotProduct 2020-06-18 17:37:17 -07:00
appendices Update documentation with info about floats + fractional literals 2020-07-14 15:36:37 -07:00
basic Initial import from internal repo 2014-04-17 15:34:25 -07:00
bib Initial import from internal repo 2014-04-17 15:34:25 -07:00
classic Use autoref command and lowercase section refs consistently in the book. 2018-07-19 18:00:17 -07:00
conclusion Initial import from internal repo 2014-04-17 15:34:25 -07:00
cover incorporating typos and other improvements to docs 2016-04-27 11:52:09 -07:00
crashCourse Feature/docs checking (#976) 2020-11-20 16:53:36 -08:00
des Initial import from internal repo 2014-04-17 15:34:25 -07:00
enigma Correct definition of rotate in Section 3.3 2020-06-18 17:44:38 -07:00
highAssurance Documentation updates (#779) 2020-06-30 10:58:25 -07:00
main Feature/docs checking (#976) 2020-11-20 16:53:36 -08:00
misc Update old cryptol-1 syntax in example code. 2019-06-20 10:54:06 -07:00
preface Tweak a few things for 2.9.0 (#833) 2020-07-28 08:41:27 -07:00
prims Update documentation and reference interpreter 2020-09-29 14:55:05 -07:00
sha Initial import from internal repo 2014-04-17 15:34:25 -07:00
technicalities Documentation updates (#779) 2020-06-30 10:58:25 -07:00
title final tweaks to the book 2014-04-24 10:53:00 -07:00
tools Remove obsolete cvs-era $Header$ keywords. 2018-03-22 13:33:12 -07:00
utils Update documentation with info about floats + fractional literals 2020-07-14 15:36:37 -07:00
.gitignore Initial import from internal repo 2014-04-17 15:34:25 -07:00
Makefile Don't add an extra copy of Programming Cryptol (#970) 2020-11-17 09:26:03 -08:00