From 61714836bb8daef2cfc3352bbd42e036b1770604 Mon Sep 17 00:00:00 2001 From: Green Sky Date: Mon, 12 Feb 2024 14:13:57 +0100 Subject: [PATCH] typos --- src/fragment_store/README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src/fragment_store/README.md b/src/fragment_store/README.md index 1687fae7..eda26071 100644 --- a/src/fragment_store/README.md +++ b/src/fragment_store/README.md @@ -10,9 +10,9 @@ They can be used as a Transport protocol/logic too. Fragment files are stored with the first 2 hex chars as sub folders: eg: -objects/ (object store root) - - 5f/ (first 2hex subfolder) - - 4fffffff (the fragment file without the first 2 hexchars) +`objects/` (object store root) + - `5f/` (first 2hex subfolder) + - `4fffffff` (the fragment file without the first 2 hexchars) ### Split Object Store @@ -23,7 +23,6 @@ Metadata files have the `.meta` suffix. They also have a filetype specific suffi Just keeps the Fragments in memory. - # File formats Files can be compressed and encrypted. Since compression needs the data structure to funcion, it is applied before it is encrypted. @@ -34,8 +33,9 @@ Text json only makes sense for metadata if it's neither compressed nor encrypted Since the content of data is not looked at, nothing stops you from using text json and ecrypt it, but atleast basic compression is advised. A Metadata json object has the following keys: -- `enc` Encryption type of the data, if any -- `comp` Compression type of the data, if any +- `enc` (uint) Encryption type of the data, if any +- `comp` (uint) Compression type of the data, if any +- `metadata` (obj) the ## Binary file headers @@ -43,14 +43,14 @@ A Metadata json object has the following keys: file magic bytes `SOLMET` (6 bytes) -1 byte encryption type (0x00 is none) +1 byte encryption type (`0x00` is none) -1 byte compression type (0x00 is none) +1 byte compression type (`0x00` is none) ...metadata here... -note that the ecnryption and compression are for the metadata only. -The metadata itself contains encryption and compression about the data. +note that the encryption and compression are for the metadata only. +The metadata itself contains encryption and compression info about the data. ### Split Data @@ -62,9 +62,9 @@ Keep in mind to not use the actual file name as the data/meta file name. file magic bytes `SOLFIL` (6 bytes) -1 byte encryption type (0x00 is none) +1 byte encryption type (`0x00` is none) -1 byte compression type (0x00 is none) +1 byte compression type (`0x00` is none) ...metadata here...