Skip to content

Commit

Permalink
Fix outdated documentation on formatting scripts
Browse files Browse the repository at this point in the history
Signed-off-by: Thomas Sedlmayer <[email protected]>
  • Loading branch information
thomassedlmayer committed Apr 15, 2024
1 parent 560d23a commit ac6403c
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions doc/architecture/formatting_scripts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ endif::[]
= Trace-file formatting scripts

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 formatting scripts are stored in `open-simulation-interface/osi3trace/`.

**osi2read.py**

Expand All @@ -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 the input file name.

**Related topics**

Expand Down

0 comments on commit ac6403c

Please sign in to comment.