From 19bc1e0ce3aa370e7de67c6f63cafa7adf8ea207 Mon Sep 17 00:00:00 2001
From: nygard_89 <gugly89@gmail.com>
Date: Wed, 13 Apr 2016 23:32:58 +0200
Subject: [PATCH] [riak] Fixed README.md file.

---
 riak/README.md | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/riak/README.md b/riak/README.md
index 8c3a2817..74a30e29 100644
--- a/riak/README.md
+++ b/riak/README.md
@@ -33,23 +33,23 @@ storage_backend = leveldb
 ```
 
 Create a bucket type named "ycsb"<sup id="a1">[1](#f1)</sup> by logging into one of the nodes in your cluster. 
-Then, if you want to use the <i>eventual consistency model</i> (default), you have to follow the next two steps.
+Then, if you want to use the <i>eventual consistency model</i> (default), type:
 
 ```
 riak-admin bucket-type create ycsb '{"props":{"allow_mult":"false"}}'
 riak-admin bucket-type activate ycsb
 ```
 
-If instead you want to use the <i>strong consistency model</i> implemented in Riak, then type:
+If instead you want to use the <i>strong consistency model</i><sup id="a2">[2](#f2)</sup> implemented in Riak, then you have to follow the next two steps.
 
 1) In every `riak.conf` file, search for the `##strong_consistency=on` line and uncomment it. It is important that you do this <b>before you start your cluster</b>!
 
 2) Run the following riak-admin commands:
 
-    ```
-    riak-admin bucket-type create ycsb '{"props":{"allow_mult":"false","consistent":true}}'
-    riak-admin bucket-type activate ycsb
-    ```
+```
+riak-admin bucket-type create ycsb '{"props":{"allow_mult":"false","consistent":true}}'
+riak-admin bucket-type activate ycsb
+```
 
 Note that you may want to specify the number of replicas to create for each object. To do so, you can add `"n_val":N` to the list of properties shown above (by default `N` is set to 3).
 
@@ -60,7 +60,7 @@ You can either specify these configuration parameters via command line or set th
 * `riak.hosts` - <b>string list</b>, comma separated list of IPs or FQDNs. <newline>Example: `riak.hosts=127.0.0.1,127.0.0.2,127.0.0.3` or `riak.hosts=riak1.mydomain.com,riak2.mydomain.com,riak3.mydomain.com`.
 * `riak.port` - <b>int</b>, the port on which every node is listening. It must match the one specified in the `riak.conf` file at the line `listener.protobuf.internal`.
 * `riak.bucket_type` - <b>string</b>, it must match the value of the bucket type created during setup (see section above).
-* `riak.r_val` - <b>int</b>, the R value represents the number of Riak nodes that must return results for a read before the read is considered successful.
+* `riak.r_val` - <b>int</b>, the R value represents the number of Riak nodes that must return results for a read before the read is considered successfully completed.
 * `riak.w_val` - <b>int</b>, the W value represents the number of Riak nodes that must report success before an update is considered complete.
 * `riak.read_retry_count` - <b>int</b>, the number of times the client will try to read a key from Riak.
 * `riak.wait_time_before_retry` - <b>int</b>, the time (in milliseconds) before client attempts to perform another read if the previous one failed.
@@ -71,3 +71,4 @@ You can either specify these configuration parameters via command line or set th
 <b>Note</b>: For more information on workloads and how to run them please see: https://github.com/brianfrankcooper/YCSB/wiki/Running-a-Workload
 
 <b id="f1">1</b> As specified in the `riak.properties` file.  See parameters configuration section for further info. [↩](#a1)
+<b id="f2">2</b> <b>IMPORTANT NOTE:</b> Currently the `scan` transactions are <b>NOT SUPPORTED</b> for the benchmarks which use the strong consistency model! However this will not cause the benchmark to fail, but simply it won't perform any scan transaction at all. [↩](#a2)
-- 
GitLab