[B.A.T.M.A.N.] [PATCH] batman-adv: Add batman-adv sysfs ABI documentation

[B.A.T.M.A.N.] [PATCH] batman-adv: Add batman-adv sysfs ABI documentation

[Sven Eckelmann]

The kernel requires to have all files in /sys documented and updated
when new files are added.

batman-adv has two important classes of files: one class for each mesh
device and one for a directory in all normal netdevice folders.

Signed-off-by: Sven Eckelmann <sven.eckelmann@gmx.de>
---
Following files needs to be documented:
 * fragmentation
 * gw_mode

 batman-adv/sysfs-class-net-batman-adv |   14 ++++++++++++++
 batman-adv/sysfs-class-net-mesh       |   33 +++++++++++++++++++++++++++++++++
 2 files changed, 47 insertions(+), 0 deletions(-)
 create mode 100644 batman-adv/sysfs-class-net-batman-adv
 create mode 100644 batman-adv/sysfs-class-net-mesh

diff --git a/batman-adv/sysfs-class-net-batman-adv b/batman-adv/sysfs-class-net-batman-adv
new file mode 100644
index 0000000..38dd762
--- /dev/null
+++ b/batman-adv/sysfs-class-net-batman-adv
@@ -0,0 +1,14 @@
+
+What:           /sys/class/net/<iface>/batman-adv/mesh_iface
+Date:           May 2010
+Contact:        Marek Lindner <lindner_marek@yahoo.de>
+Description:
+                The /sys/class/net/<iface>/batman-adv/mesh_iface file
+                displays the batman mesh interface this <iface>
+                currently is associated with.
+
+What:           /sys/class/net/<iface>/batman-adv/iface_status
+Date:           May 2010
+Contact:        Marek Lindner <lindner_marek@yahoo.de>
+Description:
+                Indicates the status of <iface> as it is seen by batman.
diff --git a/batman-adv/sysfs-class-net-mesh b/batman-adv/sysfs-class-net-mesh
new file mode 100644
index 0000000..5aa1912
--- /dev/null
+++ b/batman-adv/sysfs-class-net-mesh
@@ -0,0 +1,33 @@
+
+What:           /sys/class/net/<mesh_iface>/mesh/aggregated_ogms
+Date:           May 2010
+Contact:        Marek Lindner <lindner_marek@yahoo.de>
+Description:
+                Indicates whether the batman protocol messages of the
+                mesh <mesh_iface> shall be aggregated or not.
+
+What:           /sys/class/net/<mesh_iface>/mesh/bonding
+Date:           June 2010
+Contact:        Simon Wunderlich <siwu@hrz.tu-chemnitz.de>
+Description:
+                Indicates whether the data traffic going through the
+                mesh will be sent using multiple interfaces at the
+                same time (if available).
+
+What:           /sys/class/net/<mesh_iface>/mesh/orig_interval
+Date:           May 2010
+Contact:        Marek Lindner <lindner_marek@yahoo.de>
+Description:
+                Defines the interval in milliseconds in which batman
+                sends its protocol messages.
+
+What:           /sys/class/net/<mesh_iface>/mesh/vis_mode
+Date:           May 2010
+Contact:        Marek Lindner <lindner_marek@yahoo.de>
+Description:
+                Each batman node only maintains information about its
+                own local neighborhood, therefore generating graphs
+                showing the topology of the entire mesh is not easily
+                feasible without having a central instance to collect
+                the local topologies from all nodes. This file allows
+                to activate the collecting (server) mode.
-- 
1.7.2.3

Re: [B.A.T.M.A.N.] [PATCH] batman-adv: Add batman-adv sysfs ABI documentation

[Marek Lindner]

On Tuesday 12 October 2010 12:45:46 Sven Eckelmann wrote:
> The kernel requires to have all files in /sys documented and updated
> when new files are added.
> 
> batman-adv has two important classes of files: one class for each mesh
> device and one for a directory in all normal netdevice folders.

Applied in revision 1828.


> Following files needs to be documented:
>  * fragmentation

I will send a proposal in a second.


>  * gw_mode

Has to be cleaned up before we can submit it. I will post a series of patches 
to address the issue in the coming days.

Thanks,
Marek

[B.A.T.M.A.N.] [PATCH] batman-adv: document fragmentation sysfs API

[Marek Lindner]

Signed-off-by: Marek Lindner <lindner_marek@yahoo.de>
---
 batman-adv/sysfs-class-net-mesh |    8 ++++++++
 1 files changed, 8 insertions(+), 0 deletions(-)

diff --git a/batman-adv/sysfs-class-net-mesh b/batman-adv/sysfs-class-net-mesh
index 5aa1912..b4cdb60 100644
--- a/batman-adv/sysfs-class-net-mesh
+++ b/batman-adv/sysfs-class-net-mesh
@@ -14,6 +14,14 @@ Description:
                 mesh will be sent using multiple interfaces at the
                 same time (if available).
 
+What:           /sys/class/net/<mesh_iface>/mesh/fragmentation
+Date:           October 2010
+Contact:        Andreas Langer <an.langer@gmx.de>
+Description:
+                Indicates whether the data traffic going through the
+                mesh will be fragmented or silently discarded if the
+                packet size exceeds the outgoing interface MTU.
+
 What:           /sys/class/net/<mesh_iface>/mesh/orig_interval
 Date:           May 2010
 Contact:        Marek Lindner <lindner_marek@yahoo.de>
-- 
1.7.1

Re: [B.A.T.M.A.N.] [PATCH] batman-adv: document fragmentation sysfs API

[Marek Lindner]

On Friday 15 October 2010 17:56:12 Marek Lindner wrote:
> +Description:
> +                Indicates whether the data traffic going through the
> +                mesh will be fragmented or silently discarded if the
> +                packet size exceeds the outgoing interface MTU.

Applied in revision 1829.


Regards,
Marek