From f4fce5310a3f0a7a47139bc3ab04367882f8433f Mon Sep 17 00:00:00 2001 From: Thomas Sedlmayer Date: Mon, 15 Apr 2024 11:51:07 +0200 Subject: [PATCH] Fix outdated documentation on formatting scripts Signed-off-by: Thomas Sedlmayer --- ...rmatting_scripts.adoc => formatting_script.adoc} | 13 ++++--------- doc/open-simulation-interface_user_guide.adoc | 2 +- 2 files changed, 5 insertions(+), 10 deletions(-) rename doc/architecture/{formatting_scripts.adoc => formatting_script.adoc} (57%) diff --git a/doc/architecture/formatting_scripts.adoc b/doc/architecture/formatting_script.adoc similarity index 57% rename from doc/architecture/formatting_scripts.adoc rename to doc/architecture/formatting_script.adoc index a953b3e13..d8beec595 100644 --- a/doc/architecture/formatting_scripts.adoc +++ b/doc/architecture/formatting_script.adoc @@ -2,10 +2,10 @@ ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] -= Trace-file formatting scripts += Trace-file formatting script -The OSI repository contains Python scripts for converting trace files from one format to another. -The formatting scripts are stored in `open-simulation-interface/format/` +The OSI repository contains a Python script for converting trace files from one format to another. +The formatting script is stored in `open-simulation-interface/osi3trace/`. **osi2read.py** @@ -22,12 +22,7 @@ The default value is `'SensorView'`. `--output`, `-o`:: Optional string containing the name of the output file. -The default value is `'converted.txth'`. - -`--format`, `-f`:: -Optional string containing the format type of the trace file. -`'separated'`, or `None` are permitted values. -The default value is `None`. +The default value is `None`, in which case the output file name is set to the name of the input file, with the file extension being replaced by `.txth`. **Related topics** diff --git a/doc/open-simulation-interface_user_guide.adoc b/doc/open-simulation-interface_user_guide.adoc index f45cc65c2..69296d267 100644 --- a/doc/open-simulation-interface_user_guide.adoc +++ b/doc/open-simulation-interface_user_guide.adoc @@ -69,7 +69,7 @@ include::./architecture/trace_file_naming.adoc[leveloffset=+3] include::./architecture/trace_file_example.adoc[leveloffset=+3] -include::./architecture/formatting_scripts.adoc[leveloffset=+3] +include::./architecture/formatting_script.adoc[leveloffset=+3] // Setting up OSI