[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>
This commit is contained in:
Ed L Cashin 2005-04-29 10:24:18 -04:00 committed by Greg KH
parent c59a24dc51
commit 67d9f84786

View file

@ -4,6 +4,16 @@ The EtherDrive (R) HOWTO for users of 2.6 kernels is found at ...
It has many tips and hints! It has many tips and hints!
The aoetools are userland programs that are designed to work with this
driver. The aoetools are on sourceforge.
http://aoetools.sourceforge.net/
The scripts in this Documentation/aoe directory are intended to
document the use of the driver and are not necessary if you install
the aoetools.
CREATING DEVICE NODES CREATING DEVICE NODES
Users of udev should find the block device nodes created Users of udev should find the block device nodes created
@ -33,19 +43,17 @@ USING DEVICE NODES
"cat /dev/etherd/err" blocks, waiting for error diagnostic output, "cat /dev/etherd/err" blocks, waiting for error diagnostic output,
like any retransmitted packets. like any retransmitted packets.
The /dev/etherd/interfaces special file is obsoleted by the
aoe_iflist boot option and module option (and its sysfs entry
described in the next section).
"echo eth2 eth4 > /dev/etherd/interfaces" tells the aoe driver to "echo eth2 eth4 > /dev/etherd/interfaces" tells the aoe driver to
limit ATA over Ethernet traffic to eth2 and eth4. AoE traffic from limit ATA over Ethernet traffic to eth2 and eth4. AoE traffic from
untrusted networks should be ignored as a matter of security. untrusted networks should be ignored as a matter of security. See
also the aoe_iflist driver option described below.
"echo > /dev/etherd/discover" tells the driver to find out what AoE "echo > /dev/etherd/discover" tells the driver to find out what AoE
devices are available. devices are available.
These character devices may disappear and be replaced by sysfs These character devices may disappear and be replaced by sysfs
counterparts, so distribution maintainers are encouraged to create counterparts. Using the commands in aoetools insulates users from
scripts that use these devices. these implementation details.
The block devices are named like this: The block devices are named like this:
@ -69,7 +77,8 @@ USING SYSFS
through which we are communicating with the remote AoE device. through which we are communicating with the remote AoE device.
There is a script in this directory that formats this information There is a script in this directory that formats this information
in a convenient way. in a convenient way. Users with aoetools can use the aoe-stat
command.
root@makki root# sh Documentation/aoe/status.sh root@makki root# sh Documentation/aoe/status.sh
e10.0 eth3 up e10.0 eth3 up
@ -100,9 +109,9 @@ USING SYSFS
sysfs entry can be read from as well as written to. sysfs entry can be read from as well as written to.
It's helpful to trigger discovery after setting the list of allowed It's helpful to trigger discovery after setting the list of allowed
interfaces. If your distro provides an aoe-discover script, you can interfaces. The aoetools package provides an aoe-discover script
use that. Otherwise, you can directly use the /dev/etherd/discover for this purpose. You can also directly use the
file described above. /dev/etherd/discover special file described above.
DRIVER OPTIONS DRIVER OPTIONS