[PATCH] Documentation: Add 00-INDEX file for AoE

[PATCH] Documentation: Add 00-INDEX file for AoE

[Jesper Juhl]

Documentation/aoe/ is missing a 00-INDEX file. Add one.

Signed-off-by: Jesper Juhl <jesper.juhl@gmail.com>
---

 00-INDEX |   18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

--- /dev/null	2005-11-21 04:22:37.000000000 +0100
+++ linux-2.6/Documentation/aoe/00-INDEX	2008-01-13 02:37:29.000000000 +0100
@@ -0,0 +1,18 @@
+00-INDEX
+	- this file.
+aoe.txt
+	- ATA over Ethernet (AoE) driver user guide and pointer to tools.
+autoload.sh
+	- script for making the AoE driver autoload via /etc/modprobe.conf.
+mkdevs.sh
+	- script for creating required AoE device nodes.
+mkshelf.sh
+	- script for making one shelf's worth of block device nodes.
+status.sh
+	- script to collate and present sysfs information about AoE storage.
+todo.txt
+	- list of things yet to be done for the AoE driver.
+udev-install.sh
+	- script to install the aoe-specific udev rules from udev.txt.
+udev.txt
+	- list of udev rules for AoE device node creation.

Re: [PATCH] Documentation: Add 00-INDEX file for AoE

[Randy Dunlap]

On Sun, 13 Jan 2008 02:44:48 +0100 (CET) Jesper Juhl wrote:

> Documentation/aoe/ is missing a 00-INDEX file. Add one.
> 
> Signed-off-by: Jesper Juhl <jesper.juhl@gmail.com>

Acked-by: Randy Dunlap <randy.dunlap@oracle.com>

Thanks, Jesper.

> ---
> 
>  00-INDEX |   18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
> 
> --- /dev/null	2005-11-21 04:22:37.000000000 +0100
> +++ linux-2.6/Documentation/aoe/00-INDEX	2008-01-13 02:37:29.000000000 +0100
> @@ -0,0 +1,18 @@
> +00-INDEX
> +	- this file.
> +aoe.txt
> +	- ATA over Ethernet (AoE) driver user guide and pointer to tools.
> +autoload.sh
> +	- script for making the AoE driver autoload via /etc/modprobe.conf.
> +mkdevs.sh
> +	- script for creating required AoE device nodes.
> +mkshelf.sh
> +	- script for making one shelf's worth of block device nodes.
> +status.sh
> +	- script to collate and present sysfs information about AoE storage.
> +todo.txt
> +	- list of things yet to be done for the AoE driver.
> +udev-install.sh
> +	- script to install the aoe-specific udev rules from udev.txt.
> +udev.txt
> +	- list of udev rules for AoE device node creation.

---
~Randy

Re: [PATCH] Documentation: Add 00-INDEX file for AoE

[Ed L. Cashin]

On Sun, Jan 13, 2008 at 02:44:48AM +0100, Jesper Juhl wrote:
> Documentation/aoe/ is missing a 00-INDEX file. Add one.

Thanks.  I think that it would help to clarify that using udev is the
norm, and that the mkdev and mkshelf scripts are just examples to show
how you could do it manually.

Signed-off-by: Ed L. Cashin <ecashin@coraid.com>

diff --git a/Documentation/aoe/00-INDEX b/Documentation/aoe/00-INDEX
index 8188b22..d087df6 100644
--- a/Documentation/aoe/00-INDEX
+++ b/Documentation/aoe/00-INDEX
@@ -5,9 +5,10 @@ aoe.txt
 autoload.sh
 	- script for making the AoE driver autoload via /etc/modprobe.conf.
 mkdevs.sh
-	- script for creating required AoE device nodes.
+	- script for creating required AoE device nodes without udev.
 mkshelf.sh
-	- script for making one shelf's worth of block device nodes.
+	- script for making one shelf's worth of block device nodes
+	  without udev.
 status.sh
 	- script to collate and present sysfs information about AoE storage.
 todo.txt
diff --git a/Documentation/aoe/mkdevs.sh b/Documentation/aoe/mkdevs.sh
index 97374aa..5870a6c 100644
--- a/Documentation/aoe/mkdevs.sh
+++ b/Documentation/aoe/mkdevs.sh
@@ -1,4 +1,7 @@
 #!/bin/sh
+# This example script shows how device nodes for interacting with the
+# aoe driver could be created in the absence of udev.  Using udev is
+# preferable to creating them manually.
 
 n_shelves=${n_shelves:-10}
 n_partitions=${n_partitions:-16}
diff --git a/Documentation/aoe/mkshelf.sh b/Documentation/aoe/mkshelf.sh
index 3261581..7f412f0 100644
--- a/Documentation/aoe/mkshelf.sh
+++ b/Documentation/aoe/mkshelf.sh
@@ -1,4 +1,7 @@
 #! /bin/sh
+# This example script shows how device nodes for interacting with the
+# aoe driver could be created in the absence of udev.  Using udev is
+# preferable to creating them manually.
 
 if test "$#" != "2"; then
 	echo "Usage: sh `basename $0` {dir} {shelfaddress}" 1>&2


-- 
  Ed L Cashin <ecashin@coraid.com>

Re: [PATCH] Documentation: Add 00-INDEX file for AoE

[Jesper Juhl]

On 14/01/2008, Ed L. Cashin <ecashin@coraid.com> wrote:
> On Sun, Jan 13, 2008 at 02:44:48AM +0100, Jesper Juhl wrote:
> > Documentation/aoe/ is missing a 00-INDEX file. Add one.
>
> Thanks.  I think that it would help to clarify that using udev is the
> norm, and that the mkdev and mkshelf scripts are just examples to show
> how you could do it manually.
>
> Signed-off-by: Ed L. Cashin <ecashin@coraid.com>
>
...

Thanks Ed.

I'll submit a new patch with your changes as well.
I've got a few more of these on the way, so I'll send them as a
complete series in a few days.

-- 
Jesper Juhl <jesper.juhl@gmail.com>
Don't top-post  http://www.catb.org/~esr/jargon/html/T/top-post.html
Plain text mails only, please      http://www.expita.com/nomime.html