Skip to content

Commit 15e587c

Browse files
committed
Added error correction limits to config documentation
1 parent 202e1d8 commit 15e587c

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

ramcrc32bd.h

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,13 @@ extern "C"
2929
struct ramcrc32bd_config {
3030
// Size of a codeword in bytes.
3131
//
32+
// Smaller codewords have fewer collisions and we can correct more
33+
// bit errors:
34+
//
35+
// - code_size<=536870907 => 1 bit error correctable
36+
// - code_size<=371 => 2 bit errors correctable
37+
// - code_size<=21 => 3 bit errors correctable
38+
//
3239
// A crc32 is 4 bytes, so read_size and prog_size = code_size - 4.
3340
lfs_size_t code_size;
3441

0 commit comments

Comments
 (0)