summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTushar Gohad <tushar.gohad@intel.com>2015-03-04 21:49:02 -0700
committerTushar Gohad <tushar.gohad@intel.com>2015-03-04 21:49:02 -0700
commitb9acd717696724f0a64c0da172330c38b1205ab8 (patch)
tree9519b20605740e861dd783eb9deae702cae7d9df
parent6f79145b908295dd9e94ad4dc2dd152d56611bed (diff)
downloadpyeclib-b9acd717696724f0a64c0da172330c38b1205ab8.tar.gz
Minor formatting fixes to the README
Signed-off-by: Tushar Gohad <tushar.gohad@intel.com>
-rw-r--r--README8
1 files changed, 7 insertions, 1 deletions
diff --git a/README b/README
index 307a709..92c9732 100644
--- a/README
+++ b/README
@@ -81,12 +81,14 @@ needs to be taken when handling input to and output from the ``encode()`` and
Reconstruct "missing_fragment_indexes" using "available_fragment_payloads"::
def reconstruct(self, available_fragment_payloads, missing_fragment_indexes)
+
-- Minimum parity fragments needed for durability gurantees
+- Minimum parity fragments needed for durability gurantees::
def min_parity_fragments_needed(self)
+
- Fragments needed for EC Reconstruct
@@ -95,6 +97,7 @@ needs to be taken when handling input to and output from the ``encode()`` and
def fragments_needed(self, missing_fragment_indexes)
+
- Get EC Metadata
Return an opaque buffer known by the underlying library::
@@ -102,6 +105,7 @@ needs to be taken when handling input to and output from the ``encode()`` and
def get_metadata(self, fragment)
+
- Verify EC Stripe Consistency
Use opaque buffers from get_metadata() to verify a the consistency of a stripe::
@@ -109,6 +113,7 @@ needs to be taken when handling input to and output from the ``encode()`` and
def verify_stripe_metadata(self, fragment_metadata_list)
+
- Get EC Segment Info
Return a dict with the keys - segment_size, last_segment_size, fragment_size, last_fragment_size and num_segments::
@@ -116,6 +121,7 @@ needs to be taken when handling input to and output from the ``encode()`` and
def get_segment_info(self, data_len, segment_size)
+
Quick Start:
Standard stuff to install::