Skip to content

Add bibliography reference for MCAP #867

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add bibliography reference for MCAP #867

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions doc/architecture/trace_file_formats.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ This release no longer contains any support for the legacy `.txt` file format.
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.
Due to the nature of the format, it allows for random access to the data streams, and is suitable for more advanced use-cases.

The OSI multi channel trace file format is based on the MCAP file format, which is a generic multi channel trace file format.
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.
The OSI multi channel trace file format is a specialization of the MCAP file format, with additional constraints and requirements specific to OSI.
Hence, any valid OSI multi channel trace file is also a valid MCAP file, but not the other way around.

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

- The file extension to be used is `.mcap`.
- The file shall be a valid MCAP file according to the https://mcap.dev/spec[MCAP format specification] version `0x30`.
- The file shall be a valid MCAP file according to the https://mcap.dev/spec[MCAP format specification] version `0x30` (cite:[mcap]).
- The file shall be an indexed MCAP file, including chunk index records in the summary section, with all message records written into chunk records.
- Chunk records shall either be uncompressed or compressed using either the `zstd` or `lz4` compression algorithms.
- 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>>.
Expand Down