Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 305a99eb authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

docs: aoe: convert docs to ReST and rename to *.rst 



There are only two files within Documentation/aoe dir that are
documentation. The remaining ones are examples and shell
scripts.

Convert the two AoE files to ReST format, and add the others
as literal, as they're part of the documentation.

At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 8afecfb0

Documentation/aoe/aoe.txt→Documentation/aoe/aoe.rst

+36 −29
Original line number Diff line number Diff line 
Introduction

============



ATA over Ethernet is a network protocol that provides simple access to

block storage on the LAN.
@@ -22,7 +25,8 @@ 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

  automatically, but to create all the necessary device nodes, use the
@@ -38,7 +42,8 @@ CREATING DEVICE NODES 
  confusing when an AoE device is not present the first time the a

  command is run but appears a second later.



USING DEVICE NODES

Using Device Nodes

==================



  "cat /dev/etherd/err" blocks, waiting for error diagnostic output,

  like any retransmitted packets.
@@ -55,7 +60,7 @@ USING DEVICE NODES 
  by sysfs counterparts.  Using the commands in aoetools insulates

  users from these implementation details.



  The block devices are named like this:

  The block devices are named like this::



	e{shelf}.{slot}

	e{shelf}.{slot}p{part}
@@ -64,7 +69,8 @@ USING DEVICE NODES 
  first shelf (shelf address zero).  That's the whole disk.  The first

  partition on that disk would be "e0.2p1".



USING SYSFS

Using sysfs

===========



  Each aoe block device in /sys/block has the extra attributes of

  state, mac, and netif.  The state attribute is "up" when the device
@@ -78,7 +84,7 @@ USING SYSFS 


  There is a script in this directory that formats this information in

  a convenient way.  Users with aoetools should use the aoe-stat

  command.

  command::



    root@makki root# sh Documentation/aoe/status.sh

       e10.0            eth3              up
@@ -113,12 +119,13 @@ USING SYSFS 
  for this purpose.  You can also directly use the

  /dev/etherd/discover special file described above.



DRIVER OPTIONS

Driver Options

==============



  There is a boot option for the built-in aoe driver and a

  corresponding module parameter, aoe_iflist.  Without this option,

  all network interfaces may be used for ATA over Ethernet.  Here is a

  usage example for the module parameter.

  usage example for the module parameter::



    modprobe aoe_iflist="eth1 eth3"

Documentation/aoe/examples.rst

0 → 100644
+23 −0
Original line number Diff line number Diff line 
Example of udev rules

---------------------



 .. include:: udev.txt

    :literal:



Example of udev install rules script

------------------------------------



 .. literalinclude:: udev-install.sh

    :language: shell



Example script to get status

----------------------------



 .. literalinclude:: status.sh

    :language: shell



Example of AoE autoload script

------------------------------



 .. literalinclude:: autoload.sh

    :language: shell

Documentation/aoe/index.rst

0 → 100644
+19 −0
Original line number Diff line number Diff line 
:orphan:



=======================

ATA over Ethernet (AoE)

=======================



.. toctree::

    :maxdepth: 1



    aoe

    todo

    examples



.. only::  subproject and html



   Indices

   =======



   * :ref:`genindex`

Documentation/aoe/todo.txt→Documentation/aoe/todo.rst

+3 −0
Original line number Diff line number Diff line 
TODO

====



There is a potential for deadlock when allocating a struct sk_buff for

data that needs to be written out to aoe storage.  If the data is

being written from a dirty page in order to free that page, and if

Documentation/aoe/udev.txt

+1 −1
Original line number Diff line number Diff line
@@ -11,7 +11,7 @@ 
#   udev_rules="/etc/udev/rules.d/"

#   bash# ls /etc/udev/rules.d/

#   10-wacom.rules  50-udev.rules

#   bash# cp /path/to/linux-2.6.xx/Documentation/aoe/udev.txt \

#   bash# cp /path/to/linux/Documentation/aoe/udev.txt \

#           /etc/udev/rules.d/60-aoe.rules

#