Skip to content

Commit d41591b

Browse files
author
Mark R. Tuttle
committed
Make three README files format with doxygen/pandoc
* Add README files of doc/API and src/goto-harness * Add surround markdown horizontal rule --- with blank lines for pandoc parsing (pandoc will try to interpret text following --- as yaml).
1 parent dd1b0e0 commit d41591b

File tree

3 files changed

+22
-7
lines changed

3 files changed

+22
-7
lines changed

doc/API/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# CProver APIs
2+
3+
* [piped_process](util/piped_process.md)

src/goto-harness/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
\ingroup module_hidden
2+
\defgroup goto-harness goto-harness
3+
4+
# Folder goto-harness
5+
6+
`goto-harness` generates a proof harness for a function under test.
7+
It constructs functions that set up an appropriate environment before
8+
calling function. This is most useful when trying to analyze an
9+
isolated unit of a program.

src/goto-symex/README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ At a later stage, BMC will convert the generated SSA steps into an
2525
equation that can be passed to the solver.
2626

2727
---
28+
2829
\section symbolic-execution Symbolic Execution
2930

3031
In the \ref goto-symex directory.
@@ -35,13 +36,13 @@ In the \ref goto-symex directory.
3536

3637
\dot
3738
digraph G {
38-
node [shape=box];
39-
rankdir="LR";
40-
1 [shape=none, label=""];
41-
2 [label="goto conversion"];
42-
3 [shape=none, label=""];
43-
1 -> 2 [label="goto-programs, goto-functions, symbol table"];
44-
2 -> 3 [label="equations"];
39+
node [shape=box];
40+
rankdir="LR";
41+
1 [shape=none, label=""];
42+
2 [label="goto conversion"];
43+
3 [shape=none, label=""];
44+
1 -> 2 [label="goto-programs, goto-functions, symbol table"];
45+
2 -> 3 [label="equations"];
4546
}
4647
\enddot
4748

@@ -144,6 +145,7 @@ all the paths together, so the additional path-exploration loop is
144145
skipped over.
145146

146147
---
148+
147149
\section static-single-assignment Static Single Assignment (SSA) Form
148150

149151
**Key classes:**
@@ -253,6 +255,7 @@ Seminal paper on SSA:
253255
> (pp. 12-27). ACM.
254256
255257
---
258+
256259
\section counter-example-production Counter Example Production
257260

258261
In the \ref goto-symex directory.

0 commit comments

Comments
 (0)