Francois Gouget : winetest: Improve the scripts documentation.

[Alexandre Julliard]

Module: tools
Branch: master
Commit: f1198690004363f900204d627a8a48f809cd84eb
URL:    http://source.winehq.org/git/tools.git/?a=commit;h=f1198690004363f900204d627a8a48f809cd84eb

Author: Francois Gouget <fgouget at codeweavers.com>
Date:   Thu Jul 17 18:34:53 2014 +0200

winetest: Improve the scripts documentation.

---

 winetest/README      | 19 -------------------
 winetest/build-index | 18 ++++++++++++++++--
 winetest/dissect     | 25 ++++++++++++++-----------
 winetest/gather      | 24 ++++++++++++++----------
 4 files changed, 44 insertions(+), 42 deletions(-)

diff --git a/winetest/README b/winetest/README
index 49ca6d0..68e185a 100644
--- a/winetest/README
+++ b/winetest/README
@@ -25,25 +25,6 @@ file in $queuedir, then renames it to repXXXXX/report.
 
 Sample crontab entry illustrating the intended use of the tools.
 
-* dissect
-
-This program looks for a file matching $queuedir/rep*/report, takes it
-apart in its directory while also creating summary.txt.  If an error
-occurs the directory is renamed to errXXXXX to avoid future attempts
-at processing this report.  If everything goes flawlessly the whole
-directory is renamed (based on the information learned in the process)
-to $datadir/BUILD/VERSION_TAG_DIGIT where DIGIT is for resolving name
-clashes and $datadir/BUILD/outdated is created to signal the change in
-the given build.  See also the head of the file.
-
-* gather
-
-This program is intended to run as a second stage.  See the sample
-crontab file. Races and concurrency problems must be dealt with on
-that higher level.  The program looks for a file matching
-$datadir/*/outdated, creates index.html in the same directory and
-removes the outdated file.  See also the head of the file.
-
 * summary.css, summary.js, resultform.html
 
 These files are referenced by the index.html files created by gather.
diff --git a/winetest/build-index b/winetest/build-index
index 8e12c01..186a2de 100755
--- a/winetest/build-index
+++ b/winetest/build-index
@@ -1,9 +1,23 @@
 #!/usr/bin/perl -w
 #
-# Build the global index for winetest result data
-#
 # Copyright 2008 Alexandre Julliard <julliard at winehq.org>
 #
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+# This program creates the global index of all the builds for which we have
+# WineTest result data.
 
 use strict;
 use open ':utf8';
diff --git a/winetest/dissect b/winetest/dissect
index 5187cf0..a243a23 100755
--- a/winetest/dissect
+++ b/winetest/dissect
@@ -1,16 +1,5 @@
 #!/usr/bin/perl -w
 #
-# Searches for $queuedir/rep*/report.txt-s, preprocesses and moves
-# them into the appropriate $datadir/build/version directories, and
-# creates $datadir/build/outdated. Each generated file has .txt extension.
-#
-# Files: winetest.conf
-#
-# Exit: 0 - successfully processed a report, call again
-#       1 - failure processing a report, call again
-#       2 - there was nothing to do
-#       3 - fatal error, something went utterly wrong
-#
 # Copyright (C) 2004 Ferenc Wagner
 # Copyright (C) 2008 Alexandre Julliard
 #
@@ -27,6 +16,20 @@
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+# This program looks for a WineTest report file matching $queuedir/rep*/report,
+# takes it apart in its directory while also creating summary.txt. If an error
+# occurs the directory is renamed to errXXXXX to avoid future attempts at
+# processing this report.
+# If everything goes flawlessly the whole directory is renamed (based on the
+# information learned in the process) to $datadir/BUILD/VERSION_TAG_DIGIT
+# where DIGIT is for resolving name clashes and $datadir/BUILD/outdated is
+# created to signal the change in the given build.
+#
+# Exit: 0 - successfully processed a report, call again
+#       1 - failed to process a report, call again
+#       2 - there was nothing to do
+#       3 - fatal error, something went utterly wrong
 
 use strict;
 use open ':utf8';
diff --git a/winetest/gather b/winetest/gather
index 97a5a37..5023ac6 100755
--- a/winetest/gather
+++ b/winetest/gather
@@ -1,15 +1,5 @@
 #!/usr/bin/perl -w
 #
-# Searches for a $datadir/*/outdated, updates the corresponding
-# index.html and removes the outdated.
-#
-# Files: winetest.conf
-#
-# Exit: 0 - successfully processed a build, call again
-#       1 - should not happen
-#       2 - there was nothing to do
-#       3 - fatal error, something went utterly wrong
-#
 # Copyright (C) 2004 Ferenc Wagner
 #
 # This library is free software; you can redistribute it and/or
@@ -25,6 +15,20 @@
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+# This program looks for builds that have received new reports. These are
+# identified by the presence of a file matching $datadir/*/outdated. It then
+# creates an index.html file in the same directory and removes the outdated
+# file.
+#
+# It is thus intended to run as a second stage invoked by the winetest.cron
+# script. Races and concurrency problems must be dealt with on that higher
+# level.
+#
+# Exit: 0 - successfully processed a build, call again
+#       1 - should not happen
+#       2 - there was nothing to do
+#       3 - fatal error, something went utterly wrong
 
 use strict;
 use CGI qw(:standard);