From d01cd57cbdba9f8bdf05d1cff58bd98aabcdc194 Mon Sep 17 00:00:00 2001
From: Reiner Jung <reiner.jung@email.uni-kiel.de>
Date: Sun, 16 May 2021 17:35:56 +0200
Subject: [PATCH] Cleanup of documentation.
---
README.md | 4 ++--
doc/tools/create-architecture-model.rst | 24 ++++++++++++++-----
doc/tools/pp-static-log.rst | 17 +++++++++++++
.../java/org/oceandsl/pp/log/Settings.java | 4 ++--
4 files changed, 39 insertions(+), 10 deletions(-)
create mode 100644 doc/tools/pp-static-log.rst
diff --git a/README.md b/README.md
index 29aa2705..2f0daf09 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# OceanDSL Jvava Tools
+# OceanDSL Java Tools
Project containing all Java-based tools developed in OceanDSL.
@@ -14,7 +14,7 @@ Each tool has its own set of parameters and can be found in
Current tools:
- rewrite-log-entries
- create-architecture-model
-
+- pp-static-log
diff --git a/doc/tools/create-architecture-model.rst b/doc/tools/create-architecture-model.rst
index 8be362fe..768b6582 100644
--- a/doc/tools/create-architecture-model.rst
+++ b/doc/tools/create-architecture-model.rst
@@ -8,12 +8,24 @@ The tool is intended to be used in conjunctions with kieker-lang-pack-c Kieker l
`BeforeOperationEvent`s and `AfterOperationEvent`s do only contain pointer information for
operation calls which must be resolved using `addr2line`.
-This tool has 5 parameters:
--i input kieker log directory>
--o path where the output kieker log is placed
--a the location of the addr2line executable to resolve the names
--m the executable (model) to be analyzed by addr2line
--p prefix path to be removed from path information
+Parameters:
+-i, --input (required) Input Kieker log directory or CSV file location
+-o, --output (required) Output directory to store graphics and statistics
+-M, --component-map Component, file and function map file
+-a, --addrline Location of the addrline tool
+-e, --executable Location of the executable
+-m, --mode Different input read modes, default is kieker; other option is csv
+-ia, --input-architecture-model Directory for an input architecture model
+-oa, --output-architecture-model Directory for an output architecture model
+-l, --source-label (required) Set source label for the read data
+-c, --case-insensitive Handle function names case insensitive
+ This is helpful with Fortran code as function names are handled
+ case insensitive.
+-H, --hostname Hostname to be used in CSV reconstruction, this can be
+ used with static analysis data to simulate a deployment host
+-E, --experiment-name (required) Name of the experiment
+-g, --graphs Specify which output graphs must be generated (dot-op, dot-component, graphml)
+
Build
-----
diff --git a/doc/tools/pp-static-log.rst b/doc/tools/pp-static-log.rst
new file mode 100644
index 00000000..343853f4
--- /dev/null
+++ b/doc/tools/pp-static-log.rst
@@ -0,0 +1,17 @@
+Preprocessor for Static Logs
+============================
+
+Logs based on FParser produce a CSV file with three column refering
+to caller file name, caller function name, callee function name.
+The callee file name is missing. However, this can be inferred by other
+means from the source code and stored in lookup tables. The
+**pp-static-log** will read an 3 column CSV file use one or more
+lookup tables and generate a 4 column output CSV file.
+
+Parameters
+-i, --input (required) Input 3 column static log file
+-m, --map (required) Function to map files. One of more files separated by
+ a space.
+-o, --output (required) Output file for 4 column log
+
+
diff --git a/tools/pp-static-log/src/main/java/org/oceandsl/pp/log/Settings.java b/tools/pp-static-log/src/main/java/org/oceandsl/pp/log/Settings.java
index 8d998a0a..58952b76 100644
--- a/tools/pp-static-log/src/main/java/org/oceandsl/pp/log/Settings.java
+++ b/tools/pp-static-log/src/main/java/org/oceandsl/pp/log/Settings.java
@@ -32,7 +32,7 @@ import com.beust.jcommander.converters.PathConverter;
public class Settings {
@Parameter(names = { "-i",
- "--input" }, required = true, converter = PathConverter.class, description = "Input 3 column static log directory")
+ "--input" }, required = true, converter = PathConverter.class, description = "Input 3 column static log file")
private Path inputPath;
@Parameter(names = { "-m",
@@ -40,7 +40,7 @@ public class Settings {
private List<Path> mapPaths;
@Parameter(names = { "-o",
- "--output" }, required = true, converter = FileConverter.class, description = "Output directory for 4 column log")
+ "--output" }, required = true, converter = FileConverter.class, description = "Output file for 4 column log")
private File outputFile;
public Path getInputPath() {
--
GitLab