@@ -76,12 +76,12 @@ hashing algorithm to ensure data has not been accidentally corrupted.
7676
7777## Header
7878
79- All data in a tsync file are stored in as little-endian.
80- All values written to the header block are hashed using the XXH3 hashing algorithm.
79+ All data in a tsync file are stored as little-endian.
80+ All values written to the header block are hashed using the XXH3 hashing algorithm as well .
8181
8282A tsync file always begins with magic number `TSYNC_FILE_MAGIC` as a `uint64` number, followed
8383by `TSYNC_FILE_VERSION_MAJOR` and `TSYNC_FILE_VERSION_MINOR` as `uint64` as well.
84- These two alues are followed by the creation date of the tsync file as UNIX timestamp in `int64` format.
84+ These two values are followed by the creation date of the tsync file as UNIX timestamp in `int64` format.
8585
8686These values are followed by the module name that created the tsync file as null-terminated UTF-8 encoded string.
8787The module name is followed by the experiment collection ID (EDL collection ID) as null-terminated UTF-8 encoded
@@ -98,7 +98,7 @@ are checksummed together. The block sizes denotes the count of values each block
9898128 or 256, but could be any value depending on the desired speed/robustness/size tradeoffs.
9999
100100The block size is followed by the name of the first time as UTF-8, zero-terminated string. This could be a value
101- like ` "master clock" ` . After this value follows the time unit ID ` TSyncFileTimeUnit ` as ` uint16 ` value to
101+ like ` "master clock" ` . After this value follows the time unit identifier ` TSyncFileTimeUnit ` as ` uint16 ` value to
102102denote the unit of measurement, followed by the byte size of the values this data unit is stored in as denoted
103103by the ` TSyncFileDataType ` enum, as ` uint16 ` .
104104
@@ -125,5 +125,5 @@ After writing the block, the rolling checksum is reset, and the next block is wr
125125(This allows to pinpoint and ignore a damaged block, if the file gets corrupted, without loosing all data).
126126
127127If the file is to be finished, but the last block did not end with a terminator yet, a ` TSYNC_FILE_BLOCK_TERM `
128- terminator value and the respective checksum is written enayway , ignoring the block size, so that a complete tsync file
128+ terminator value and the respective checksum is written anyway , ignoring the block size, so that a complete tsync file
129129always ends with a terminator+checksum combination.
0 commit comments