From dd0cf5fd1fe3ea1d5990a6168828d08a114a1ce1 Mon Sep 17 00:00:00 2001 From: Reiner Jung <reiner.jung@email.uni-kiel.de> Date: Thu, 4 Feb 2021 13:24:53 +0100 Subject: [PATCH] Updated documentation. --- doc/tools/create-architecture-model.rst | 24 +++++++++++++++++++++++ doc/tools/rewrite-log-entries.rst | 24 +++++++++++++++++++++++ tools/create-architecture-model/README.md | 24 ----------------------- tools/rewrite-log-entries/README.md | 24 ----------------------- 4 files changed, 48 insertions(+), 48 deletions(-) delete mode 100644 tools/create-architecture-model/README.md delete mode 100644 tools/rewrite-log-entries/README.md diff --git a/doc/tools/create-architecture-model.rst b/doc/tools/create-architecture-model.rst index e69de29b..bfa14556 100644 --- a/doc/tools/create-architecture-model.rst +++ b/doc/tools/create-architecture-model.rst @@ -0,0 +1,24 @@ +# Replace 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. + +The 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 + +## Build + +`./gradlew build` + +The build produces an tar and zip archive in its `build/distributions` directory. + +## Notes + +Currently, the resulting Kieker-log uses textual serialization. This could be +changed in future implementations. + + diff --git a/doc/tools/rewrite-log-entries.rst b/doc/tools/rewrite-log-entries.rst index e69de29b..bfa14556 100644 --- a/doc/tools/rewrite-log-entries.rst +++ b/doc/tools/rewrite-log-entries.rst @@ -0,0 +1,24 @@ +# Replace 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. + +The 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 + +## Build + +`./gradlew build` + +The build produces an tar and zip archive in its `build/distributions` directory. + +## Notes + +Currently, the resulting Kieker-log uses textual serialization. This could be +changed in future implementations. + + diff --git a/tools/create-architecture-model/README.md b/tools/create-architecture-model/README.md deleted file mode 100644 index bfa14556..00000000 --- a/tools/create-architecture-model/README.md +++ /dev/null @@ -1,24 +0,0 @@ -# Replace 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. - -The 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 - -## Build - -`./gradlew build` - -The build produces an tar and zip archive in its `build/distributions` directory. - -## Notes - -Currently, the resulting Kieker-log uses textual serialization. This could be -changed in future implementations. - - diff --git a/tools/rewrite-log-entries/README.md b/tools/rewrite-log-entries/README.md deleted file mode 100644 index bfa14556..00000000 --- a/tools/rewrite-log-entries/README.md +++ /dev/null @@ -1,24 +0,0 @@ -# Replace 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. - -The 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 - -## Build - -`./gradlew build` - -The build produces an tar and zip archive in its `build/distributions` directory. - -## Notes - -Currently, the resulting Kieker-log uses textual serialization. This could be -changed in future implementations. - - -- GitLab