lkml.org 
[lkml]   [2019]   [Apr]   [15]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 03/57] docs: aoe: convert text files to ReST
    Date
    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.

    Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
    ---
    Documentation/aoe/aoe.txt | 63 +++++++++++++++++++++-----------------
    Documentation/aoe/todo.txt | 3 ++
    Documentation/aoe/udev.txt | 2 +-
    3 files changed, 39 insertions(+), 29 deletions(-)

    diff --git a/Documentation/aoe/aoe.txt b/Documentation/aoe/aoe.txt
    index c71487d399d1..58747ecec71d 100644
    --- a/Documentation/aoe/aoe.txt
    +++ b/Documentation/aoe/aoe.txt
    @@ -1,3 +1,6 @@
    +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,29 +84,29 @@ 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
    - e10.1 eth3 up
    - e10.2 eth3 up
    - e10.3 eth3 up
    - e10.4 eth3 up
    - e10.5 eth3 up
    - e10.6 eth3 up
    - e10.7 eth3 up
    - e10.8 eth3 up
    - e10.9 eth3 up
    - e4.0 eth1 up
    - e4.1 eth1 up
    - e4.2 eth1 up
    - e4.3 eth1 up
    - e4.4 eth1 up
    - e4.5 eth1 up
    - e4.6 eth1 up
    - e4.7 eth1 up
    - e4.8 eth1 up
    - e4.9 eth1 up
    + root@makki root# sh Documentation/aoe/status.sh
    + e10.0 eth3 up
    + e10.1 eth3 up
    + e10.2 eth3 up
    + e10.3 eth3 up
    + e10.4 eth3 up
    + e10.5 eth3 up
    + e10.6 eth3 up
    + e10.7 eth3 up
    + e10.8 eth3 up
    + e10.9 eth3 up
    + e4.0 eth1 up
    + e4.1 eth1 up
    + e4.2 eth1 up
    + e4.3 eth1 up
    + e4.4 eth1 up
    + e4.5 eth1 up
    + e4.6 eth1 up
    + e4.7 eth1 up
    + e4.8 eth1 up
    + e4.9 eth1 up

    Use /sys/module/aoe/parameters/aoe_iflist (or better, the driver
    option discussed below) instead of /dev/etherd/interfaces to limit
    @@ -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"

    diff --git a/Documentation/aoe/todo.txt b/Documentation/aoe/todo.txt
    index c09dfad4aed8..dea8db5a33e1 100644
    --- a/Documentation/aoe/todo.txt
    +++ b/Documentation/aoe/todo.txt
    @@ -1,3 +1,6 @@
    +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
    diff --git a/Documentation/aoe/udev.txt b/Documentation/aoe/udev.txt
    index 1f06daf03f5b..54feda5a0772 100644
    --- a/Documentation/aoe/udev.txt
    +++ b/Documentation/aoe/udev.txt
    @@ -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
    #

    --
    2.20.1
    \
     
     \ /
      Last update: 2019-04-16 05:03    [W:4.576 / U:0.080 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site