Add description of some scripts

diff --git a/tools/wvformat b/tools/wvformat
index 7b3d5d93953a3f8067c28e720001ae77fe3ee31a..3db76c9eff0309c03c35378431731e10ba107a08 100755 (executable)
--- a/tools/wvformat
+++ b/tools/wvformat
@@ -2,9 +2,14 @@
 #
 # WvTest:
 #   Copyright (C)2007-2009 Versabanq Innovations Inc. and contributors.
+#   Copyright (C) 2012 Michal Sojka <sojka@os.inf.tu-dresden.de>
 #       Licensed under the GNU Library General Public License, version 2.
 #       See the included file named LICENSE for license information.
 #
+# This script aligns assertion results to the same column and, if run
+# on a tty, it colorizes the output. At the end, it summarizes the
+# results.
+#
 use strict;
 use Getopt::Long;
 
@@ -13,6 +18,9 @@ sub usage() {
     exit 127;
 }
 
+# Optional prefix of wvtest protocol lines
+my $prefix_re = '\([0-9]+\) (?:#   )?';
+
 my ($verbose, $summary, $limit_lines);
 
 GetOptions (

diff --git a/tools/wvnulrun b/tools/wvnulrun
index 6ecc4e5f20795603e80502e7182b9c8a14740b34..91a282367a027f47988e72f8a71c69a6e54b6962 100755 (executable)
--- a/tools/wvnulrun
+++ b/tools/wvnulrun
@@ -1,10 +1,14 @@
 #!/usr/bin/perl -w
 #
 # @file
-# Script to supervise the execution of wvtest-based tests.
+# Script to supervise the execution of wvtest-based tests. It is a
+# modified version of wvtestrun with some features added and without
+# pretty-printing which was moved to wvformat script.
 #
 # It takes care of killing test (qemu or serial reader) when the test
-# finishes or hangs.
+# finishes or hangs. It has flexible timeout management and is able to
+# check that the number of executed assertions is the same as was
+# expected.
 #
 # Copyright (C) 2011, 2012, Michal Sojka <sojka@os.inf.tu-dresden.de>
 # Economic rights: Technische Universitaet Dresden (Germany)

diff --git a/tools/wvwrap b/tools/wvwrap
index 189481d0f52c26b0db017af8252132fab3493a31..184b50393a356f24e8ea89375f35a2afb49401fc 100755 (executable)
--- a/tools/wvwrap
+++ b/tools/wvwrap
@@ -6,6 +6,10 @@
 #       Licensed under the GNU Library General Public License, version 2.
 #       See the included file named LICENSE for license information.
 #
+# This script wraps long wvtest protocol lines. I use it as follows to
+# produce nicely formated emails:
+# COLUMNS=80 wvformat < wvtest.log | wvwrap | mail -s Log me@example.com
+
 use strict;
 use Getopt::Long;
 
@@ -16,6 +20,9 @@ sub usage() {
 
 usage() if (@ARGV > 0);
 
+# Optional prefix of wvtest protocol lines
+my $prefix_re = '\([0-9]+\) (?:#   )?';
+
 my $istty = -t STDOUT && $ENV{'TERM'} ne "dumb";
 my $columns;
 if ($istty) {