Project

General

Profile

Bug #366

manpage: Missing description of gw_mode sel_class for B.A.T.M.A.N. V

Added by Sven Eckelmann 23 days ago. Updated 17 days ago.

Status:
Resolved
Priority:
Normal
Target version:
-
Start date:
11/22/2018
Due date:
% Done:

0%


Description

The commit 80b2d47be2c7 ("batman-adv: B.A.T.M.A.N. V - implement GW selection logic") introduced the new bandwidth based threshold for B.A.T.M.A.N. V. But as Martin Weinelt <> noticed, this information is not described in the batctl manpage. Instead, it defines only TQ thresholds for B.A.T.M.A.N. IV without mentioning that this information is actually only for IV and not V.

History

#1 Updated by Ruben Barkow 21 days ago

I added a small description here: https://www.open-mesh.org/projects/batman-adv/wiki/Gateways

maybe another issue, but: shouldn't the default value for gw.sel_class be 1500 or such if BATMAN_V is selected?

#2 Updated by Sven Eckelmann 21 days ago

maybe another issue, but: shouldn't the default value for gw.sel_class be 1500 or such if BATMAN_V is selected?

Why? The default value is now 5000 KBit/s for B.A.T.M.A.N. V and 20 for B.A.T.M.A.N. IV.

#3 Updated by Ruben Barkow 20 days ago

Ah ok, I didn't find that info.

#4 Updated by Ruben Barkow 19 days ago

So How do we add the changes from the wiki to the man page?

#5 Updated by Marek Lindner 19 days ago

Ruben Barkow wrote:

So How do we add the changes from the wiki to the man page?

You could propose a patch on the mailing list ?
The file that needs patching is this one here: https://git.open-mesh.org/batctl.git/blob_plain/refs/heads/master:/man/batctl.8

#6 Updated by Ruben Barkow 18 days ago

Ruben Barkow wrote:

Done, I sent to the mailinglist this patch:

again with formatting:

--- /tmp/smartgit7095787147690981841tmp/compare__827356725346254060_batctl.8
+++ /tmp/smartgit7095787147690981841tmp/compare__6833548133995178090_batctl.8
@@ -144,6 +144,9 @@
 If the node is a gateway client the parameter will decide which criteria to consider when the batman-adv module has to choose
 between different internet connections announced by the aforementioned servers.
 .RE
+.RS 9
+B.A.T.M.A.N. IV:
+.RE
 .RS 17
 default: 20 \-> late switch (TQ 20)
 .RE
@@ -166,6 +169,19 @@
 .RS 7
 chooses the gateway with the best link quality but switches to another gateway as soon as a better one is found which is at
 least XX TQ better than the currently selected gateway (XX has to be a number between 3 and 256).
+.RE
+.RE
+.RS 9
+B.A.T.M.A.N. V:
+.RE
+.RS 17
+default: 5000 \-> late switch (5000 kbit/s throughput)
+example: 1500 \-> fast switch connection
+.RS 16
+switches to another gateway as soon as a better one is found which is at least 
+1500 kbit/s faster throughput than the currently selected gateway. Throughput is
+determined by evaluating which is lower: the advertised throughput by the
+gateway or the maximum bandwidth across the entire path.
 .RE
 .RE
 .br

#7 Updated by Ruben Barkow 18 days ago

Ah, I found out ow to check the man page beforehand with

man -l batctl.8

and found a linebreak missing and one indention was wrong, so this is the final patch:
--- /tmp/smartgit7095787147690981841tmp/compare__8575517755482960147_batctl.8
+++ /tmp/smartgit7095787147690981841tmp/compare__711167554283092251_batctl.8
@@ -144,6 +144,9 @@
 If the node is a gateway client the parameter will decide which criteria to consider when the batman-adv module has to choose
 between different internet connections announced by the aforementioned servers.
 .RE
+.RS 7
+B.A.T.M.A.N. IV:
+.RE
 .RS 17
 default: 20 \-> late switch (TQ 20)
 .RE
@@ -166,6 +169,20 @@
 .RS 7
 chooses the gateway with the best link quality but switches to another gateway as soon as a better one is found which is at
 least XX TQ better than the currently selected gateway (XX has to be a number between 3 and 256).
+.RE
+.RE
+.RS 7
+B.A.T.M.A.N. V:
+.RE
+.RS 17
+default: 5000 \-> late switch (5000 kbit/s throughput)
+.br
+example: 1500 \-> fast switch connection
+.RS 17
+switches to another gateway as soon as a better one is found which is at least 
+1500 kbit/s faster throughput than the currently selected gateway. Throughput is
+determined by evaluating which is lower: the advertised throughput by the
+gateway or the maximum bandwidth across the entire path.
 .RE
 .RE
 .br

#8 Updated by Sven Eckelmann 18 days ago

  • Assignee changed from batman-adv developers to Antonio Quartulli
  • Status changed from New to In Progress

Patch was submitted: https://patchwork.open-mesh.org/patch/17665/ (please next time as inline patch)

#9 Updated by Sven Eckelmann 17 days ago

  • Status changed from In Progress to Resolved

Also available in: Atom PDF