Permalink
Browse files

Update the documentation

  • Loading branch information...
1 parent baa96be commit b9fb6b7c766c07de3a645599f43ab4c3190631ee @ecashin ecashin committed May 20, 2014
Showing with 16 additions and 5 deletions.
  1. +8 −2 HACKING
  2. +8 −3 README
View
10 HACKING
@@ -1,4 +1,4 @@
-Contributions to the vblade are welcome.
+Contributions to the vblade are welcome.
In contributing, though, please stay true to the original simplicity
of the software. Many open source projects suffer from the "creeping
@@ -7,7 +7,8 @@ feature, first seriously try to think of a way to accomplish your goal
without adding to the vblade itself.
Patches should be clean (to the point and easy to read) and should do
-one thing. Send multiple patches if necessary. Patches should be
+one thing. (Avoid, for example, mixing style changes with substantive
+changes.) Send multiple patches if necessary. Patches should be
generated with "diff -uprN" if possible, and should be designed to be
applied with "patch -p1".
@@ -28,3 +29,8 @@ When you send your patch, here are some things to cover:
* If your changes affect the end-user experience, have you updated
the vblade documentation?
+
+ * Is your email client able to send a patch without changing it?
+ Many email clients and servers corrupt patches. Please test your
+ email chain by sending an applying a patch before sending your
+ patch to the mailing list.
View
11 README
@@ -2,9 +2,14 @@
INTRODUCTION
------------
-The vblade is the virtual EtherDrive (R) blade, a program that makes a
-seekable file available over an ethernet local area network (LAN) via
-the ATA over Ethernet (AoE) protocol.
+The vblade is a minimal ATA over Ethernet (AoE) storage target. Its
+focus is simplicity, not performance or richness of features. It
+exports a seekable file available over an ethernet local area network
+(LAN) via the AoE data storage protocol.
+
+The name, "vblade," is historical: It is a virtual EtherDrive (R)
+blade. The first AoE target hardware sold by Coraid was in a blade
+form factor, ten to a 4-rack-unit chassis.
The seekable file is typically a block device like /dev/md0 but even
regular files will work. Sparse files can be especially convenient.

0 comments on commit b9fb6b7

Please sign in to comment.