From a9cd509daa10dd3247afa4ce7a62e71ad64e98e8 Mon Sep 17 00:00:00 2001 From: Patrick Niemeyer Date: Sat, 21 Oct 2023 13:13:21 -0500 Subject: [PATCH] storage: tweak docs. --- str-twincoding/README.md | 5 +++-- str-twincoding/examples.sh | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/str-twincoding/README.md b/str-twincoding/README.md index e100b22b9..b61d267bd 100644 --- a/str-twincoding/README.md +++ b/str-twincoding/README.md @@ -13,6 +13,7 @@ files, decoding files with erasures, and optimally recovering lost shards. See `twin_coding.py` for an explanation of the algorithm, example code, and a link to the original paper. + ## Installation ``` @@ -59,8 +60,8 @@ dd if=/dev/urandom of="file_1KB.dat" bs=1K count=1 cmp -s "file_1KB.dat" "recovered.dat" && echo "Passed" || echo "Failed" -# Generate shard recovery files: Using k (3) type 0 node sources (helper nodes), generate recovery -# files for restoration of node type 1 index 0. +# Generate shard recovery files for restoration of node type 1 index 0, using 3 (k) type 0 +# node sources (helper nodes), for helper_node in 0 1 2 do ./storage.sh generate_recovery_file \ diff --git a/str-twincoding/examples.sh b/str-twincoding/examples.sh index 8186d3a71..9e8f811f4 100644 --- a/str-twincoding/examples.sh +++ b/str-twincoding/examples.sh @@ -19,8 +19,8 @@ dd if=/dev/urandom of="file_1KB.dat" bs=1K count=1 cmp -s "file_1KB.dat" "recovered.dat" && echo "Passed" || echo "Failed" -# Generate shard recovery files: Using k (3) type 0 node sources (helper nodes), generate recovery -# files for restoration of node type 1 index 0. +# Generate shard recovery files for restoration of node type 1 index 0, using 3 (k) type 0 +# node sources (helper nodes), for helper_node in 0 1 2 do ./storage.sh generate_recovery_file \