diff --git a/doc/tools/create-architecture-model.rst b/doc/tools/create-architecture-model.rst index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..bfa14556b6e419e42862f1c8d5736e529069c157 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 e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..bfa14556b6e419e42862f1c8d5736e529069c157 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 bfa14556b6e419e42862f1c8d5736e529069c157..0000000000000000000000000000000000000000 --- 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 bfa14556b6e419e42862f1c8d5736e529069c157..0000000000000000000000000000000000000000 --- 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. - -