Skip to content

Commit b9fb6b7

Browse files
committed
Update the documentation
1 parent baa96be commit b9fb6b7

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

HACKING

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Contributions to the vblade are welcome.
1+
Contributions to the vblade are welcome.
22

33
In contributing, though, please stay true to the original simplicity
44
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
77
without adding to the vblade itself.
88

99
Patches should be clean (to the point and easy to read) and should do
10-
one thing. Send multiple patches if necessary. Patches should be
10+
one thing. (Avoid, for example, mixing style changes with substantive
11+
changes.) Send multiple patches if necessary. Patches should be
1112
generated with "diff -uprN" if possible, and should be designed to be
1213
applied with "patch -p1".
1314

@@ -28,3 +29,8 @@ When you send your patch, here are some things to cover:
2829

2930
* If your changes affect the end-user experience, have you updated
3031
the vblade documentation?
32+
33+
* Is your email client able to send a patch without changing it?
34+
Many email clients and servers corrupt patches. Please test your
35+
email chain by sending an applying a patch before sending your
36+
patch to the mailing list.

README

+8-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@
22
INTRODUCTION
33
------------
44

5-
The vblade is the virtual EtherDrive (R) blade, a program that makes a
6-
seekable file available over an ethernet local area network (LAN) via
7-
the ATA over Ethernet (AoE) protocol.
5+
The vblade is a minimal ATA over Ethernet (AoE) storage target. Its
6+
focus is simplicity, not performance or richness of features. It
7+
exports a seekable file available over an ethernet local area network
8+
(LAN) via the AoE data storage protocol.
9+
10+
The name, "vblade," is historical: It is a virtual EtherDrive (R)
11+
blade. The first AoE target hardware sold by Coraid was in a blade
12+
form factor, ten to a 4-rack-unit chassis.
813

914
The seekable file is typically a block device like /dev/md0 but even
1015
regular files will work. Sparse files can be especially convenient.

0 commit comments

Comments
 (0)