[Buildbot-commits] buildbot/docs steps.xhtml,1.6,1.7 source.xhtml,1.4,1.5

Fri May 6 04:42:42 UTC 2005

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

Modified Files:
	steps.xhtml source.xhtml 
Log Message:
Revision: arch at buildbot.sf.net--2004/buildbot--dev--0--patch-137
Creator:  Brian Warner <warner at monolith.lothar.com>

Merged from org.apestaart at thomas--buildbot (patch 0-2), warner at monolith.lothar.com--2005 (patch 0-3)

Merged in Change(tag=) enhancement from Thomas Vander Stichele.

Patches applied:

 * org.apestaart at thomas--buildbot/buildbot--cvstag--0-dev--base-0
   tag of org.apestaart at thomas--buildbot/buildbot--cvstag--0-rel--patch-2

 * org.apestaart at thomas--buildbot/buildbot--cvstag--0-dev--patch-1
   tag of org.apestaart at thomas--buildbot/buildbot--cvstag--0-rel--patch-2

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

 * org.apestaart at thomas--buildbot/buildbot--cvstag--0-rel--patch-1
   merge in first patch on the old cvsbranch branch

 * org.apestaart at thomas--buildbot/buildbot--cvstag--0-rel--patch-2
   merge in complete cvsbranch to this new branch

 * org.apestaart at thomas--buildbot/buildbot--releases--0--base-0
   tag of arch at buildbot.sf.net--2004/buildbot--dev--0--patch-21

 * org.apestaart at thomas--buildbot/buildbot--releases--0--patch-1
   merge in 0.6.3 release

 * org.apestaart at thomas--buildbot/buildbot--releases--0--patch-2
   merge in 0.6.4 release

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

 * org.apestaart at thomas/buildbot--cvsbranch--0--patch-1
   add "tag" concept to changes, and add isTagImportant to be overridden

 * org.apestaart at thomas/buildbot--cvsbranch--0--patch-2
   and add the file to test with

 * org.apestaart at thomas/buildbot--cvsbranch--0--patch-3
   clean up logging

 * org.apestaart at thomas/buildbot--cvsbranch--0--patch-4
   unboundlocalerror fix

 * warner at monolith.lothar.com--2005/buildbot--dev--0--base-0
   tag of arch at buildbot.sf.net--2004/buildbot--dev--0--patch-130

 * warner at monolith.lothar.com--2005/buildbot--dev--0--patch-1
   Merged from arch at buildbot.sf.net--2004 (patch 131-136)

 * warner at monolith.lothar.com--2005/buildbot--dev--0--patch-2
   Merged from org.apestaart at thomas--buildbot cvstag--0-dev (patch 0-2)

 * warner at monolith.lothar.com--2005/buildbot--dev--0--patch-3
   add some docs, document Change(tag=)


Index: source.xhtml
===================================================================
RCS file: /cvsroot/buildbot/buildbot/docs/source.xhtml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5

--- source.xhtml	6 Dec 2004 01:23:12 -0000	1.4
+++ source.xhtml	6 May 2005 04:42:33 -0000	1.5
@@ -139,12 +139,12 @@
 These parameters collectively specify a set of sources from which a build
 may be performed.</p>
 
-<p>Subversion combines the repository, module, and branch into a single
-<q>Subversion URL</q> parameter. Within that scope, source checkouts can be
-specified by a numeric <q>revision number</q> (a repository-wide
-monotonically-increasing marker, such that each transaction that changes the
-repository is indexed by a different revision number), or a revision
-timestamp.</p>
+<p><a href="http://subversion.tigris.org">Subversion</a> combines the
+repository, module, and branch into a single <q>Subversion URL</q> parameter.
+Within that scope, source checkouts can be specified by a numeric <q>revision
+number</q> (a repository-wide monotonically-increasing marker, such that each
+transaction that changes the repository is indexed by a different revision
+number), or a revision timestamp.</p>
 
 <p><a href="http://wiki.gnuarch.org/">Arch</a> specifies a repository by
 URL, as well as a <q>version</q> which is kind of like a branch name. Arch
@@ -166,4 +166,45 @@
 repository that you want to build from. The build slave will then pull the
 latest patches from that repository and build them.</p>
 
