Commit Graph

215 Commits

Author SHA1 Message Date
Bretton
2f4b821eab FFI: Add docs for nested sequences 2022-08-17 14:50:26 -07:00
Bretton
d933fa6307 FFI: Improve docs 2022-08-11 19:45:50 -07:00
Bretton
60a342ad9f FFI: Improve docs 2022-08-11 14:56:43 -07:00
Bretton
0bc3bb74c5 FFI: Add docs 2022-08-11 12:26:48 -07:00
Iavor Diatchki
9d68dc91ae Add a note that the documentation of parameterized modules
is about the upcoming version
2022-08-04 14:40:33 +03:00
Iavor Diatchki
c8e499cc1e Improvements to reference manual 2022-08-04 14:37:15 +03:00
Iavor Diatchki
fcd5578ee6 Fix documentation 2022-02-23 14:39:20 -08:00
Iavor Diatchki
8b97cf4a8a Fix typo 2021-10-18 11:47:16 -07:00
Iavor Diatchki
6bb573eef3 Add the basic Cryptol classes 2021-10-18 10:21:33 -07:00
Iavor Diatchki
c03a590c34 Fix the URL 2021-10-18 09:49:38 -07:00
Iavor Diatchki
638525fd64 Disable jekyll, as it ignores files starting with _ 2021-10-18 09:47:08 -07:00
Iavor Diatchki
621e9a8acd Add a redirect to reference manual 2021-10-18 09:42:32 -07:00
Iavor Diatchki
0109f9ce83 Add a link to the Reference Manual index 2021-10-18 09:25:03 -07:00
Iavor Diatchki
a7e4f32a30 Generated HTML for manual 2021-10-18 09:22:47 -07:00
Iavor Diatchki
ae904687cb Ignore build stuff 2021-10-18 09:15:03 -07:00
Iavor Diatchki
6d2e32d6f4 Testing github pages 2021-10-18 09:11:52 -07:00
Brian Huffman
869deb1354 Update expected test output.
Some error messages changed due to the new definition in Cryptol.cry.
2021-09-10 20:08:43 -07:00
Brian Huffman
b9f97e7790 Update expected output for check-docs. 2021-09-02 20:30:55 -07:00
Rob Dockins
e742d24a14 Update documentation 2021-08-06 15:04:38 -07:00
Rob Dockins
d740442035 Update documenetation with new enumeration forms,
and update the reference semantics.
Other minor documentation fixes and updates.
2021-07-20 17:01:50 -07:00
Rob Dockins
4d5d66ff27 update docs again 2021-06-30 16:51:54 -07:00
Rob Dockins
0778fd8ff2 Update "ProgrammingCryptol"
Minor output changes in the exercises are required.
2021-06-30 10:05:39 -07:00
Iavor Diatchki
c62d921fb3 More docs 2021-04-30 15:43:14 -07:00
Iavor Diatchki
402c0cc256 Mess around with html teams 2021-04-30 15:42:49 -07:00
Iavor Diatchki
7a98ab5b9b Make a table for operator precedences 2021-04-30 12:00:46 -07:00
Iavor Diatchki
29eefbc09d A shpynx temaplte for a reference manual 2021-04-29 16:47:54 -07:00
Rob Dockins
cc8822f736 Update reference implementation and documentation 2021-04-13 10:27:17 -07:00
Rob Dockins
23a0f0f260 Update documentation PDFs 2021-04-06 09:48:41 -07:00
Rob Dockins
eb9d3e900d Update book exercise output 2021-03-02 17:18:36 -08:00
Rob Dockins
6b784b11ec Typo
Fixes #1039
2021-02-17 16:13:04 -08:00
Rob Dockins
0abde1e55e Update option names in documentation 2021-02-11 16:27:04 -08:00
Iavor Diatchki
8796390244 Add name etc. 2021-01-25 08:33:11 -08:00
Iavor Diatchki
c9307065b9 A short talk on the new parameterized moduels design 2021-01-14 15:43:04 -08:00
Rob Dockins
301c74cb8f Docs typos 2021-01-12 17:00:24 -08:00
Rob Dockins
976468dce7 Fix typos 2021-01-12 11:20:57 -08:00
Rob Dockins
600f43b5f0 Update the Programming Cryptol book with documentation about newtypes. 2021-01-12 11:19:53 -08:00
Rob Dockins
557b928caf Update syntax and semantics documents with newtype changes 2021-01-12 11:18:58 -08:00
Ben Selfridge
7489dbd52e
Doc fixes (#1016)
* Updates all the examples in CrashCourse.tex up to the functions section

This adds more REPL annotations for the exercise checker in the Programming
Cryptol book. There is still more work needed to support many of the examples in
the functions section (and presumably the rest of the book as well), so I think
this is a logical stopping point for now until we add a feature that lets you
write out a file and load it into the repl.

* Updates ProgrammingCryptol.pdf wrt recent changes
2021-01-11 14:52:21 -08:00
Ben Selfridge
f45389b8cd Adds "replPrompt" command 2020-12-12 08:47:21 -08:00
Ben Selfridge
5c18b35523 Brings CrashCourse.tex up-to-date with respect to recent changes
Both in this branch and in master (which I'd previously missed).
2020-12-10 17:12:50 -08:00
Ben Selfridge
c78424334e Adds repl annotations for more of CrashCourse.tex 2020-12-09 16:15:17 -08:00
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
Aaron Tomb
692c814776
Don't add an extra copy of Programming Cryptol (#970)
Two different Makefiles each copied it and used different file names.

Closes #969.
2020-11-17 09:26:03 -08:00
Brian Huffman
97b967c8bd Update generated pdf. 2020-10-14 10:47:28 -07:00
Brian Huffman
36b8bd2e07 Fix miscellaneous typos in Syntax.md. 2020-10-13 11:09:51 -07:00
Brian Huffman
754c6ac59b Remove errant comma in exercise solution in the book. 2020-10-13 11:08:12 -07:00
Brian Huffman
33d6ae77b7 Fix description of lg2 in exercise answer in the book.
This is one of the errors mentioned in issue #931.
2020-10-13 11:06:52 -07:00
Brian Huffman
a23267fe3d More accurate descriptions for lg2 and width in book appendix.
Fixes #931.
2020-10-13 10:53:32 -07:00
Brian Huffman
e08cac3828 Remove redundant word "Size" in table of built-in type-level operators.
We have decided to avoid the term "size type" in favor of
"numeric type" (#597), and the word is uninformative in this
context anyway.
2020-10-13 10:39:25 -07:00
Rob Dockins
6b9a9f1294 Fix book typos 2020-09-29 21:50:30 -07:00