2 \page folder-walkthrough Folder Walkthrough
4 \author Martin Brain, Peter Schrammel
8 The source code is divided into a number of sub-directories, each
9 containing the code for a different part of the system.
22 * \ref pointer-analysis
29 * Language API: \ref langapi
32 * Java: \ref java_bytecode
33 * JavaScript: \ref jsil
40 * \ref goto-instrument
55 In the top level of `src` there are only a few files:
57 * `config.inc`: The user-editable configuration parameters for the
58 build process. The main use of this file is setting the paths for the
59 various external SAT solvers that are used. As such, anyone building
60 from source will likely need to edit this.
62 * `Makefile`: The main systems Make file. Parallel builds are
63 supported and encouraged; please don’t break them!
65 * `common`: System specific magic required to get the system to build.
66 This should only need to be edited if porting CBMC to a new platform /
69 * `doxygen.cfg`: The config file for doxygen.cfg
73 Contains the CBMC man page. Doxygen HTML pages are generated
74 into the `doc/html` directory when running `doxygen` from `src`.
78 The `regression/` directory contains the regression test suites. See
79 \ref compilation-and-development for information on how to run and
80 develop regression tests.
84 The `unit/` directory contains the unit test suites. See
85 \ref compilation-and-development for information on how to run and