2018-02-19 18:17:52

by Aishwarya Pant

Subject: [PATCH v3] aoe: document sysfs interface

Documentation has been compiled from git commit logs and descriptions in
Documentation/aoe/aoe.txt. This should be useful for scripting and
tracking changes in the ABI.

Signed-off-by: Aishwarya Pant <[email protected]>
---
Changes in v3:
- name -> names in description of netif
v2:
- interface -> interfaces in description of netif

Documentation/ABI/testing/sysfs-block-aoe | 45 +++++++++++++++++++++++++++++++
1 file changed, 45 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-block-aoe

diff --git a/Documentation/ABI/testing/sysfs-block-aoe b/Documentation/ABI/testing/sysfs-block-aoe
new file mode 100644
index 000000000000..b5837765bcdd
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-block-aoe
@@ -0,0 +1,45 @@
+What: /sys/block/etherd*/mac
+Date: Apr, 2005
+KernelVersion: v2.6.12
+Contact: Ed L. Cashin <[email protected]>
+Description:
+ (RO) The ethernet address of the remote Ata over Ethernet (AoE)
+ device.
+
+What: /sys/block/etherd*/netif
+Date: Apr, 2005
+KernelVersion: v2.6.12
+Contact: Ed L. Cashin <[email protected]>
+Description:
+ (RO) The names of the network interfaces on the localhost (comma
+ separated) through which we are communicating with the remote
+ AoE device.
+
+What: /sys/block/etherd*/state
+Date: Apr, 2005
+KernelVersion: v2.6.12
+Contact: Ed L. Cashin <[email protected]>
+Description:
+ (RO) Device status. The state attribute is "up" when the device
+ is ready for I/O and "down" if detected but unusable. The
+ "down,closewait" state shows that the device is still open and
+ cannot come up again until it has been closed. The "up,kickme"
+ state means that the driver wants to send more commands to the
+ target but found out there were already the max number of
+ commands waiting for a response. It will retry again after being
+ kicked by the periodic timer handler routine.
+
+What: /sys/block/etherd*/firmware-version
+Date: Apr, 2005
+KernelVersion: v2.6.12
+Contact: Ed L. Cashin <[email protected]>
+Description:
+ (RO) Version of the firmware in the target.
+
+What: /sys/block/etherd*/payload
+Date: Dec, 2012
+KernelVersion: v3.10
+Contact: Ed L. Cashin <[email protected]>
+Description:
+ (RO) The amount of user data transferred (in bytes) inside each AoE
+ command on the network, network headers excluded.
--
2.16.1

2018-02-20 02:32:23

by Ed Cashin

Subject: Re: [PATCH v3] aoe: document sysfs interface

On 02/19/2018 01:16 PM, Aishwarya Pant wrote:
> Documentation has been compiled from git commit logs and descriptions in
> Documentation/aoe/aoe.txt. This should be useful for scripting and
> tracking changes in the ABI.

I don't see any problems with v3. Thank you.

--
Ed

2018-02-23 15:19:03

by Jonathan Corbet

Subject: Re: [PATCH v3] aoe: document sysfs interface

On Mon, 19 Feb 2018 23:46:53 +0530
Aishwarya Pant <[email protected]> wrote:

> Documentation has been compiled from git commit logs and descriptions in
> Documentation/aoe/aoe.txt. This should be useful for scripting and
> tracking changes in the ABI.
>
> Signed-off-by: Aishwarya Pant <[email protected]>

Applied to the docs tree, thanks.

jon