Francois Gouget : testbot: Document WineTestBot::Log::SetupRedirects().

[Alexandre Julliard]

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

Author: Francois Gouget <fgouget(a)codeweavers.com>
Date:   Tue Oct  3 03:26:50 2017 +0200

testbot: Document WineTestBot::Log::SetupRedirects().

Signed-off-by: Francois Gouget <fgouget(a)codeweavers.com>
Signed-off-by: Alexandre Julliard <julliard(a)winehq.org>

---

 testbot/lib/WineTestBot/Log.pm | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/testbot/lib/WineTestBot/Log.pm b/testbot/lib/WineTestBot/Log.pm
index 4b1d35e..7abf2cb 100644
--- a/testbot/lib/WineTestBot/Log.pm
+++ b/testbot/lib/WineTestBot/Log.pm
@@ -58,6 +58,17 @@ sub LogMsg(@)
   print $logfile scalar localtime, " ", $logprefix, "[$$]: ", @_ if ($logfile);
 }
 
+=pod
+=over 12
+
+=item C<SetupRedirects()>
+
+This redirects stderr so it writes to our log. This is typically called before
+exec()-ing external tools so their error messages are not lost.
+
+=back
+=cut
+
 sub SetupRedirects()
 {
   if (defined $logfile)