[Buildbot-commits] buildbot/docs buildbot.texinfo,1.47,1.48

[Brian Warner]

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

Modified Files:
	buildbot.texinfo 
Log Message:
Revision: arch at buildbot.sf.net--2004/buildbot--dev--0--patch-549
Creator:  Brian Warner <warner at lothar.com>

add robots_txt= to Waterfall, thanks to Tobi Vollebregt

	* buildbot/status/html.py (Waterfall): add 'robots_txt=' argument,
	a filename to be served as 'robots.txt' to discourage web spiders.
	Adapted from a patch by Tobi Vollebregt, thanks!
	* buildbot/test/test_web.py (Waterfall._test_waterfall_5): test it
	* docs/buildbot.texinfo (HTML Waterfall): document it


Index: buildbot.texinfo
===================================================================
RCS file: /cvsroot/buildbot/buildbot/docs/buildbot.texinfo,v
retrieving revision 1.47
retrieving revision 1.48
diff -u -d -r1.47 -r1.48
--- buildbot.texinfo	24 Apr 2006 09:56:19 -0000	1.47
+++ buildbot.texinfo	21 May 2006 21:28:26 -0000	1.48
@@ -3922,8 +3922,41 @@
 appear at @code{http://host/buildbot/}, and the right virtual host
 setup can even place it at @code{http://buildbot.host/} .
 
-In addition, the HTML page can have a favicon and custom CSS: see the
-docstring for details.
+Other arguments:
+
+ at table @code
+ at item allowForce
+If set to True (the default), then the web page will provide a ``Force
+Build'' button that allows visitors to manually trigger builds. This
+is useful for developers to re-run builds that have failed because of
+intermittent problems in the test suite, or because of libraries that
+were not installed at the time of the previous build. You may not wish
+to allow strangers to cause a build to run: in that case, set this to
+False to remove these buttons.
+
+ at item favicon
+If set to a string, this will be interpreted as a filename containing
+a ``favicon'': a small image that contains an icon for the web site.
+This is returned to browsers that request the @code{favicon.ico} file,
+and should point to a .png or .ico image file. The default value uses
+the buildbot/buildbot.png image (a small hex nut) contained in the
+buildbot distribution. You can set this to None to avoid using a
+favicon at all.
+
+ at item robots_txt
+If set to a string, this will be interpreted as a filename containing
+the contents of ``robots.txt''. Many search engine spiders request
+this file before indexing the site. Setting it to a file which
+contains:
+ at example
+User-agent: *
+Disallow: /
+ at end example
+will prevent most search engines from trawling the (voluminous)
+generated status pages.
+
+ at end table
+
 
 @node IRC Bot, PBListener, HTML Waterfall, Status Delivery
 @subsection IRC Bot