Merge pull request #8666 from jepler/document-invariant-assumption

dhalbert · web-flow · commit 949a906d5a24 · 2023-11-28T16:07:54.000-05:00
note an assumed invariant that may not be obvious
diff --git a/supervisor/shared/translate/translate.c b/supervisor/shared/translate/translate.c
@@ -109,6 +109,7 @@ static int get_nbits(bitstream_state_t *st, int n) {
     return r;
 }
 
+// note: the vstr must be a fixed-buffer vstr that matches the decompressed length of the string
 static void decompress_vstr(mp_rom_error_text_t compressed, vstr_t *decompressed) {
     bitstream_state_t b = {
         .ptr = &(compressed->data) + (compress_max_length_bits >> 3),

Original file line number	Diff line number	Diff line change
`@@ -109,6 +109,7 @@ static int get_nbits(bitstream_state_t *st, int n) {`
`109`	`109`	`return r;`
`110`	`110`	`}`
`111`	`111`
	`112`	`+// note: the vstr must be a fixed-buffer vstr that matches the decompressed length of the string`
`112`	`113`	`static void decompress_vstr(mp_rom_error_text_t compressed, vstr_t *decompressed) {`
`113`	`114`	`bitstream_state_t b = {`
`114`	`115`	`.ptr = &(compressed->data) + (compress_max_length_bits >> 3),`