[Buildbot-commits] buildbot/docs buildbot.texinfo,1.55,1.56

[Brian Warner]

Update of /cvsroot/buildbot/buildbot/docs
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv14565/docs

Modified Files:
	buildbot.texinfo 
Log Message:
[project @ add test and docs for the (not-yet implemented) watch-multiple-logfiles feature]

Original author: warner at lothar.com
Date: 2006-06-16 19:57:42

Index: buildbot.texinfo
===================================================================
RCS file: /cvsroot/buildbot/buildbot/docs/buildbot.texinfo,v
retrieving revision 1.55
retrieving revision 1.56
diff -u -d -r1.55 -r1.56
--- buildbot.texinfo	15 Jun 2006 05:47:55 -0000	1.55
+++ buildbot.texinfo	20 Jun 2006 08:08:39 -0000	1.56
@@ -3167,6 +3167,29 @@
 a PTY do not have separate stdout/stderr streams: both are merged into
 stdout.
 
+ at item logfiles
+Sometimes commands will log interesting data to a local file, rather
+than emitting everything to stdout or stderr. For example, Twisted's
+``trial'' command (which runs unit tests) only presents summary
+information to stdout, and puts the rest into a file named
+ at file{_trial_temp/test.log}. It is often useful to watch these files
+as the command runs, rather than using @command{/bin/cat} to dump
+their contents afterwards.
+
+The @code{logfiles=} argument allows you to collect data from these
+secondary logfiles in real-time, as the step is running. It accepts a
+dictionary which maps from a local Log name (which is how the log data
+is presented in the build results) to a remote filename (interpreted
+relative to the build's working directory). Each named file will be
+polled on a regular basis (every couple of seconds) as the build runs,
+and any new text will be sent over to the buildmaster.
+
+ at example
+s(ShellCommand, command=["make", "test"],
+  logfiles=@{"triallog": "_trial_temp/test.log"@})
+ at end example
+
+
 @item timeout
 if the command fails to produce any output for this many seconds, it
 is assumed to be locked up and will be killed.