aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorEd L Cashin <ecashin@coraid.com>2005-04-29 10:24:18 -0400
committerGreg KH <gregkh@suse.de>2005-05-04 02:34:54 -0400
commit67d9f84786cc4fd42cb40c9474c248eadaff15c6 (patch)
treef1ef2e8c1d1f1b21969704666f20ac1dbec42197 /Documentation
parentc59a24dc512952cb434b34a66c3792555159fa36 (diff)
[PATCH] aoe: update the documentation to mention aoetools
update the documentation to mention aoetools Signed-off-by: Ed L. Cashin <ecashin@coraid.com> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/aoe/aoe.txt29
1 files changed, 19 insertions, 10 deletions
diff --git a/Documentation/aoe/aoe.txt b/Documentation/aoe/aoe.txt
index 1212987a30fa..3a4dbe4663c9 100644
--- a/Documentation/aoe/aoe.txt
+++ b/Documentation/aoe/aoe.txt
@@ -4,6 +4,16 @@ The EtherDrive (R) HOWTO for users of 2.6 kernels is found at ...
4 4
5 It has many tips and hints! 5 It has many tips and hints!
6 6
7The aoetools are userland programs that are designed to work with this
8driver. The aoetools are on sourceforge.
9
10 http://aoetools.sourceforge.net/
11
12The scripts in this Documentation/aoe directory are intended to
13document the use of the driver and are not necessary if you install
14the aoetools.
15
16
7CREATING DEVICE NODES 17CREATING DEVICE NODES
8 18
9 Users of udev should find the block device nodes created 19 Users of udev should find the block device nodes created
@@ -33,19 +43,17 @@ USING DEVICE NODES
33 "cat /dev/etherd/err" blocks, waiting for error diagnostic output, 43 "cat /dev/etherd/err" blocks, waiting for error diagnostic output,
34 like any retransmitted packets. 44 like any retransmitted packets.
35 45
36 The /dev/etherd/interfaces special file is obsoleted by the
37 aoe_iflist boot option and module option (and its sysfs entry
38 described in the next section).
39 "echo eth2 eth4 > /dev/etherd/interfaces" tells the aoe driver to 46 "echo eth2 eth4 > /dev/etherd/interfaces" tells the aoe driver to
40 limit ATA over Ethernet traffic to eth2 and eth4. AoE traffic from 47 limit ATA over Ethernet traffic to eth2 and eth4. AoE traffic from
41 untrusted networks should be ignored as a matter of security. 48 untrusted networks should be ignored as a matter of security. See
49 also the aoe_iflist driver option described below.
42 50
43 "echo > /dev/etherd/discover" tells the driver to find out what AoE 51 "echo > /dev/etherd/discover" tells the driver to find out what AoE
44 devices are available. 52 devices are available.
45 53
46 These character devices may disappear and be replaced by sysfs 54 These character devices may disappear and be replaced by sysfs
47 counterparts, so distribution maintainers are encouraged to create 55 counterparts. Using the commands in aoetools insulates users from
48 scripts that use these devices. 56 these implementation details.
49 57
50 The block devices are named like this: 58 The block devices are named like this:
51 59
@@ -69,7 +77,8 @@ USING SYSFS
69 through which we are communicating with the remote AoE device. 77 through which we are communicating with the remote AoE device.
70 78
71 There is a script in this directory that formats this information 79 There is a script in this directory that formats this information
72 in a convenient way. 80 in a convenient way. Users with aoetools can use the aoe-stat
81 command.
73 82
74 root@makki root# sh Documentation/aoe/status.sh 83 root@makki root# sh Documentation/aoe/status.sh
75 e10.0 eth3 up 84 e10.0 eth3 up
@@ -100,9 +109,9 @@ USING SYSFS
100 sysfs entry can be read from as well as written to. 109 sysfs entry can be read from as well as written to.
101 110
102 It's helpful to trigger discovery after setting the list of allowed 111 It's helpful to trigger discovery after setting the list of allowed
103 interfaces. If your distro provides an aoe-discover script, you can 112 interfaces. The aoetools package provides an aoe-discover script
104 use that. Otherwise, you can directly use the /dev/etherd/discover 113 for this purpose. You can also directly use the
105 file described above. 114 /dev/etherd/discover special file described above.
106 115
107DRIVER OPTIONS 116DRIVER OPTIONS
108 117