Skip to content

Commit a4086ec

Browse files
authored
Add bibliography reference for MCAP
Signed-off-by: Pierre R. Mai <[email protected]>
1 parent 49a0ceb commit a4086ec

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/architecture/trace_file_formats.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ This release no longer contains any support for the legacy `.txt` file format.
3636
The OSI multi channel trace file format is a binary file format that allows for storing multiple serialized OSI message streams of the same or different types in one trace file, along with additional meta-data, and other related data streams.
3737
Due to the nature of the format, it allows for random access to the data streams, and is suitable for more advanced use-cases.
3838

39-
The OSI multi channel trace file format is based on the MCAP file format, which is a generic multi channel trace file format.
39+
The OSI multi channel trace file format is based on the MCAP file format cite:[mcap], which is a generic multi channel trace file format.
4040
The OSI multi channel trace file format is a specialization of the MCAP file format, with additional constraints and requirements specific to OSI.
4141
Hence, any valid OSI multi channel trace file is also a valid MCAP file, but not the other way around.
4242

@@ -46,7 +46,7 @@ Therefore, it can be used with any or an empty profile field in the MCAP header
4646
The following rules apply to OSI multi channel trace files:
4747

4848
- The file extension to be used is `.mcap`.
49-
- The file shall be a valid MCAP file according to the https://mcap.dev/spec[MCAP format specification] version `0x30`.
49+
- The file shall be a valid MCAP file according to the https://mcap.dev/spec[MCAP format specification] version `0x30` (cite:[mcap]).
5050
- The file shall be an indexed MCAP file, including chunk index records in the summary section, with all message records written into chunk records.
5151
- Chunk records shall either be uncompressed or compressed using either the `zstd` or `lz4` compression algorithms.
5252
- The file shall contain a meta-data record with the OSI trace file meta-data defined in section <<sec-osi-trace-file-multi-global-meta-data>>.

0 commit comments

Comments
 (0)