Skip to content

Clarify protobuf version descriptions in documentation #883

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 23, 2025
+3 −3
Merged

Clarify protobuf version descriptions in documentation #883

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b7b8c4
Clarify protobuf version descriptions in documentation
pmai Oct 16, 2025
b971c67
Merge branch 'master' into fix/fix-multi-trace-protobuf-version-descr…
jdsika Oct 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/architecture/trace_file_formats.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The file shall contain exactly one meta-data record with the `name` field being

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

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

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

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

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