Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for :dumptests via a new section in the High Assurance chapter of Programming in Cryptol Book #1760

Merged
merged 3 commits into from
Oct 2, 2024

Conversation

mccleeary-galois
Copy link
Contributor

Closes #611

…ramming Cryptol book for generating test vectors using :dumptests.

An example is also given using SHA2 256.
Copy link
Contributor

@marsella marsella left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this! I have a few questions & clarifications.

docs/ProgrammingCryptol/highAssurance/HighAssurance.tex Outdated Show resolved Hide resolved
docs/ProgrammingCryptol/highAssurance/HighAssurance.tex Outdated Show resolved Hide resolved
docs/ProgrammingCryptol/highAssurance/HighAssurance.tex Outdated Show resolved Hide resolved
docs/ProgrammingCryptol/highAssurance/HighAssurance.tex Outdated Show resolved Hide resolved
docs/ProgrammingCryptol/highAssurance/HighAssurance.tex Outdated Show resolved Hide resolved
docs/ProgrammingCryptol/highAssurance/HighAssurance.tex Outdated Show resolved Hide resolved
docs/ProgrammingCryptol/highAssurance/HighAssurance.tex Outdated Show resolved Hide resolved
…ol specs.

Keep example as a polymporphic function using multiple inputs and a non Bit output to show that it can handle that case now.

Also fix up some minor typos and clarify a few sentences.
@mccleeary-galois mccleeary-galois marked this pull request as ready for review October 1, 2024 20:14
Copy link
Contributor

@marsella marsella left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here are some nitpicky little suggestions on wording

docs/ProgrammingCryptol/highAssurance/HighAssurance.tex Outdated Show resolved Hide resolved
:dumptests <results file> <function>
:dumptests results.txt myFunction
\end{Verbatim}
The results file will contain a tab delimited file in which the first column contains the output, and each column after contains the inputs to the function in order.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggested rephrase: "tab delimited file" -> "tab delimited table"? I don't love the phrasing of "the file contains a file" but I'm struggling to find a better word.

docs/ProgrammingCryptol/highAssurance/HighAssurance.tex Outdated Show resolved Hide resolved
docs/ProgrammingCryptol/highAssurance/HighAssurance.tex Outdated Show resolved Hide resolved
Use different size output to reiterate that the output is first in the results of :dumptests.

Some minor rewording and wordsmithing.
Copy link
Contributor

@marsella marsella left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for iterating!

@mccleeary-galois mccleeary-galois merged commit b74e5a6 into master Oct 2, 2024
49 checks passed
@mccleeary-galois mccleeary-galois deleted the issue-611 branch October 2, 2024 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

dumptests undocumented
3 participants