Skip to content

Commit e2791b6

Browse files
pmaijdsika
andauthored
Clarify protobuf version descriptions in documentation (#883)
Also change example version for trace file osi version to be a reasonable number. Signed-off-by: Pierre R. Mai <pmai@pmsf.de> Co-authored-by: Carlo van Driesten <carlo.van-driesten@bmw.de>
1 parent d16a10f commit e2791b6

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/architecture/trace_file_formats.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The file shall contain exactly one meta-data record with the `name` field being
6565

6666
`version`::
6767
The semantic version number of the OSI release that this OSI trace file conforms to.
68-
This is a string in the format `major.minor.patch`, for example `3.0.0`.
68+
This is a string in the format `major.minor.patch`, for example `3.8.0`.
6969
Note that this version number is not necessarily the same as the OSI schema version(s) used in the trace file.
7070
Rather, it indicates the version of the OSI trace file format itself.
7171

@@ -78,11 +78,11 @@ The maximum version of the OSI schema used in the trace file OSI channels.
7878
This is a string in the format `major.minor.patch`, for example `3.7.0`.
7979

8080
`min_protobuf_version`::
81-
The version of the protobuf implementation used in the trace file.
81+
The minimum version of the protobuf implementation used in the trace file.
8282
This is a string in the format `major.minor.patch`, for example `3.17.3`.
8383

8484
`max_protobuf_version`::
85-
The version of the protobuf implementation used in the trace file.
85+
The maximum version of the protobuf implementation used in the trace file.
8686
This is a string in the format `major.minor.patch`, for example `3.26.0`.
8787

8888
The `net.asam.osi.trace` meta-data record may also contain the following recommended `metadata` entries:

0 commit comments

Comments
 (0)