mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2025-03-04 10:39:50 +00:00
Code Issues Releases Wiki Activity

docs: Clarify on-disk order and size of log entry fields (#6357)

Browse source 
docs: clarify on-disk order and size of log entry fields

The order of the fields of a log entry on disk is CRC32 first, the docs had the size first.

I tried to make this list similar to the HashIndex struct description.
This commit is contained in:
Julian Picht 2022-02-25 12:53:58 +01:00 • committed by GitHub
parent 472eba0323
commit 091c48bc37
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/internals/data-structures.rst
View file

@ -94,13 +94,13 @@ this value in a non-empty repository, you may also need to relocate the segment
files manually.
A segment starts with a magic number (``BORG_SEG`` as an eight byte ASCII string),
followed by a number of log entries. Each log entry consists of:
followed by a number of log entries. Each log entry consists of: (in this order)
* 32-bit size of the entry
* CRC32 of the entire entry (for a PUT this includes the data)
* entry tag: PUT, DELETE or COMMIT
* PUT and DELETE follow this with the 32 byte key
* PUT follow the key with the data
* First, unsigned 32-bit number, the CRC32 of the entire entry (for a PUT including the DATA) excluding the CRC32 field
* Second, unsigned 32-bit size of the entry (including the whole header)
* Third, unsigned 8-bit entry tag: PUT(1), DELETE(2) or COMMIT(3)
* Fourth, on PUT or DELETE, 32 byte key
* Fifth, PUT only, (size - 41) bytes of data (length = size - sizeof(CRC32) - sizeof(size) - sizeof(entry tag) - sizeof(key))
Those files are strictly append-only and modified only once.