summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorKent Overstreet <kent.overstreet@gmail.com>2011-02-13 07:01:10 -0800
committerKent Overstreet <kent.overstreet@gmail.com>2011-02-13 07:01:10 -0800
commit0b4b6fe2d3d668ace37f44e5a2297bb0ab51dafe (patch)
treed0d25c9d4e3cd1cf6d178f73a9c4d9a8d45131ce /README
parent04a54144fd304cfd8b4d54c72bdfa076b18d57b2 (diff)
Stuff
Diffstat (limited to 'README')
-rw-r--r--README24
1 files changed, 24 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..3aa525f
--- /dev/null
+++ b/README
@@ -0,0 +1,24 @@
+These are the userspace tools required for bcache.
+
+Bcache is a patch for the Linux kernel to use SSDs to cache other block
+devices. For more information, see http://bcache.evilpiepirate.org.
+Documentation for the run time interface is included in the kernel tree, in
+Documentantion/bcache.txt.
+
+Included tools:
+
+make-bcache
+Formats a block device for use with bcache. A device can be formatted for use
+as a cache or as a backing device (requires yet to be implemented kernel
+support). The most important option is for specifying the bucket size.
+Allocation is done in terms of buckets, and cache hits are counted per bucket;
+thus a smaller bucket size will give better cache utilization, but poorer write
+performance. The bucket size is intended to be equal to the size of your SSD's
+erase blocks, which seems to be 128k-512k for most SSDs; feel free to
+experiment.
+
+probe-bcache
+Only necessary until support for the bcache superblock is included
+in blkid; in the meantime, provides just enough functionality for a udev script
+to create the /dev/disk/by-uuid symlink. The arguments it does support are the
+same as for blkid.