Updated documentation.

doc/tools/allen-upper-limit.rst

@@ -52,7 +52,7 @@ Examples
 --------
 
 Lets assume you have created a architecture model with the dynamic or static
-architecture recovery tool, :ref:`_kieker-tools-dar` and :ref:`_kieker-tools-sar`
+architecture recovery tool, `dar` and `sar`
 respectively. And lets assume the model resides in the `input-model` directory.
 The output will be written to `output` and contain graphs and statistics.
 

doc/tools/maa.rst

@@ -16,7 +16,7 @@ Synopsis
 --------
 ::
   
-  maa -i <path> -o <path> [-I] [-g] [-c] [-s] [-gs <seperator>] [-E <experiment name>] [--eol <character>]
+  maa -i <path> -o <path> [-I] [-g <path 1 ... path n>] [-c] [-s] [-gs <seperator>] [-E <experiment name>] [--eol <character>]
 
 Options
 -------
@@ -43,3 +43,10 @@ containing the function module mapping.
 
 Examples
 --------
+
+Process and input model, compute interfaces for that model `-I` and generate a multiple levels of
+components based on a map file.
+
+::
+  
+  maa -i input -o output -I -g map-file.csv

doc/tools/mktable.rst

@@ -11,6 +11,8 @@ Synopsis
 --------
 ::
   
+  mktable -i <path> -o <path>
+
 Options
 -------
 
@@ -24,5 +26,5 @@ Short Long                   Required Description
 Description
 -----------
 
-Examples
---------
\ No newline at end of file
+This tool only helps with producing large LaTeX tables based on the CSV files from
+the restructuring tool.

doc/tools/mop.rst

@@ -50,9 +50,10 @@ Examples
 Here two input models in the directories `static-model` and `dynamic-model` are read and **merged**
 into a new model and stored in the `joined-model` directory.
 
-```
+::
+  
   mop -i static-model dynamic-model -o joined-model -e UVic-2.9.2 merge
-```
+
 
 **Example selection**
 
@@ -61,7 +62,8 @@ The input model `model` is read and a portion of the model is selected and store
 The selection pattern file contains Java regular expressions to select
 components that should exist in the output model.
 
-```
+::
+  
   mop -i model -o selected-model -e UVic-2.9.2 -s selection-pattern-file select
-```
+
 

doc/tools/mvis.rst

@@ -23,7 +23,7 @@ Short Long                  Required Description
 -s    --selector                     Set architecture graph selector
                                      all, diff, subtract, intersect
 -g    --graphs                       Specify which output graphs must be generated
-                                     odt-op, graphml, dot-component
+                                     dot-op, graphml, dot-component
 -m    --mode                         Mode deciding whether an edge is added when its nodes
                                      are not selected add-nodes, only
 -c    --compute-statistics           Generate the listed statistics
@@ -34,6 +34,10 @@ Short Long                  Required Description
 Description
 -----------
 
+mvis is used to generate visualizations and create statistics on a model. It can select
+different elements of the model (nodes) and use labels assigned to model elements.
+See `sar` and `dar`documentation how to set labels and `relabel` to change labels.
+
 Selectors
 ~~~~~~~~~
 
@@ -57,4 +61,16 @@ Outputs
 Examples
 --------
 
+Generate a component based graphic with all nodes of a model and compute statistics.
+
+::
+  
+  mvis -i model -o output -s all -g dot-component -c
+
+Generate a component based graphic with two levels of components, where the second level
+of components is provided by the `component-map.csv` file. Display only elements which have
+both labels `dynamic` and `static`.
+
+::
   
+  mvis -i model -o output -s intersect:dynamic,static -g dot-component -c -M component-map.csv

doc/tools/relabel.rst

@@ -12,6 +12,8 @@ Synopsis
 --------
 ::
   
+  relabel -i <path> -o <path> -r <source:target> [-e <experiment>]
+
 Options
 -------
 
@@ -31,13 +33,16 @@ Examples
 --------
 
 Replace the two labels static and dynamic by veriant-5
