Added some ascii art over the on-disk encodings

I find these little diagrams useful for visualizing the actual on-disk encoding, which doesn't really exist in the code outside of the lfsr_data_from* and lfsr_data_read* functions.
2024-02-09 16:07:06 -06:00
parent af5e3f7d2a
commit a8a738e434
2 changed files with 88 additions and 35 deletions
@@ -370,9 +370,15 @@ typedef struct lfsr_opened {
    lfsr_mdir_t mdir;
 } lfsr_opened_t;

-// space for:
-// - type   - 1 leb128 - 1 byte (worst case)
-// - 2 mids - 2 leb128 - 10 bytes (worst case)
+// grm encoding:
+// .---.
+// |mod|                  mode:  1 byte
+// +- -+- -+- -+- -+- -.
+// ' mid x mod         '  mids:  <=2x5 bytes
+// +                   +  total: <=11 bytes
+// '                   '
+// '- -+- -+- -+- -+- -'
+//
 #define LFSR_GRM_DSIZE (1+5+5)

 typedef struct lfsr_grm {