Commit Graph

234 Commits

Author SHA1 Message Date
Owen Jones d1f2ad9762 Replace -> with → 2018-08-10 11:53:30 +01:00
Owen Jones 30d29b9255 Replace unicode arrows → with ascii ones -> 2018-08-10 10:58:17 +01:00
Owen Jones adb7ef05ae Minor fixes to documentation outline 2018-08-10 09:40:53 +01:00
Owen Jones 612b4f8887 Address review comments 2018-08-03 17:59:11 +01:00
Owen Jones 7233f9227d Rearrange everything into separate pages 2018-08-03 17:59:11 +01:00
Owen Jones 1cb3cdda60 Move other tools into a separate file 2018-08-03 17:59:11 +01:00
Owen Jones 82eefb7c2e Fix links between files 2018-08-03 17:59:11 +01:00
Owen Jones d9e690b51f Move folder walkthrough to a separate file
The CBMC Developer Guide now contains a link to that file.
2018-08-03 17:59:11 +01:00
Owen Jones 2939db443f Address review comments 2018-08-03 17:59:11 +01:00
Owen Jones 8d5cbcb064 Create CBMC developer guide documentation
Currently this is an outline - over time the various sections should
be filled in. I have moved some of the existing documentation into it
in the appropriate place.
2018-08-03 17:59:11 +01:00
Daniel Kroening acfea65cba __CPROVER_r_ok and __CPROVER_w_ok added to ANSI-C front-end 2018-07-30 19:06:04 +01:00
Daniel Kroening 1a7235defd use __CPROVER_size_t and __CPROVER_ssize_t for __CPROVER_POINTER_OBJECT/OFFSET 2018-05-25 07:24:28 +01:00
Hannes Steffenhagen 7952f2c216 Add option to generate function body to goto-instrument 2018-04-09 12:40:28 +01:00
Peter Schrammel d7efdd1ef5 Improve docs TOC structure 2018-03-23 13:06:58 +00:00
Peter Schrammel c1f9e34f80 Move SATABS references to separate from user manual 2018-03-22 22:22:44 +00:00
Peter Schrammel 42f9f36dcf Improve docs content layout and front page 2018-03-22 22:22:43 +00:00
Michael Tautschnig 590fc2dacc Make USE_DSTRING conditional and disable it in Ubuntu/Clang/DEBUG Travis job
This introduces a macro USE_STD_STRING that can be set to disable USE_DSTRING,
and thus the use of dstringt as the implementation of irep_idt. The
Ubuntu/Clang/DEBUG Travis stage sets this macro to avoid future changes breaking
the build when disabling USE_DSTRING.
2018-02-21 20:06:07 +00:00
Kareem Khazem 58f6dde12c [docs 5/5] Convert CBMC Guide to Markdown
The CBMC Guide (previously a TeX file) is now part of the Doxygen
codebase.
2017-07-10 12:48:38 +01:00
Kareem Khazem d86ede0f4b [docs 4/5] Add CBMC hacking tutorial
A practical tutorial on getting started with CProver development is
added and linked to from the front page. The tutorial contains an
overview of the codebase and a few preliminary programming exercises,
intended to give would-be CProver contributors an introduction to the
key data structures used throughout the codebase.
2017-07-10 12:47:49 +01:00
Kareem Khazem 3a58226cf4 [docs 3/5] Add per-directory high-level docs
This commit introduces a module.md file for several CProver directories.
Each of these is turned into a page under the Modules section in the
generated Doxygen documentation.

The intention is that developers wishing to contribute to one specific
aspect of CProver can get a high-level architectural overview of a
particular directory; the documentation describes the input to and
output from that directory, and introduces the main classes or entry
points.

By way of a "table of contents," the file cbmc/module.md contains a
diagram describing how each of the directories is invoked by CBMC in
order, and the nodes of the diagram hyperlink to the appropriate
documentation. The intention is that developers wishing to contribute to
CBMC as a whole can understand the entire process, from source files to
bug reports and counterexample production.

This documentation is derived from Mark Tuttle's notes on a talk given
by Michael Tautschnig.
2017-07-10 12:45:56 +01:00
Kareem Khazem c9144dca3d [docs 1/5] Port existing HTML manual to doxygen
* The existing HTML documentation under doc/html-manual has been
  converted to Markdown. This was done automatically using Pandoc, plus
  some manual work to give identifiers to sections and changing internal
  links to point to those sections with \ref.

