Skip to content

Commit 4fcbd37

Browse files
author
Thomas Kiley
committed
Add folder readme for doc/assets
Includes dependencies for builing the xml_spec LaTeX, as well as running the trace through the specification.
1 parent 4049f15 commit 4fcbd37

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

doc/assets/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
This folder contains resources for the documentation.
2+
3+
# XML Spec
4+
5+
The folllowing files relate to the specification of the XML trace output when using the `--xml-ui` flag.
6+
7+
## xml_spec.xsd
8+
The`xml_spec.xsd` file is an XSD specification of the trace. You can validate an
9+
output xml file from CBMC using the following invocation:
10+
11+
```bash
12+
$ cbmc --xml-ui main.c | \
13+
xmllint --schema xml_spec.xsd --xpath "cprover/result/goto_trace" -
14+
```
15+
16+
## xml_spec.tex
17+
18+
This is a LaTeX document describing the specification of the trace. It can be compiled to pdf using:
19+
20+
```bash
21+
$ pdflatex -shell-escape xml_spec.tex
22+
```
23+
24+
This requires:
25+
26+
- texlive-latex-base
27+
- texlive-latex-extra (for minted package)

0 commit comments

Comments
 (0)