Skip to content

Commit e64338c

Browse files
authored
Merge pull request #803 from thomassedlmayer/fix/osi3trace_documentation
Fix outdated documentation on formatting scripts
2 parents f479d99 + f4fce53 commit e64338c

File tree

2 files changed

+5
-10
lines changed

2 files changed

+5
-10
lines changed

doc/architecture/formatting_scripts.adoc doc/architecture/formatting_script.adoc

+4-9
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ ifndef::include-only-once[]
22
:root-path: ../
33
include::{root-path}_config.adoc[]
44
endif::[]
5-
= Trace-file formatting scripts
5+
= Trace-file formatting script
66

7-
The OSI repository contains Python scripts for converting trace files from one format to another.
8-
The formatting scripts are stored in `open-simulation-interface/format/`
7+
The OSI repository contains a Python script for converting trace files from one format to another.
8+
The formatting script is stored in `open-simulation-interface/osi3trace/`.
99

1010
**osi2read.py**
1111

@@ -22,12 +22,7 @@ The default value is `'SensorView'`.
2222

2323
`--output`, `-o`::
2424
Optional string containing the name of the output file.
25-
The default value is `'converted.txth'`.
26-
27-
`--format`, `-f`::
28-
Optional string containing the format type of the trace file.
29-
`'separated'`, or `None` are permitted values.
30-
The default value is `None`.
25+
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`.
3126

3227
**Related topics**
3328

doc/open-simulation-interface_user_guide.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ include::./architecture/trace_file_naming.adoc[leveloffset=+3]
6969

7070
include::./architecture/trace_file_example.adoc[leveloffset=+3]
7171

72-
include::./architecture/formatting_scripts.adoc[leveloffset=+3]
72+
include::./architecture/formatting_script.adoc[leveloffset=+3]
7373

7474

7575
// Setting up OSI

0 commit comments

Comments
 (0)