Move folder walkthrough to a separate file

The CBMC Developer Guide now contains a link to that file.

Author: Owen Jones

doc/architectural/CBMC-developer-guide.md

@@ -187,89 +187,7 @@ To be documented. (Martin?)
 
 \section section-folder-walkthrough Folder walkthrough
 
-## `src/` ##
-
-The source code is divided into a number of sub-directories, each
-containing the code for a different part of the system.
-
-- GOTO-Programs
-
-  * \ref goto-programs
-  * \ref linking
-
-- Symbolic Execution
-  * \ref goto-symex
-
-- Static Analyses
-
-  * \ref analyses
-  * \ref pointer-analysis
-
-- Solvers
-  * \ref solvers
-
-- Language Front Ends
-
-  * Language API: \ref langapi
-  * C: \ref ansi-c
-  * C++: \ref cpp
-  * Java: \ref java_bytecode
-  * JavaScript: \ref jsil
-
-- Tools
-
-  * \ref cbmc
-  * \ref clobber
-  * \ref goto-analyzer
-  * \ref goto-instrument
-  * \ref goto-diff
-  * \ref memory-models
-  * \ref goto-cc
-  * \ref jbmc
-
-- Utilities
-
-  * \ref big-int
-  * \ref json
-  * \ref xmllang
-  * \ref util
-  * \ref miniz
-  * \ref nonstd
-
-In the top level of `src` there are only a few files:
-
-* `config.inc`:   The user-editable configuration parameters for the
-  build process. The main use of this file is setting the paths for the
-  various external SAT solvers that are used. As such, anyone building
-  from source will likely need to edit this.
-
-* `Makefile`:   The main systems Make file. Parallel builds are
-  supported and encouraged; please don’t break them!
-
-* `common`:   System specific magic required to get the system to build.
-  This should only need to be edited if porting CBMC to a new platform /
-  build environment.
-
-* `doxygen.cfg`:   The config file for doxygen.cfg
-
-## `doc/` ##
-
-Contains the CBMC man page. Doxygen HTML pages are generated
-into the `doc/html` directory when running `doxygen` from `src`.
-
-## `regression/` ##
-
-The `regression/` directory contains the test suites.
-They are grouped into directories for each of the tools/modules.
-Each of these contains a directory per test case, containing a C or C++
-file that triggers the bug and a `.desc` file that describes
-the tests, expected output and so on. There is a Perl script,
-`test.pl` that is used to invoke the tests as:
-
-    ../test.pl -c PATH_TO_CBMC
-
-The `–help` option gives instructions for use and the
-format of the description files.
+See [the folder walkthrough](folder-walkthrough.md).
 
 
 

doc/architectural/folder-walkthrough.md

@@ -0,0 +1,88 @@
+\ingroup module_hidden 
+\page folder-walkthrough Folder Walkthrough
+
+\author Martin Brain, Peter Schrammel
+
+## `src/` ##
+
+The source code is divided into a number of sub-directories, each
+containing the code for a different part of the system.
+
+- GOTO-Programs
+
+  * \ref goto-programs
+  * \ref linking
+
+- Symbolic Execution
+  * \ref goto-symex
+
+- Static Analyses
+
+  * \ref analyses
+  * \ref pointer-analysis
+
+- Solvers
+  * \ref solvers
+
+- Language Front Ends
+
+  * Language API: \ref langapi
+  * C: \ref ansi-c
+  * C++: \ref cpp
+  * Java: \ref java_bytecode
+  * JavaScript: \ref jsil
+
+- Tools
+
+  * \ref cbmc
+  * \ref clobber
+  * \ref goto-analyzer
+  * \ref goto-instrument
+  * \ref goto-diff
+  * \ref memory-models
+  * \ref goto-cc
+  * \ref jbmc
+
+- Utilities
+
+  * \ref big-int
+  * \ref json
+  * \ref xmllang
+  * \ref util
+  * \ref miniz
+  * \ref nonstd
+
+In the top level of `src` there are only a few files:
+
+* `config.inc`:   The user-editable configuration parameters for the
+  build process. The main use of this file is setting the paths for the
+  various external SAT solvers that are used. As such, anyone building
+  from source will likely need to edit this.
+
+* `Makefile`:   The main systems Make file. Parallel builds are
+  supported and encouraged; please don’t break them!
+
+* `common`:   System specific magic required to get the system to build.
+  This should only need to be edited if porting CBMC to a new platform /
+  build environment.
+
+* `doxygen.cfg`:   The config file for doxygen.cfg
+
+## `doc/` ##
+
+Contains the CBMC man page. Doxygen HTML pages are generated
+into the `doc/html` directory when running `doxygen` from `src`.
+
+## `regression/` ##
+
+The `regression/` directory contains the test suites.
+They are grouped into directories for each of the tools/modules.
+Each of these contains a directory per test case, containing a C or C++
+file that triggers the bug and a `.desc` file that describes
+the tests, expected output and so on. There is a Perl script,
+`test.pl` that is used to invoke the tests as:
+
+    ../test.pl -c PATH_TO_CBMC
+
+The `–help` option gives instructions for use and the
+format of the description files.