+<h3>Attributes of Changes</h3>
+
+<p>Each Change has a <code>who</code>attribute, which specifies which
+developer is responsible for the change. This is a string which comes from a
+namespace controlled by the VC repository. Frequently this means it is a
+username on the host which runs the repository, but not all VC systems
+require this (Arch, for example, would use a fully-qualified <q>Arch ID</q>,
+which looks like an email address). Each StatusNotifier will map the
+<code>who</code> attribute into something appropriate for their particular
+means of communication: an email address, an IRC handle, etc.</p>
+
+<p>Each Change can have a <code>revision</code> attribute, which describes
+how to get a tree with a specific state: a tree which includes this Change
+(and all that came before it) but none that come after it. If this
+information is unavailable, the <code>.revision</code> attribute will be
+<code>None</code>. These revisions are provided by the ChangeSource, and
+consumed by the <code>computeSourceRevision</code> method in the appropriate
+<code>step.Source</code> class.</p>
+
+<ul>
+  <li>CVS: <code>revision</code> is an int, seconds since the epoch</li>
+  <li>SVN: <code>revision</code> is an int, a transation number (r%d)</li>
+  <li>Darcs: does not yet use <code>revision</code></li>
+  <li>Arch: <code>revision</code> is a string, ending in --patch-%d</li>
+  <li>Bazaar: same as Arch</code></li>
+  <li>P4: <code>revision</code> is an int, the transaction number</li>
+</ul>
+
+<p>The Change might also have a <code>tag</code> attribute. This is primarily
+intended to represent the CVS named branch (since CVS does not embed the
+<q>branch</q> in the pathname like many of the other systems), however it
+could be used for other purposes as well (e.g. some VC systems might allow
+commits to be marked as <q>cosmetic</q>, or docs-only, or something). The
+Build, in its <code>isTagImportant</code> method, gets to decide whether the
+tag is important or not. This allows you to configure Builds which only fire
+on changes to a specific branch. For a change to trigger a build, both the
+<code>tag</code> must be important, and at least one of the files inside the
+change must be considered important.</p>
+
+</p>
+
 </body> </html>

Index: steps.xhtml
===================================================================
RCS file: /cvsroot/buildbot/buildbot/docs/steps.xhtml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- steps.xhtml	13 Oct 2004 00:11:30 -0000	1.6
+++ steps.xhtml	6 May 2005 04:42:33 -0000	1.7
@@ -269,8 +269,8 @@
 <h2>Arch</h2>
 
 <p>The <code>Arch</code> build step performs an <a
-href="http://gnuarch.org/">Arch</a> checkout or update. It takes the
-following arguments.</p>
+href="http://gnuarch.org/">Arch</a> checkout or update using the
+<code>tla</code> client. It takes the following arguments.</p>
 
 <ul>
   <li><code>url</code> (required): this specifies the URL at which the Arch
@@ -279,14 +279,24 @@
   <li><code>version</code> (required): this specifies which <q>development
   line</q> (like a branch) should be used.</li>
 
-  <li><code>archive</code> (optional): this can be used to override the
-  local name associated with the archive at <code>url</code>, which is
-  occasionally necessary in some weird situations. Using this option
-  prevents <code>mode='update'</code> or <code>mode='copy'</code> from
-  working, so avoid it if at all possible. It may be removed in a later
-  release.</li>
+  <li><code>archive</code> (optional): Each repository knows its own archive
+  name. If this parameter is provided, it must match the repository's archive
+  name. The parameter is accepted for compatibility with the
+  <code>Bazaar</code> step, below.</li>
 </ul>
 
+<h2>Bazaar</h2>
+
+<p><code>Bazaar</code> is an alternate implementation of the Arch VC system,
+which uses a client named <code>baz</code>. The checkout semantics are just
+different enough from <code>tla</code> that there is a separate BuildStep for
+it.</p>
+
+<p>It takes exactly the same arguments as <code>Arch</code>, except that the
+<code>archive=</code> parameter is required. (baz does not emit the archive
+name when you do <q>baz register-archive</q>, so we must provide it
+ourselves).</p>
+
 
 <h2>P4Sync</h2>
 



