From 5235aa1adbd7ee219d2fa5f2ba7458a3bf092b1e Mon Sep 17 00:00:00 2001 From: martinsumner Date: Tue, 28 Feb 2017 00:15:06 +0000 Subject: [PATCH] Updated docs --- README.md | 2 +- docs/FUTURE.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 225e072..5676871 100644 --- a/README.md +++ b/README.md @@ -100,4 +100,4 @@ This will start a new Bookie. It will start and look for existing data files, u The book_start method should respond once startup is complete. The leveled_bookie module includes the full API for external use of the store. -Read through the [end_to_end test suites](test/end_to_end/) for further guidance. +Running in Riak requires one of the branches of riak_kv referenced [here](docs/FUTURE.md). There is a [Riak branch](https://github.com/martinsumner/riak/tree/mas-leveleddb) intended to support the automatic build of this, and the configuration via cuttlefish. However, the auto-build fails due to other dependencies bringing in an alternative version of riak_kv, and the configuration via cuttlefish is broken for reasons unknown. Building this from source as part of Riak will require a bit of fiddling around. \ No newline at end of file diff --git a/docs/FUTURE.md b/docs/FUTURE.md index 9146f7a..831a27d 100644 --- a/docs/FUTURE.md +++ b/docs/FUTURE.md @@ -114,4 +114,6 @@ The other n-1 vnodes must also do a local GET before the vnode PUT (so as not to This branch changes the behaviour slightly at the non-coordinating vnodes. These vnodes will now try a HEAD request before the local PUT (not a GET request), and if the HEAD request contains a vclock which is dominated by the updated PUT, it will not attempt to fetch the whole object for the syntactic merge. -This should save two object fetches (where n=3) in most circumstances. \ No newline at end of file +This should save two object fetches (where n=3) in most circumstances. + +Note, although the branch name refers to the put fsm - the actual fsm is unchanged by this, all of the changes are within vnode_put \ No newline at end of file