From 2b7b8c45172642b6c5b0fdfa344bde71b83ff847 Mon Sep 17 00:00:00 2001 From: "Pierre R. Mai" Date: Thu, 16 Oct 2025 18:41:02 +0200 Subject: [PATCH] Clarify protobuf version descriptions in documentation Also change example version for trace file osi version to be a reasonable number. Signed-off-by: Pierre R. Mai --- doc/architecture/trace_file_formats.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/architecture/trace_file_formats.adoc b/doc/architecture/trace_file_formats.adoc index 248623ae4..cccb13bca 100644 --- a/doc/architecture/trace_file_formats.adoc +++ b/doc/architecture/trace_file_formats.adoc @@ -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. @@ -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: