christoph/fail
1
Fork 0
Code Releases Activity

Separated how-to-build -> how-to-build + how-to-use, added details on experiment parallelization, updated fail-structure docs.

Browse Source 
git-svn-id: https://www4.informatik.uni-erlangen.de/i4svn/danceos/trunk/devel/fail@1348 8c4709b5-6ec9-48aa-a5cd-a96041d1645a
This commit is contained in:
adrian
2012-06-14 10:26:51 +00:00
parent 784c05572e
commit 94909e8565
6 changed files with 363 additions and 415 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/fail-structure.txt
View File

@ -1,8 +1,9 @@
=========================================================================================
Directory structure:
=========================================================================================
The folders are nested as follow:
-----------------------------------
**********************************************************************
fail: Fail* parent directory, containing all source & configuration files (${FAIL_DIR})
|-cmake: CMake-related configuration files (e.g. compiler-flags, dependencies, ...)
|-doc: Fail*-Framework documentation (e.g., diagrams, how-to's, ...)
@ -26,13 +27,14 @@ fail: Fail* parent directory, containing all source & configuration files (${FA
|-plugins: plugin code files (within a new dir) need to be located here
|-[build]: recommended location of your build-tree, generated files will be placed here
Some additional useful notes:
-----------------------------------
**********************************************************************
- The source files have been documented using Doxygen comments. The Doxygen
documentation can be generated by typing "make doc" in your build-tree. The
resulting HTML and LaTeX files will be located in "${BUILD_DIR}/src/core/doc/".
- CMake supports an "in-source" build-tree. We recommend you not to use this
feature, because it leads to a cluttered directory structure (mixing original
"feature", because it leads to a cluttered directory structure (mixing original
source files and generated code/config files). (Since it is still possible, however,
the "build" directory is optional.)
- CMake invokes the compiler with the following include directories:
@ -42,8 +44,7 @@ Some additional useful notes:
* ${FAIL_DIR}/simulators/bochs
These definitions simplify and shorten the include paths.
=========================================================================================
Namespace structure:
=========================================================================================
All classes, functions, constants, etc. are encapsulated in the namespace "fail".