batman-adv: Adding sysfs API documentation for hop_penalty

Message ID 1287396119-7796-1-git-send-email-linus.luessing@ascom.ch (mailing list archive)
State Superseded, archived
Headers

Commit Message

Linus Lüssing Oct. 18, 2010, 10:01 a.m. UTC
  Signed-off-by: Linus Lüssing <linus.luessing@ascom.ch>
---
 sysfs-class-net-mesh |   12 ++++++++++++
 1 files changed, 12 insertions(+), 0 deletions(-)
  

Comments

Marek Lindner Oct. 18, 2010, 10:11 a.m. UTC | #1
On Monday 18 October 2010 12:01:59 Linus Lüssing wrote:
> +               Defines the penalty which will be applied to an
> +               originator message's tq-field on every hop. In a
> +               mixed topology of static and mobile nodes, it might
> +               be desired to increase this value on the mobile ones
> +               instead of increasing the originator interval
> +               everywhere - or even set it to its maximum to disable
> +               forwarding on a node.

Sorry, but I don't quite understand the connection between hop penalty and 
orig interval that you are trying to make here. The orig interval regulates 
the interval in which the network is flooded with topology information whereas 
the hop penalty influences the likelihood of being chosen as a "hop" towards a 
destination.

Regards,
Marek
  

Patch

diff --git a/sysfs-class-net-mesh b/sysfs-class-net-mesh
index 5aa1912..f3f9070 100644
--- a/sysfs-class-net-mesh
+++ b/sysfs-class-net-mesh
@@ -21,6 +21,18 @@  Description:
                 Defines the interval in milliseconds in which batman
                 sends its protocol messages.
 
+What:           /sys/class/net/<mesh_iface>/mesh/hop_penalty
+Date:           Oct 2010
+Contact:        Linus Lüssing <linus.luessing@web.de>
+Description:
+		Defines the penalty which will be applied to an
+		originator message's tq-field on every hop. In a
+		mixed topology of static and mobile nodes, it might
+		be desired to increase this value on the mobile ones
+		instead of increasing the originator interval
+		everywhere - or even set it to its maximum to disable
+		forwarding on a node.
+
 What:           /sys/class/net/<mesh_iface>/mesh/vis_mode
 Date:           May 2010
 Contact:        Marek Lindner <lindner_marek@yahoo.de>