From: Simon Ruderich <simon@ruderich.org>
Date: Fri, 2 Aug 2019 05:35:18 +0000 (+0200)
Subject: README: clarify indices are not stored in separate files
X-Git-Tag: 0.1~27
X-Git-Url: https://ruderich.org/simon/gitweb/?p=nsscash%2Fnsscash.git;a=commitdiff_plain;h=db3be9251d95b15bb4dc49095b7d5c69258ba3e4

README: clarify indices are not stored in separate files
---

diff --git a/README b/README
index b5a60ab..4febddf 100644
--- a/README
+++ b/README
@@ -19,7 +19,8 @@ lookups. To support quick lookups, in O(log n), the files utilize indices.
 
 Nsscash is very careful when deploying the changes:
 - All files are updated using the standard "write to temporary file", "sync",
-  "rename" steps which is atomic on UNIX file systems.
+  "rename" steps which is atomic on UNIX file systems. The indices are stored
+  in the same file preventing stale data during the update.
 - All errors cause an immediate abort ("fail fast") with a proper error
   message and a non-zero exit status. This prevents hiding possibly important
   errors. In addition all files are fetched first and then deployed to try to