summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2011-08-25 17:10:46 +0100
committerLars Wirzenius <liw@liw.fi>2011-08-25 17:10:46 +0100
commit86f78a50ddfb8545c647b2d9d6c609b5bd782bbd (patch)
treeb1031f64950cfa58050215b5426f5455e8ac3184 /README
parent7dd07db8cdc1080536e304c9eb260e3253e776b3 (diff)
downloadlarch-86f78a50ddfb8545c647b2d9d6c609b5bd782bbd.tar.gz
Add note to README about when nodes actually are modified in place.
Diffstat (limited to 'README')
-rw-r--r--README4
1 files changed, 4 insertions, 0 deletions
diff --git a/README b/README
index 3ed8c07..1a0e581 100644
--- a/README
+++ b/README
@@ -13,6 +13,10 @@ things, this makes it easy to clone a tree, and modify only the clone, while
other processes access the original tree. This is utterly wonderful for my
backup application, and that's the reason I wrote larch in the first place.
+(The previous paragraph contains a small lie: larch does modify nodes in
+place, if they are not shared between trees. This is necessary for
+performance.)
+
I have tried to keep the implementation generic and flexibile, so that you
may use it in a variety of situations. For example, the tree itself does not
decide where its nodes are stored: you provide a class that does that for it.