[Buildbot-commits] buildbot/docs waterfall.classic.css,NONE,1.1 config.xhtml,1.7,1.8

[Brian Warner]

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

Modified Files:
	config.xhtml 
Added Files:
	waterfall.classic.css 
Log Message:
Revision: arch at buildbot.sf.net--2004/buildbot--dev--0--patch-83
Creator:  Brian Warner <warner at monolith.lothar.com>

Merged from org.apestaart at thomas/buildbot--waterfall--0--patch-22

Merged builder-categories and waterfall CSS work from Thomas. Also added
test-case-name tags.

Patches applied:

 * org.apestaart at thomas/buildbot--trial--0--base-0
   tag of org.apestaart at thomas/buildbot--releases--0.6.2--patch-2

 * org.apestaart at thomas/buildbot--trial--0--patch-1
   adding test-case-name

 * org.apestaart at thomas/buildbot--waterfall--0--base-0
   tag of org.apestaart at thomas/buildbot--releases--0.6.2--patch-2

 * org.apestaart at thomas/buildbot--waterfall--0--patch-1

 * org.apestaart at thomas/buildbot--waterfall--0--patch-2

 * org.apestaart at thomas/buildbot--waterfall--0--patch-3

 * org.apestaart at thomas/buildbot--waterfall--0--patch-4

 * org.apestaart at thomas/buildbot--waterfall--0--patch-5

 * org.apestaart at thomas/buildbot--waterfall--0--patch-6

 * org.apestaart at thomas/buildbot--waterfall--0--patch-7

 * org.apestaart at thomas/buildbot--waterfall--0--patch-8

 * org.apestaart at thomas/buildbot--waterfall--0--patch-9
   merge for test-case-name

 * org.apestaart at thomas/buildbot--waterfall--0--patch-10
   unittests + fixes for status.mail category filtering

 * org.apestaart at thomas/buildbot--waterfall--0--patch-11
   fix testsuite by prefixing page title with BuildBot

 * org.apestaart at thomas/buildbot--waterfall--0--patch-12
   move category from Builder to BuilderStatus

 * org.apestaart at thomas/buildbot--waterfall--0--patch-13
   fix silly bug, makes order in waterfall work again

 * org.apestaart at thomas/buildbot--waterfall--0--patch-14
   document category and categories for builders and statusclients

 * org.apestaart at thomas/buildbot--waterfall--0--patch-15
   remove prints from test_run

 * org.apestaart at thomas/buildbot--waterfall--0--patch-16
   remove FIXME and unneeded code for category

 * org.apestaart at thomas/buildbot--waterfall--0--patch-17
   put back "builders" argument

 * org.apestaart at thomas/buildbot--waterfall--0--patch-18
   use class_ to assign a class="" to the html blocks

 * org.apestaart at thomas/buildbot--waterfall--0--patch-19
   cssclass->class_

 * org.apestaart at thomas/buildbot--waterfall--0--patch-20
   give classes names as agreed

 * org.apestaart at thomas/buildbot--waterfall--0--patch-21
   finish class styling and add EXCEPTION result

 * org.apestaart at thomas/buildbot--waterfall--0--patch-22
   classic buildbot stylesheet


Index: config.xhtml
===================================================================
RCS file: /cvsroot/buildbot/buildbot/docs/config.xhtml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- config.xhtml	19 Apr 2005 08:22:35 -0000	1.7
+++ config.xhtml	24 Apr 2005 21:30:24 -0000	1.8
@@ -81,8 +81,7 @@
 from:</p>
 
 <ul>
-  <li><code>buildbot.status.html.Waterfall(http_port=int,
-  distrib_port=int/str, favicon=str)</code>:
+  <li><code>buildbot.status.html.Waterfall()</code>:
 
   This creates an HTML <q>waterfall display</q>, which shows a time-based
   chart of events. This display provides detailed information about all steps
@@ -92,12 +91,11 @@
   listen. If instead <code>distrib_port</code> is provided, a twisted.web
   distributed server will be started either on a TCP port (if
   <code>distrib_port</code> is an int) or more likely on a UNIX socket (if
-  <code>distrib_port</code> is a string). <code>favicon</code> can be used to
-  point at an image that many browsers will use as an icon in any bookmarks
-  made to pages on the site. <!-- TODO: would it be useful to let the
-  waterfall page live at a different location? How could you offer both the
-  waterfall page and a one-box-per-builder status page in the same server?
-  --> </li>
+  <code>distrib_port</code> is a string). The HTML page can have a favicon
+  and custom CSS: see the docstring for details. <!-- TODO: would it be
+  useful to let the waterfall page live at a different location? How could
+  you offer both the waterfall page and a one-box-per-builder status page in
+  the same server? --> </li>
 
   
   <li><code>buildbot.status.words.IRC(stuff)</code>:
@@ -117,6 +115,12 @@
   </li>
 </ul>
 
+<p>More details are available in the docstrings for each class, use <tt>pydoc
+buildbot.status.html.Waterfall</tt> to see them. Most status delivery objects
+take a <code>categories=</code> argument, which can contain a list of
+<q>category</q> names: in this case, it will only show status for Builders
+that are in one of the named categories.</p>
+
 <p>(implementor's note: each of these objects should be a
 service.MultiService which will be attached to the BuildMaster object when
 the configuration is processed. They should use
@@ -197,6 +201,16 @@
     of seconds which should elapse between spontaneous timed builds. If you
     want a buildbot which just continually rebuilds the tree every hour, set
     this to 60*60.</li>
+
+    <li><code>category</code> (optional): if provided, a string that
+    identifies a category for the builder to be a part of.  Status clients
+    can limit themselves to a subset of the available categories.  A common
+    use for this is to add new builders to your setup (for a new module, or
+    for a new buildslave) that do not work correctly yet and allow you to
+    integrate them with the active builders.  You can put these new builders
+    in a test category, make your main status clients ignore them, and have
+    only private status clients pick them up.  As soon as they work, you can
+    move them over to the active category.</li>
   </ul>
   </li>
   

--- NEW FILE: waterfall.classic.css ---
a:visited {
	color: #800080;
}

td.Event, td.BuildStep, td.Activity, td.Change, td.Time, td.Builder {
    border-top: 1px solid;
    border-right: 1px solid;
}

/* Activity states */
.idle {
	background-color: white;
}

/* LastBuild, BuildStep states */
.success {
	background-color: #72ff75;
}
.failure {
	background-color: red;
}
.warnings {
	background-color: orange;
}
.exception {
	background-color: #c000c0;
}
.start,.running {
	background-color: yellow;
}