Bug #366
closed
manpage: Missing description of gw_mode sel_class for B.A.T.M.A.N. V
Added by Sven Eckelmann almost 6 years ago.
Updated almost 6 years ago.
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 <martin@darmstadt.freifunk.net> 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.
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.
Ah ok, I didn't find that info.
So How do we add the changes from the wiki to the man page?
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
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
- Status changed from New to In Progress
- Assignee changed from batman-adv developers to Antonio Quartulli
- Status changed from In Progress to Resolved
- Status changed from Resolved to Closed
- Target version set to 2019.0
Also available in: Atom
PDF