diff mbox

[10/10] Documentation: ABI: Add information about batman-adv sysfs entries

Message ID 1274537833-2512-10-git-send-email-sven.eckelmann@gmx.de
State Not Applicable, archived
Headers show

Commit Message

Sven Eckelmann May 22, 2010, 2:17 p.m. UTC
From: Marek Lindner <lindner_marek@yahoo.de>

Add documents about new sysfs entries in
 * /sys/class/net/<iface>/batman-adv/mesh_iface
 * /sys/class/net/<mesh_iface>/mesh/vis_mode

Signed-off-by: Marek Lindner <lindner_marek@yahoo.de>
Signed-off-by: Sven Eckelmann <sven.eckelmann@gmx.de>
---
 .../ABI/testing/sysfs-class-net-batman-adv         |   14 ++++++++++
 Documentation/ABI/testing/sysfs-class-net-mesh     |   27 ++++++++++++++++++++
 2 files changed, 41 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/ABI/testing/sysfs-class-net-batman-adv
 create mode 100644 Documentation/ABI/testing/sysfs-class-net-mesh

Comments

Greg KH May 22, 2010, 2:32 p.m. UTC | #1
On Sat, May 22, 2010 at 04:17:13PM +0200, Sven Eckelmann wrote:
> From: Marek Lindner <lindner_marek@yahoo.de>
> 
> Add documents about new sysfs entries in
>  * /sys/class/net/<iface>/batman-adv/mesh_iface
>  * /sys/class/net/<mesh_iface>/mesh/vis_mode
> 
> Signed-off-by: Marek Lindner <lindner_marek@yahoo.de>
> Signed-off-by: Sven Eckelmann <sven.eckelmann@gmx.de>
> ---
>  .../ABI/testing/sysfs-class-net-batman-adv         |   14 ++++++++++
>  Documentation/ABI/testing/sysfs-class-net-mesh     |   27 ++++++++++++++++++++

For now, can you keep this within the drivers/staging/batman/ directory,
just so everything is nice and self-contained?  When it moves to the
main part of the kernel tree, then it can move into the
Documentation/ABI/testing/ directory, ok?

> +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. Once
> +                activated the topology can be retrieved by reading
> +                the vis_data file.

Isn't the vis_data file in debugfs now?  If so, shouldn't this file move
there as well?  Or at least don't point to a file that doesn't exist in
sysfs :)

thanks,

greg k-h
Sven Eckelmann May 22, 2010, 3:01 p.m. UTC | #2
Greg KH wrote:
> On Sat, May 22, 2010 at 04:17:13PM +0200, Sven Eckelmann wrote:
> > From: Marek Lindner <lindner_marek@yahoo.de>
> > 
> > Add documents about new sysfs entries in
> > 
> >  * /sys/class/net/<iface>/batman-adv/mesh_iface
> >  * /sys/class/net/<mesh_iface>/mesh/vis_mode
> > 
> > Signed-off-by: Marek Lindner <lindner_marek@yahoo.de>
> > Signed-off-by: Sven Eckelmann <sven.eckelmann@gmx.de>
> > ---
> > 
> >  .../ABI/testing/sysfs-class-net-batman-adv         |   14 ++++++++++
> >  Documentation/ABI/testing/sysfs-class-net-mesh     |   27
> >  ++++++++++++++++++++
> 
> For now, can you keep this within the drivers/staging/batman/ directory,
> just so everything is nice and self-contained?  When it moves to the
> main part of the kernel tree, then it can move into the
> Documentation/ABI/testing/ directory, ok?
> 
> > +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. Once
> > +                activated the topology can be retrieved by reading
> > +                the vis_data file.
> 
> Isn't the vis_data file in debugfs now?  If so, shouldn't this file move
> there as well?  Or at least don't point to a file that doesn't exist in
> sysfs :)

No, vis_data is the output. vis_mode says if a node is a client or a server. A 
server can generate that output... but as vis_mode and vis_data are two 
different things, I think that not both must be moved to debugfs. For example 
a client should be able to move into client mode or read his current status 
without having debugfs compiled inside his kernel - the client will never get 
the output vis_data, so it isn't important for him to have debugfs. But I will 
remove that sentence.

Best regards,
	Sven
diff mbox

Patch

diff --git a/Documentation/ABI/testing/sysfs-class-net-batman-adv b/Documentation/ABI/testing/sysfs-class-net-batman-adv
new file mode 100644
index 0000000..38dd762
--- /dev/null
+++ b/Documentation/ABI/testing/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/Documentation/ABI/testing/sysfs-class-net-mesh b/Documentation/ABI/testing/sysfs-class-net-mesh
new file mode 100644
index 0000000..0d96c9d
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-class-net-mesh
@@ -0,0 +1,27 @@ 
+
+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/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. Once
+                activated the topology can be retrieved by reading
+                the vis_data file.