After the infamous "neighbo(u)rs" patches, I wanted to send some more release critical fixes. :)
There are just some possible problems found by Debian's lintian (or by me after searching for more typos) which could easily fixed by upstream. No big changes, but some letters exchanged.
There is also some sentence in the batman manpage which should maybe changed. Maybe a native english speaking person could check if it is valid and understandable.
"B.A.T.M.A.N tries to find the best available connection by watching the uplinks throughput and the link quality."
Debian's Lintian detected different smaller typographical errors in the source code and manpages of batctl.
* preceeding -> preceding * simliar -> similar
Signed-off-by: Sven Eckelmann sven.eckelmann@gmx.de --- batctl/bisect.c | 4 ++-- batctl/man/batctl.8 | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/batctl/bisect.c b/batctl/bisect.c index e3d7463..1939613 100644 --- a/batctl/bisect.c +++ b/batctl/bisect.c @@ -197,7 +197,7 @@ static int routing_table_new(char *orig, char *next_hop, char *old_next_hop, cha int i, j;
if (!curr_bat_node) { - fprintf(stderr, "Routing table change without preceeding OGM - skipping"); + fprintf(stderr, "Routing table change without preceding OGM - skipping"); goto err; }
@@ -225,7 +225,7 @@ static int routing_table_new(char *orig, char *next_hop, char *old_next_hop, cha goto err;
if (list_empty(&orig_event->event_list)) { - fprintf(stderr, "Routing table change without any preceeding OGM of that originator - skipping"); + fprintf(stderr, "Routing table change without any preceding OGM of that originator - skipping"); goto err; }
diff --git a/batctl/man/batctl.8 b/batctl/man/batctl.8 index 1aa68df..311fca3 100644 --- a/batctl/man/batctl.8 +++ b/batctl/man/batctl.8 @@ -96,7 +96,7 @@ Analyzes the logfiles to build a small internal database of all sent sequence nu .SH FILES .TP .I "\fBbat-hosts\fP" -This file is simliar to the /etc/hosts file. You can write one mac address and one host name per line. batctl will search for bat-hosts in /etc, your home directory and the current directory. The found data is used to match mac address to your provided host name or replace mac addresses in debug output and logs. Host names are much easier to remember than mac addresses. +This file is similar to the /etc/hosts file. You can write one mac address and one host name per line. batctl will search for bat-hosts in /etc, your home directory and the current directory. The found data is used to match mac address to your provided host name or replace mac addresses in debug output and logs. Host names are much easier to remember than mac addresses. .SH AUTHOR batctl was written by Andreas Langer a.langer@q-dsl.de and Marek Lindner lindner_marek@yahoo.de. .PP
groff differentiate between minus signs and hyphens. The default option is to interpret '-' as hyphens (U+2010) and makes it hard to use copy and paste for options in UTF-8 environments.
See http://lists.debian.org/debian-devel/2003/03/msg01481.html for more informations.
Signed-off-by: Sven Eckelmann sven.eckelmann@gmx.de --- batctl/man/batctl.8 | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/batctl/man/batctl.8 b/batctl/man/batctl.8 index 311fca3..304168c 100644 --- a/batctl/man/batctl.8 +++ b/batctl/man/batctl.8 @@ -91,7 +91,7 @@ Layer 2 traceroute mac address or bat-host name (batctl will try to find bat-h Per default batctl will display all packets that were seen on the given interface(s). The "-p" options allows to filter certain packet types: 1 displays batman ogm packets only, 2 displays batman icmp packets only, etc. These numbers can be added to filter more than one packet type, e.g. use "-p 3" to display batman ogm packets and batman icmp packets only. If "-n" was given batctl will not replace the mac addresses with bat-host names in the output. .br .IP "\fBbisect logfile1 logfile2 .. logfileN\fP" -Analyzes the logfiles to build a small internal database of all sent sequence numbers and routing table changes. This database can be used to search for routing loops (default action), to trace OGMs of a host (use "-t" to specify the mac address or bat-host name) throughout the network or to display routing tables of the nodes (use "-r" to specify the mac address or bat-host name). You can name a specific sequence number or a range using the "-s" option to limit the output's range. Furthermore you can filter the output by specifying an originator (use "-o" to specify the mac address or bat-host name) to only see data connected to this originator. If "-n" was given batctl will not replace the mac addresses with bat-host names in the output. +Analyzes the logfiles to build a small internal database of all sent sequence numbers and routing table changes. This database can be used to search for routing loops (default action), to trace OGMs of a host (use "-t" to specify the mac address or bat-host name) throughout the network or to display routing tables of the nodes (use "-r" to specify the mac address or bat-host name). You can name a specific sequence number or a range using the "-s" option to limit the output's range. Furthermore you can filter the output by specifying an originator (use "-o" to specify the mac address or bat-host name) to only see data connected to this originator. If "-n" was given batctl will not replace the mac addresses with bat-host names in the output. .br .SH FILES .TP
Debian's Lintian detected different smaller typographical errors in the source code and manpages of batctl.
* seperate -> separate * orginator -> originator * modus -> mode * deamon -> daemon
Signed-off-by: Sven Eckelmann sven.eckelmann@gmx.de --- batman/man/batmand.8 | 8 ++++---- 1 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/batman/man/batmand.8 b/batman/man/batmand.8 index 8801a33..dd2c970 100644 --- a/batman/man/batmand.8 +++ b/batman/man/batmand.8 @@ -66,7 +66,7 @@ Note that debug level 5 can be disabled at compile time. .RE .TP .B -g gateway class -The gateway class is used to tell other nodes in the network your available internet bandwidth. Just enter any number (optionally followed by "kbit" or "mbit") and the daemon will guess your appropriate gateway class. Use "/" to seperate the down(hy and upload rates. You can omit the upload rate and batmand will assume an upload of download / 5. +The gateway class is used to tell other nodes in the network your available internet bandwidth. Just enter any number (optionally followed by "kbit" or "mbit") and the daemon will guess your appropriate gateway class. Use "/" to separate the down(hy and upload rates. You can omit the upload rate and batmand will assume an upload of download / 5. .RS 17 default: 0 -> gateway disabled .RE @@ -85,7 +85,7 @@ allowed values: 5000 .TP .B -H verbose help .TP -.B -o orginator interval in ms +.B -o originator interval in ms A node transmits broadcast messages (we call them originator message or OGM) to inform the neighboring nodes about it's existence. Originator interval is the time to wait after sending one message and before sending the next message. The default value is 1000 ms (1 second). In a mobile network, you may want to detect network changes very quickly, so you need to send message very often, for example, use a value of 500 ms. @@ -93,10 +93,10 @@ In a static network, you can save bandwidth by using a higher value. This option is only available in daemon mode. .TP .B -p preferred gateway -Set the internet gateway by yourself. Note: This automatically switches your daemon to "internet search modus" with "-r 1" unless "-r" is given. If the preferred gateway is not found the gateway selection will use the current routing class to choose a gateway. +Set the internet gateway by yourself. Note: This automatically switches your daemon to "internet search mode" with "-r 1" unless "-r" is given. If the preferred gateway is not found the gateway selection will use the current routing class to choose a gateway. .TP .B -r routing class -The routing class can be set to four values (hy it enables "internet search modus". The deamon will choose an internet gateway based on certain criteria (unless "-p" is specified): +The routing class can be set to four values (hy it enables "internet search mode". The daemon will choose an internet gateway based on certain criteria (unless "-p" is specified): .RS 17 default: 0 -> set no default route .RE
There is also some sentence in the batman manpage which should maybe changed. Maybe a native english speaking person could check if it is valid and understandable.
"B.A.T.M.A.N tries to find the best available connection by watching the uplinks throughput and the link quality."
It is O.K. I would probably say link, not uplink.
However, this basic description is not really correct, at least not for batman-adv. The throughput is not used in deciding on links to use. Maybe Marek should first review the document for technical correctness and then i can look at the English.
Andrew
On Sunday 03 January 2010 03:37:18 Andrew Lunn wrote:
However, this basic description is not really correct, at least not for batman-adv. The throughput is not used in deciding on links to use. Maybe Marek should first review the document for technical correctness and then i can look at the English.
How about this: B.A.T.M.A.N. proactively maintains information about the existence of all nodes in the mesh that are accessible via single-hop or multi-hop communication links and chooses the best path towards the destination based on statistical analysis of protocol packet loss and propagation speed.
@Sven: I applied all your patches (rev: 1530, 1531, 1532).
Regards, Marek
On Mon, Jan 04, 2010 at 08:14:35AM +0800, Marek Lindner wrote:
On Sunday 03 January 2010 03:37:18 Andrew Lunn wrote:
However, this basic description is not really correct, at least not for batman-adv. The throughput is not used in deciding on links to use. Maybe Marek should first review the document for technical correctness and then i can look at the English.
How about this:
B.A.T.M.A.N. proactively maintains information about the existence of all nodes in the mesh that are accessible via single-hop or multi-hop communication links and chooses the best path towards the destination based on statistical analysis of protocol packet loss and propagation speed.
It is good. I guess i would split it into two sentences. s/ and /. It /
I will try to find time to read through the entire man page.
Andrew
On Monday 04 January 2010 14:20:25 Andrew Lunn wrote:
B.A.T.M.A.N. proactively maintains information about the existence of all nodes in the mesh that are accessible via single-hop or multi-hop communication links and chooses the best path towards the destination based on statistical analysis of protocol packet loss and propagation speed.
It is good. I guess i would split it into two sentences. s/ and /. It /
I will try to find time to read through the entire man page.
I just found the manpage section Sven was talking about. This quote was a bit out of context because B.A.T.M.A.N. indeed considers the throughput when choosing the best gateway. This probably sounds better:
In level 1, B.A.T.M.A.N tries to find the best available connection by considering the gateway's advertised throughput as well as the link quality towards the gateway.
Regards, Marek
I just found the manpage section Sven was talking about. This quote was a bit out of context because B.A.T.M.A.N. indeed considers the throughput when choosing the best gateway. This probably sounds better:
In level 1, B.A.T.M.A.N tries to find the best available connection by considering the gateway's advertised throughput as well as the link quality towards the gateway.
Is this batmand, not batman-adv? I'm working through batctl man page and have not found this text.
Andrew
Hi folks
Here is the re-worked batctl.8 file. I made quite a lot of changes. Since the diff will be bigger than the plain file, here is the plain file.
Signed-off-by: Andrew Lunn andrew@lunn.ch --- ." Hey, EMACS: -*- nroff -*- ." First parameter, NAME, should be all caps ." Second parameter, SECTION, should be 1-8, maybe w/ subsection ." other parameters are allowed: see man(7), man(1) .TH "BATCTL" "8" "Jan 04, 2010" "Linux" "B.A.T.M.A.N. Advanced Control Tool" ." Please adjust this date whenever revising the manpage. ." ." Some roff macros, for reference: ." .nh disable hyphenation ." .hy enable hyphenation ." .ad l left justify ." .ad b justify to both left and right margins ." .nf disable filling ." .fi enable filling ." .br insert line break ." .sp <n> insert n+1 empty lines ." for manpage-specific macros, see man(7) ." -------------------------------------------------------------------------- ." Process this file with ." groff -man batctl.8 -Tutf8 ." -------------------------------------------------------------------------- .ad l .SH NAME batctl - B.A.T.M.A.N. advanced control and management tool .SH SYNOPSIS .B batctl .I [\fIbatctl-options\fP]\ \fIcommand\fP\ [\fIcommand-options\fP] .br .SH DESCRIPTION batctl offers a convenient way to configure the batman-adv kernel module as well as displaying debug information such as originator tables, translation tables and the debug log. In combination with a bat-hosts file batctl allows the use of host names instead of MAC addresses. .PP B.A.T.M.A.N. advanced operates on layer 2. Thus all hosts participating in the virtual switched network are transparently connected together for all protocols above layer 2. Therefore the common diagnosis tools do not work as expected. To overcome these problems batctl contains the commands \fBping\fP, \fBtraceroute\fP, \fBtcpdump\fP which provide similar functionality to the normal \fBping\fP(1), \fBtraceroute\fP(1), \fBtcpdump\fP(1) commands, but modified to layer 2 behaviour or using the B.A.T.M.A.N. advanced protocol. .PP .PP .SH OPTIONS .TP .I \fBbatctl-options: -h print general batctl help .br -v print batctl version .br .TP .I \fBcommands: .IP "\fBinterface\fP|\fBif\fP [\fBnone\fP|\fIinterface\fP]" If no parameter is given the current interface settings are displayed otherwise the parameter(s) are added as new interfaces. Use the "none" keyword to deactivate all interfaces. .br .IP "\fBoriginators\fP|\fBo\fP [\fB-b\fP][\fB-n\fP]" Display the originator table. Once started batctl will refresh the displayed originator table every second. The "-b" option causes the table to be displayed only once (useful for scripts). If "-n" is given batctl will not replace the MAC addresses with bat-host names in the output. .br .IP "\fBinterval\fP|\fBit\fP [\fIorig_interval\fP]" If no parameter is given the current originator interval setting is displayed otherwise the parameter is used to set the originator interval. The interval is in units of milliseconds. .br .IP "\fBloglevel\fP|\fBll\fP [\fIlevel\fP]" If no parameter is given the current log level settings are displayed otherwise the parameter is used to set the log level. Level 0 disables all logging. Level 1 enables messages related to routing / flooding / broadcasting. Level 2 enables messages related to route or hna added / changed / deleted. Level 3 enables all messages. The messages are sent to the kernel log. Use \fBdmesg\fP(1) to see them. .br .IP "\fBlog\fP|\fBl\fP [\fIlogfile\fP][\fB-b\fP][\fB-n\fP]\fP" batctl will read the file logfile, or stdin if the logfile parameter is not given, applying filtering so only the B.A.T.M.A.N. Advanced messages are displayed. Whenever there are new log messages appended to the file batctl will display them. The option "-b" causes batctl to exit once the end of the file has been reached. If "-n" is given batctl will not replace the MAC addresses with bat-host names in the output. .br .IP "\fBtranslocal\fP|\fBtl\fP [\fB-b\fP][\fB-n\fP]" Display the local translation table. batctl will refresh the displayed table every second. The "-b" option causes the table to be displayed only once (useful for scripts). If "-n" is given batctl will not replace the MAC addresses with bat-host names in the output. .br .IP "\fBtransglobal\fP|\fBtg\fP [\fB-b\fP][\fB-n\fP]" Display the global translation table. batctl will refresh the displayed table every second. The "-b" option causes the table to be displayed only once (useful for scripts). If "-n" is given batctl will not replace the MAC addresses with bat-host names in the output. .br .IP "\fBvis dot\fP [\fB-n\fP|\fB--numbers\fP][\fB-h\fP|\fB--no-HNA\fP][\fB-2\fP|\fB--no-2nd\fP]" Display the visualisation data in graphviz \fBdot\fP(1) format. If "--numbers" or "-n" is given batctl will not replace the MAC addresses with bat-host names in the output. With "--no-HNA" or "-h" the HNA entries are not displayed, so the pure mesh topology can be seen. With "--no-2nd" or "-2" a dot cluster is not formed around primary and secondary addresses from the same device. .br .IP "\fBvis json\fP [\fB-n\fP|\fB--numbers\fP][\fB-h\fP|\fB--no-HNA\fP][\fB-2\fP|\fB--no-2nd\fP]" Display the visualisation data in JSON format. If "--numbers" or "-n" is given batctl will not replace the MAC addresses with bat-host names in the output. With "--no-HNA" or "-h" the HNA entries are not displayed, so the pure mesh topology can be seen. With "--no-2nd" or "-2" a dot cluster is not formed around primary and secondary addresses from the same device. .br .IP "\fBaggregation\fP|\fBag\fP [\fB1\fP|\fB0\fP]" If no parameter is given the current aggregation setting is displayed. Otherwise the parameter is used to enable or disable packet aggregation. .br .IP "\fBping\fP|\fBp\fP [\fB-c \fP\fIcount\fP][\fB-i \fP\fIinterval\fP][\fB-t \fP\fItime\fP] \fIMAC_address\fP|\fIbat-host_name\fP" Layer 2 ping of a MAC address or bat-host name. batctl will try to find the bat-host name if the given parameter was not a MAC address. The "-c" option tells batctl how man pings should be sent before the program exits. Without the "-c" option batctl will continue pinging without end. Use CTRL + C to stop it. With "-i" and "-t" you can set the default interval between pings and the timeout time for replies, both in seconds. .br .IP "\fBtraceroute\fP|\fBtr\fP [\fB-n\fP] \fIMAC_address\fP|\fIbat-host_name\fP" Layer 2 traceroute to a MAC address or bat-host name. batctl will try to find the bat-host name if the given parameter was not a MAC address. batctl will send 3 packets to each host and display the response time. If "-n" is given batctl will not replace the MAC addresses with bat-host names in the output. .br .IP "\fBtcpdump\fP|\fBtd\fP [\fB-p \fP\fIfilter\fP][\fB-n\fP] \fIinterface ...\fP" batctl will display all packets that are seen on the given interface(s). The "-p" options allows the filtering of certain packet types: 1 - batman ogm packets, 2 - batman icmp packets, 4 - unicast packets, 8 - broadcast packets, 16 - vis packets, and 32 - none batman packets. These numbers can be added to filter more than one packet type, e.g. use "-p 3" to display batman ogm packets and batman icmp packets only. If "-n" is given batctl will not replace the MAC addresses with bat-host names in the output. .br .IP "\fBbisect\fP [\fB-l \fP\fIMAC\fP][\fB-t \fP\fIMAC\fP][\fB-r \fP\fIMAC\fP][\fB-s \fP\fImin\fP [\fB- \fP\fImax\fP]][\fB-o \fP\fIMAC\fP][\fB-n\fP] \fIlogfile1\fP [\fIlogfile2\fP ... \fIlogfileN\fP]" Analyses the logfiles to build a small internal database of all sent sequence numbers and routing table changes. This database can then be analyzed in a number of different ways. With "-l" the database can be used to search for routing loops. Use "-t" to trace OGMs of a host throughout the network. Use "-r" to display routing tables of the nodes. The option "-s" can be used to limit the output to a range of sequence numbers, between min and max, or to one specific sequence number, min. Furthermore using "-o" you can filter the output to a specified originator. If "-n" is given batctl will not replace the MAC addresses with bat-host names in the output. .br .SH FILES .TP .I "\fBbat-hosts\fP" This file is similar to the /etc/hosts file. You can write one MAC address and one host name per line. batctl will search for bat-hosts in /etc, your home directory and the current directory. The found data is used to match MAC address to your provided host name or replace MAC addresses in debug output and logs. Host names are much easier to remember than MAC addresses. .SH SEE ALSO .BR ping (1), .BR traceroute (1), .BR tcpdump (1), .BR dmesg (1), .BR dot (1) .SH AUTHOR batctl was written by Andreas Langer a.langer@q-dsl.de and Marek Lindner lindner_marek@yahoo.de. .PP This manual page was written by Simon Wunderlich siwu@hrz.tu-chemnitz.de, Marek Lindner lindner_marek@yahoo.de and Andrew Lunn andrew@lunn.ch
On Tuesday 05 January 2010 03:11:55 Andrew Lunn wrote:
Here is the re-worked batctl.8 file. I made quite a lot of changes. Since the diff will be bigger than the plain file, here is the plain file.
Applied in rev 1533. Thanks for the review!
By the way, batctl vis still has "-h" as an option which does not show the help output. This is rather unusual. Do you mind choosing another letter ? I asked that before but maybe it got lost in the stream of mails. :)
Regards, Marek
On Thu, Jan 07, 2010 at 12:59:13PM +0800, Marek Lindner wrote:
On Tuesday 05 January 2010 03:11:55 Andrew Lunn wrote:
Here is the re-worked batctl.8 file. I made quite a lot of changes. Since the diff will be bigger than the plain file, here is the plain file.
Applied in rev 1533. Thanks for the review!
By the way, batctl vis still has "-h" as an option which does not show the help output. This is rather unusual. Do you mind choosing another letter ? I asked that before but maybe it got lost in the stream of mails. :)
batctl: VIS subcommand uses -h for help/usage.
Signed-off-by: Andrew Lunn andrew@lunn.ch Index: batctl/vis.c =================================================================== --- batctl/vis.c (revision 1534) +++ batctl/vis.c (working copy) @@ -55,9 +55,9 @@
static void usage(void) { - printf("batctl vis dot {--no-HNA|-h} {--no-2nd|-2} {--numbers|-n}\n"); + printf("batctl vis dot {-h}{--no-HNA|-H} {--no-2nd|-2} {--numbers|-n}\n"); printf("or\n"); - printf("batctl vis json {--no-HNA|-h} {--no-2nd|-2} {--numbers|-n}\n"); + printf("batctl vis json {-h}{--no-HNA|-H} {--no-2nd|-2} {--numbers|-n}\n"); }
static void dot_print_tq(char *orig, char *from, const long tq) @@ -271,18 +271,18 @@ while (1) { int option_index = 0; static struct option long_options[] = { - {"no-HNA", 0, 0, 'h'}, + {"no-HNA", 0, 0, 'H'}, {"no-2nd", 0, 0, '2'}, {"numbers", 0, 0, 'n'}, {0, 0, 0, 0} };
- c = getopt_long(argc, argv, "h2n", long_options, &option_index); + c = getopt_long(argc, argv, "hH2n", long_options, &option_index); if (c == -1) break;
switch (c) { - case 'h': + case 'H': with_HNA = false; break; case '2': @@ -291,6 +291,7 @@ case 'n': with_names = false; break; + case 'h': default: usage(); return -1; Index: batctl/man/batctl.8 =================================================================== --- batctl/man/batctl.8 (revision 1534) +++ batctl/man/batctl.8 (working copy) @@ -99,18 +99,18 @@ displayed only once (useful for scripts). If "-n" is given batctl will not replace the MAC addresses with bat-host names in the output. .br -.IP "\fBvis dot\fP [\fB-n\fP|\fB--numbers\fP][\fB-h\fP|\fB--no-HNA\fP][\fB-2\fP|\fB--no-2nd\fP]" +.IP "\fBvis dot\fP [\fB-n\fP|\fB--numbers\fP][\fB-H\fP|\fB--no-HNA\fP][\fB-2\fP|\fB--no-2nd\fP]" Display the visualisation data in graphviz \fBdot\fP(1) format. If "--numbers" or "-n" is given batctl will not replace the MAC addresses with bat-host names in the output. With "--no-HNA" or -"-h" the HNA entries are not displayed, so the pure mesh topology can +"-H" the HNA entries are not displayed, so the pure mesh topology can be seen. With "--no-2nd" or "-2" a dot cluster is not formed around primary and secondary addresses from the same device. .br -.IP "\fBvis json\fP [\fB-n\fP|\fB--numbers\fP][\fB-h\fP|\fB--no-HNA\fP][\fB-2\fP|\fB--no-2nd\fP]" +.IP "\fBvis json\fP [\fB-n\fP|\fB--numbers\fP][\fB-H\fP|\fB--no-HNA\fP][\fB-2\fP|\fB--no-2nd\fP]" Display the visualisation data in JSON format. If "--numbers" or "-n" is given batctl will not replace the MAC addresses with bat-host -names in the output. With "--no-HNA" or "-h" the HNA entries are +names in the output. With "--no-HNA" or "-H" the HNA entries are not displayed, so the pure mesh topology can be seen. With "--no-2nd" or "-2" a dot cluster is not formed around primary and secondary addresses from the same device.
On Thursday 07 January 2010 14:15:36 Andrew Lunn wrote:
batctl: VIS subcommand uses -h for help/usage.
Signed-off-by: Andrew Lunn andrew@lunn.ch
Thanks for the quick fix (applied in rev 1535)!
Regards, Marek
b.a.t.m.a.n@lists.open-mesh.org
-
Andrew Lunn -
Marek Lindner -
Sven Eckelmann