* The Doxygen front page now contains some content: a link to the
  doxygen-ated HTML manual, and a note about the API documentation. The
  intention here is that the entire Doxygen site could be hosted
  publicly, serving both users of and contributors to CBMC from a single
  site.

* The doxyfile is updated to enable these changes.
2017-07-10 12:42:37 +01:00
Daniel Kroening 320722faf0 update highlight package 2017-05-30 10:23:30 +01:00
Daniel Kroening a304db6c41 update CBMC applications URL 2017-05-23 19:35:52 +01:00
Daniel Kroening fa47d992db various HTML fixes for the manual 2017-05-23 19:28:16 +01:00
Daniel Kroening 0bc21faf5c Merge branch 'master' of github.com:diffblue/cbmc 2017-05-22 16:41:19 +01:00
Daniel Kroening 9f2df28b31 W3C compliance fixes 2017-05-22 16:40:52 +01:00
Daniel Kroening 064f648002 beautify coverage table 2017-05-12 13:43:19 +01:00
Daniel Kroening 23e2eae07f beautify coverage table 2017-05-12 13:41:36 +01:00
Daniel Kroening b1e9fc083a Coverage Criteria 2017-05-12 13:34:18 +01:00
Daniel Kroening 9755f6f70a formatting 2017-05-12 13:20:45 +01:00
Daniel Kroening b321b4a007 a paragraph on __CPROVER_cover 2017-05-12 09:10:03 +01:00
Daniel Kroening 0f08b5874f __CPROVER_isinf heading 2017-05-12 09:03:05 +01:00
Daniel Kroening 79a95f7346 Merge pull request #300 from theyoucheng/case-study
adjusted the command line options for the pid controller case study
2017-04-03 14:16:09 +01:00
Robert (Jamie) Munro be697376c5 Normalise newlines at ends of files 2016-11-29 09:59:31 +00:00
Robert (Jamie) Munro d53dbf9560 Remove trailing whitespace from all lines 2016-11-29 09:58:36 +00:00
theyoucheng 60e2e0e0eb adjusted the command line for the pid controller case study with a better look output test suites 2016-11-10 12:30:00 +00:00
theyoucheng 455c36bb31 Refined the form of test suites generated for the PID controller. 2016-10-07 11:55:34 +01:00
theyoucheng 6266a20e02 Added the test suite for unwinding the loop 6 times in PID case study. 2016-09-30 22:53:38 +01:00
theyoucheng cf085a83f9 Added the test suite for unwinding the loop 6 times in PID case study. 2016-09-30 22:43:02 +01:00
theyoucheng 3267568b88 Clarified the inputs for the pid case study. 2016-09-30 15:24:14 +01:00
Daniel Kroening 7c9d3fc60d Random vs. nondeterministic 2016-09-25 19:14:27 +01:00
Daniel Kroening 90a1b6f58f language edits 2016-09-20 11:50:10 +01:00
theyoucheng e38fdc671b revised the pid case study 2016-09-19 23:06:50 +01:00
theyoucheng 81ddd0a190 Improved the PID controller case study. 2016-09-19 22:43:38 +01:00
Daniel Kroening db634d22d1 para 2016-08-30 19:09:47 +01:00
Daniel Kroening 398e18d19e para 2016-08-30 19:08:58 +01:00
Daniel Kroening ea9d2379a6 comma 2016-08-30 19:07:35 +01:00
Daniel Kroening 80060f866d cover TOC 2016-08-30 19:06:30 +01:00
Daniel Kroening 52ed805545 wordings 2016-08-30 19:05:50 +01:00
Daniel Kroening 8bec9b6ccc edits 2016-08-30 18:59:36 +01:00
theyoucheng 1b73bba15f Added a case study for the "--cover mcdc" test suite generation. 2016-08-25 22:24:54 +01:00
Daniel Kroening d031ccc0f8 added the option --trace 2016-07-05 15:01:34 +01:00
Daniel Kroening 14582d5044 more on source code 2016-06-19 16:21:56 +01:00
Daniel Kroening 4fc8ff558a use highlight 2016-06-13 16:09:19 +01:00
Daniel Kroening 49f47243bb use highlight 2016-06-13 16:03:35 +01:00
Daniel Kroening a24fce0712 use highlight 2016-06-13 15:59:30 +01:00
Daniel Kroening 195229a4c5 use highlight 2016-06-13 15:56:43 +01:00
Daniel Kroening ac6e648e92 use highlight 2016-06-13 15:46:18 +01:00
Daniel Kroening 2c0f56d60e use highlight 2016-06-13 15:43:14 +01:00
Daniel Kroening 07d635a9a7 use highlight 2016-06-13 15:39:55 +01:00
Daniel Kroening cae101983b use highlight 2016-06-13 15:35:03 +01:00
Daniel Kroening 1305454ee2 use highlight 2016-06-13 15:29:14 +01:00
Daniel Kroening 3ec6368030 use highlight 2016-06-13 15:27:12 +01:00
Daniel Kroening e9df6323a1 use highlight 2016-06-13 15:12:59 +01:00
Daniel Kroening 0a2154c236 use highlight 2016-06-13 15:00:22 +01:00
Daniel Kroening 502e1cc199 use highlight 2016-06-13 14:57:39 +01:00
Daniel Kroening ed64eb0a5e use highlight 2016-06-13 12:11:47 +01:00
Daniel Kroening 4ba56e3e4c use highlight 2016-06-13 12:11:36 +01:00
Daniel Kroening a9c34cc137 use highlight 2016-06-13 12:10:04 +01:00
Daniel Kroening 1447f0030d use highlight 2016-06-13 12:08:03 +01:00
Daniel Kroening 02d04204da use highlight 2016-06-13 12:03:26 +01:00
Daniel Kroening 83b807d250 use highlight 2016-06-13 11:54:01 +01:00
Daniel Kroening 2f85753588 use highlight 2016-06-13 11:48:51 +01:00
Daniel Kroening 44222b4b6f added highlight package with C++/C# option 2016-06-13 11:44:28 +01:00
Daniel Kroening b79f619d1e fixes 2016-06-13 09:48:31 +01:00
Daniel Kroening 398a2b07ce fixes 2016-06-13 09:44:42 +01:00
Daniel Kroening 9fc064b622 more HTML-ification 2016-06-13 08:37:58 +01:00
Daniel Kroening 89fa5e6fde property results are now uniform 2016-06-11 20:16:32 +01:00
Daniel Kroening 95f4a47a27 big change: cbmc now uses --all-properties as the default 2016-06-10 10:00:19 +01:00
Daniel Kroening d0219bafdd added API reference 2016-06-09 16:01:56 +01:00
Daniel Kroening 3a55e86fe1 mild update of man page 2016-06-09 15:08:26 +01:00
Daniel Kroening 0aa32a2daa fixed bounds example 2016-04-07 13:03:39 +01:00
kroening f87cb8f817 uninterpreted functions and threads
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@6444 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2016-02-26 11:24:27 +00:00
kroening 1a58b0df45 typo __CPROVER_array_set
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@6443 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2016-02-26 11:21:12 +00:00
kroening 8ab95bc912 unwinding assertions are no longer the default
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@6190 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2015-12-23 10:25:38 +00:00
kroening b952eca7ee C++ types
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@5593 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2015-06-19 11:49:01 +00:00
kroening 39d1bb13ff document rounding done for floating-point related typecasts
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@5104 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2015-01-26 13:54:35 +00:00
kroening c2792d127f fix
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@5020 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2015-01-06 18:14:12 +00:00
kroening 441621b2f0 FV -> SV
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@4869 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2014-12-23 20:34:26 +00:00
kroening 292511cf1c mention support for fstcw/fnstcw/fldcw
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@4831 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2014-12-06 19:48:47 +00:00
kroening ef68660c1b Visual Studio Community
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@4755 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2014-11-20 21:34:52 +00:00
kroening 8a51187a5c Visual Studio Community
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@4733 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2014-11-13 22:35:21 +00:00
tautschnig a811cb008c Honor TMPDIR environment variable when creating temporary files
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@4561 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2014-08-27 15:52:57 +00:00
kroening ee024df06e nudge
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@3965 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2014-06-11 09:43:18 +00:00
kroening a8cc01c036 claims plus rounding mode
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@3964 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2014-06-11 09:40:56 +00:00
kroening aac9da5ade claim -> property
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@3909 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2014-06-05 14:41:40 +00:00
kroening 570d2bf055 __CPROVER_fixedbv
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@3797 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2014-05-06 20:17:21 +00:00
kroening 6e2e4c9954 rounding mode
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@3796 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2014-05-06 20:17:11 +00:00
kroening 054864c34a fix for list
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@3747 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2014-04-20 09:12:02 +00:00
kroening f2073820d7 fix
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@3543 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2014-01-22 16:06:40 +00:00
kroening ccdb07571b explanation that backjumps are counted when unwinding
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@3542 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2014-01-22 16:04:14 +00:00
kroening 22c45dd92b mild refinement of overview slides
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@3054 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-10-21 12:31:28 +00:00
kroening 53f1aa3353 added CPROVER overview slides, Latex Beamer
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@3051 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-10-21 09:57:01 +00:00
kroening cb487cfc22 ring buffer example
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2997 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-10-07 18:00:54 +00:00
kroening dc1af255c4 __CPROVER_floatbv[width][mantissa]
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2908 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-08-22 20:16:56 +00:00
kroening c7f58fe84e update the documentation to changes in GCC flags
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2859 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-08-10 08:16:41 +00:00
kroening a896b1e514 suggest make defconfig instead of make xconfig
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2849 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-08-08 14:01:20 +00:00
kroening 2c9cd79728 fix for figures
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2713 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-07-04 12:20:30 +00:00
kroening 9766b529b9 missing .tex file
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2712 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-07-04 12:15:23 +00:00
kroening 5ae81e1de0 missing figures
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2711 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-07-04 12:15:04 +00:00
kroening 000b6e36dc fix for script
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2710 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-07-04 12:09:13 +00:00
kroening efb6b49bec missing figure
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2709 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-07-04 12:09:01 +00:00
kroening b51e849f93 -fsingle-precision-constant
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2661 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-06-21 14:41:57 +00:00
kroening 8bee1589d9 Java
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2598 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-06-10 07:04:53 +00:00
kroening 2023a98a2f CPROVER guide spelling
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2452 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-05-20 18:41:14 +00:00
kroening 477f04183b CBMC latex beamer slides
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2447 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-05-16 19:16:29 +00:00
kroening 77bc5a0634 more
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2361 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-04-11 08:48:04 +00:00
kroening 139e986dfc more
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2360 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-04-11 08:44:30 +00:00
kroening 5319757bfb fixes
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2359 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-04-11 08:33:05 +00:00
kroening a682787eec command line cleanup: architecture/os
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2332 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-04-05 15:33:38 +00:00
kroening e1e54d7b29 FP-doc update from Martin
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2212 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-02-26 18:16:33 +00:00
kroening ab7170b04b edits
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2110 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-02-07 16:45:36 +00:00
kroening 8353641e7f Martin's guide
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@2018 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-01-20 16:39:07 +00:00
kroening dbc56b09b0 documentation for float and uninterpreted functions (Martin)
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@1988 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2013-01-11 02:55:24 +00:00
kroening 9e19256f58 goto-gcc
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@1940 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2012-12-14 14:05:40 +00:00
kroening d100dcacc1 visual studio URL
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@1874 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2012-11-03 11:44:44 +00:00
kroening 6f62b60206 fix
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@1873 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2012-11-03 11:39:58 +00:00
kroening e47a7af6ec fix
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@1872 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2012-11-03 11:39:35 +00:00
kroening c9a0faa0e2 fix
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@1871 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2012-11-03 11:39:12 +00:00
kroening 51a89c1d48 building from source
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@1870 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2012-11-03 11:30:39 +00:00
kroening f1e5a02527 HTML manual from CVS
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@1869 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2012-11-03 11:23:19 +00:00
kroening b421bd9789 escapes
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@1734 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2012-09-19 16:55:00 +00:00
kroening 44826a79b8 more
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@1556 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2012-09-08 20:43:51 +00:00
kroening 53fca41be4 added manpage
git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@1063 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2012-03-11 12:26:01 +00:00