-```
+::
+  
   relabel -i input-model -o modified-model -r static,dynamic:variant-5
-```
+
 
 Replace static by two labels and in a second step merge static-a with dynamic
 into variant-4
-```
+
+::
+  
   relabel -i input-model -o modified-model -r static:static-a,static-b static-a,dynamic:variant-4
-```
+
 

doc/tools/restructuring.rst

@@ -3,13 +3,16 @@
 Restructuring
 =============
 
-Identify a number of operations to transform an architecture model
+Identify the number of operations to transform an architecture model
 into another one. Best strategy to use is kuhn
 
 Synopsis
 --------
 ::
   
+  restructuring -i <input-models> -o <output-model> [-e <experiment-name>] [--eol <symbol>] [-s <strategy>]
+
+
 Options
 -------
 
@@ -27,6 +30,14 @@ Short Long                   Required Description
 Description
 -----------
 
+The tool reads a multiple number of models and calculates the edit distance between the first
+and every other model. The tool outputs information on the relevant operations and a table
+containing all changes.
+
 Examples
 --------
 
+::
+  
+  restructuring -i input/base input/optimization-1 input/optimization-2 -e example -s kuhn
+

doc/tools/rewrite-log-entries.rst

-.. _kieker-tools-rewrite-log-entries:
-
-Rewrite Log Entries
-===================
-
-This tool has 4 parameters and can be used to replace function pointer
-references by function signatures produced by kieker-lang-pack-c
-instrumentations.
-
-Synopsis
---------
-::
-
-Options
--------
-
-===== ====================== ======== =============================================================
-Short Long                   Required Description
-===== ====================== ======== =============================================================
--i    --input                yes      input kieker log directory
--o    --output               yes      path where the output kieker log is placed
--a                           yes      the location of the addr2line executable to resolve the names
--m                           yes      the executable to be analyzed by addr2line
-===== ====================== ======== =============================================================
-
-Description
------------
-
-The dar tool can process kieker-lang-pack-c files directly, but the
-trace-analysis tools cannot resolve function names. In these cases
-rewrite-log-entries can help to add human comprehensible function and
-module/class/component descriptions.
-
-Examples
---------

doc/tools/sar.rst

@@ -11,6 +11,9 @@ Synopsis
 --------
 ::
   
+  sar -i <path> -o <path> [-E <experiment-name>] [-g <call|dataflow|both>] [-m <module-mode|file-mode|map-mode>] [-l <label>]
+
+
 Options
 -------
 
@@ -78,3 +81,16 @@ in case these are set to the empty string "".
 Examples
 --------
 
+In this example a previously generated set of input files from **fxtran**
+are read and a model is produced in the `output-model` directory. Each
+element of the model is marked with a label `example`. Note this label does
+not appear visually in the models, but can be used to control coloring and
+other operation on a model later when mixing models with other models.
+
+The example uses `module-mode` which means modules are derived from Fortran
+module information. If your model does not contain such information, it
+is better to use `file-mode` or `map-mode`.
+
+::
+  
+  sar -i input-data -o output-model -l example -m module-mode -g both

doc/tools/static-analysis-formats.rst

@@ -17,14 +17,15 @@ Containing functions calls.
 
 **Note** old format specification
 There are two supported formats with 3 and 4 column CSV files.
- - 3 columns: file, caller, callee: In this format the callee lacks the
+
+ * 3 columns: file, caller, callee: In this format the callee lacks the
    information where the operation is located. Thus, it must be inferred
    at a later point.
 
- - 4 columns: caller-file, caller, callee-file, callee
+ * 4 columns: caller-file, caller, callee-file, callee
 
 **Note** new format specification
- - 6 columns: path, module, caller, path, module, callee
+ * 6 columns: path, module, caller, path, module, callee
 
 Function call file hs comments
 ------------------------------
@@ -69,9 +70,6 @@ The column names from the CSV are a bit different:
 
 filename, function, readWrite, blockname, index
 
-(I did not use "caller" since that looks too much like method call coupling, but
-names of course don't really matter ;-))
-