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

Initial SAW Manual Reorganization #2224

Merged
merged 21 commits into from
Feb 19, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
bb7842c
Manual: Reorder top-level sections.
ChrisEPhifer Feb 12, 2025
cdffd66
Manual: Demote 'direct-extraction' to subsection of 'loading-code'.
ChrisEPhifer Feb 12, 2025
edf4740
Rename introduction.md -> overview.md.
ChrisEPhifer Feb 12, 2025
af3e999
saw-user-manual/overview: Add recommended new sections to outline.
ChrisEPhifer Feb 12, 2025
4396e95
saw-user-manual/structure-of-sawscript: Add new section to outline.
ChrisEPhifer Feb 12, 2025
998cbc9
saw-user-manual/structure-of-sawscript: Move first simple example.
ChrisEPhifer Feb 12, 2025
6fa6b68
saw-user-manual/invoking-saw: Move content to appendix.
ChrisEPhifer Feb 12, 2025
e94f556
saw-user-manual/specification-based-verification: Revisit example.
ChrisEPhifer Feb 12, 2025
5d8c532
saw-user-manual/appendices: Make separate directory for appendices.
ChrisEPhifer Feb 12, 2025
8350a3a
appendices/glossary: Add an (empty) glossary to the appendices.
ChrisEPhifer Feb 12, 2025
d3e8558
saw-user-manual/appendices: Properly format REPL reference.
ChrisEPhifer Feb 12, 2025
251e486
saw-user-manual/cryptol-and-its-role-in-saw: Fix broken link.
ChrisEPhifer Feb 12, 2025
8e0c99b
saw-user-manual/appendices: Add stubs for additional appendices.
ChrisEPhifer Feb 12, 2025
c40828e
saw-user-manual: Place proofs about terms after term transformation.
ChrisEPhifer Feb 12, 2025
b539c46
saw-user-manual: Clean up some 'glue' text.
ChrisEPhifer Feb 12, 2025
6e37a47
doc: Update PDFs.
ChrisEPhifer Feb 12, 2025
d460fce
Merge branch 'master' into 2156-saw-user-manual-reorg
ChrisEPhifer Feb 18, 2025
b4feed5
saw-user-manual/specification-based-verification: Missing reference.
ChrisEPhifer Feb 18, 2025
2611825
manual/cryptol-and-its-role-in-saw: Note about Cryptol manual link.
ChrisEPhifer Feb 19, 2025
e83e61e
appendices: Replace REPL glossary entries with explicit references.
ChrisEPhifer Feb 19, 2025
3b0b6e2
manual/transforming-term-values: Update section transition language.
ChrisEPhifer Feb 19, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/saw-user-manual/creating-symbolic-variables.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Creating Symbolic Variables

The direct extraction process just discussed automatically introduces
The direct extraction process discussed previously introduces
symbolic variables and then abstracts over them, yielding a SAWScript
`Term` that reflects the semantics of the original Java, LLVM, or MIR code.
For simple functions, this is often the most convenient interface. For
Expand Down
4 changes: 2 additions & 2 deletions doc/saw-user-manual/loading-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,8 +213,8 @@ linking 11 mir files into <...>/example.linked-mir.json

## Direct Extraction

In the case of the `max` function described earlier, the relevant inputs
and outputs are immediately apparent. The function takes two integer
In many simple cases (such as the mathematical `max` function), the relevant
inputs and outputs are immediately apparent. The function takes two integer
arguments, always uses both of them, and returns a single integer value,
making no other changes to the program state.

Expand Down
3 changes: 2 additions & 1 deletion doc/saw-user-manual/the-term-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ will say more later about exactly what it means for two terms to be
equivalent, and how to determine whether two terms are equivalent.

Before exploring the `Term` type more deeply, it is important to
understand the role of the Cryptol language in SAW.
understand the role of the Cryptol language in SAW -- make sure to read
[that section of the manual](./cryptol-and-its-role-in-saw) before continuing.
2 changes: 1 addition & 1 deletion doc/saw-user-manual/transforming-term-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The three primary functions of SAW are _extracting_ models (`Term`
values) from programs, _transforming_ those models, and _proving_
properties about models using external provers. So far we've shown how
to construct `Term` values from Cryptol programs; later sections
to construct `Term` values from programs; later sections
will describe how to extract them from other programs. Now we show how
to use the various term transformation features available in SAW.

Expand Down
Loading