]> git.sesse.net Git - bcachefs-tools-debian/blobdiff - README
Add Apple addendums to .gitignore
[bcachefs-tools-debian] / README
diff --git a/README b/README
index 3e4ac29b20d82149fa0b450c419205a5cd283cfb..4a13db68cf47c73e7f44507aeed395c1265a38df 100644 (file)
--- a/README
+++ b/README
@@ -1 +1,27 @@
-Please add some description of what this package does
\ No newline at end of file
+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.
+
+bcache-super-show
+Prints the bcache superblock of a cache device or a backing device.