<html lang="en">
<head>
<title>.buildbot config directory - BuildBot Manual - 0.8.4p1</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="BuildBot Manual - 0.8.4p1">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="buildbot.html#buildbot" title="buildbot">
<link rel="prev" href="Other-Tools.html#Other-Tools" title="Other Tools">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This is the BuildBot manual for Buildbot version 0.8.4p1.
Copyright (C) 2005, 2006, 2009, 2010 Brian Warner
Copying and distribution of this file, with or without
modification, are permitted in any medium without royalty
provided the copyright notice and this notice are preserved.-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name=".buildbot-config-directory"></a>
<a name="g_t_002ebuildbot-config-directory"></a>
<p>
Previous: <a rel="previous" accesskey="p" href="Other-Tools.html#Other-Tools">Other Tools</a>,
Up: <a rel="up" accesskey="u" href="buildbot.html#buildbot">buildbot</a>
<hr>
</div>
<h4 class="subsection">6.1.4 .buildbot config directory</h4>
<p>Many of the <samp><span class="command">buildbot</span></samp> tools must be told how to contact the
buildmaster that they interact with. This specification can be
provided as a command-line argument, but most of the time it will be
easier to set them in an “options” file. The <samp><span class="command">buildbot</span></samp>
command will look for a special directory named <samp><span class="file">.buildbot</span></samp>,
starting from the current directory (where the command was run) and
crawling upwards, eventually looking in the user's home directory. It
will look for a file named <samp><span class="file">options</span></samp> in this directory, and will
evaluate it as a python script, looking for certain names to be set.
You can just put simple <code>name = 'value'</code> pairs in this file to
set the options.
<p>For a description of the names used in this file, please see the
documentation for the individual <samp><span class="command">buildbot</span></samp> sub-commands. The
following is a brief sample of what this file's contents could be.
<pre class="example"> # for status-reading tools
masterstatus = 'buildbot.example.org:12345'
# for 'sendchange' or the debug port
master = 'buildbot.example.org:18990'
debugPassword = 'eiv7Po'
</pre>
<p>Note carefully that the names in the <code>options</code> file usually do not match
the command-line option name.
<dl>
<dt><code>masterstatus</code><dd>Equivalent to <code>--master</code> for <a href="statuslog.html#statuslog">statuslog</a> and <a href="statusgui.html#statusgui">statusgui</a>, this
gives the location of the <code>client.PBListener</code> status port.
<br><dt><code>master</code><dd>Equivalent to <code>--master</code> for <a href="debugclient.html#debugclient">debugclient</a> and <a href="sendchange.html#sendchange">sendchange</a>.
This option is used for two purposes. It is the location of the
<code>debugPort</code> for <samp><span class="command">debugclient</span></samp> and the location of the
<code>pb.PBChangeSource</code> for <samp><span class="command">sendchange</span></samp>. Generally these are the
same port.
<br><dt><code>debugPassword</code><dd>Equivalent to <code>--passwd</code> for <a href="debugclient.html#debugclient">debugclient</a>.
<p>XXX Must match the value of <code>c['debugPassword']</code>, used to protect the
debug port, for the <samp><span class="command">debugclient</span></samp> command.
<br><dt><code>username</code><dd>Equivalent to <code>--username</code> for the <a href="sendchange.html#sendchange">sendchange</a> command.
<br><dt><code>branch</code><dd>Equivalent to <code>--branch</code> for the <a href="sendchange.html#sendchange">sendchange</a> command.
<br><dt><code>category</code><dd>Equivalent to <code>--category</code> for the <a href="sendchange.html#sendchange">sendchange</a> command.
<br><dt><code>try_connect</code><dd>Equivalent to <code>--connect</code>, this specifies how the <a href="try.html#try">try</a> command should
deliver its request to the buildmaster. The currently accepted values are
“ssh” and “pb”.
<br><dt><code>try_builders</code><dd>Equivalent to <code>--builders</code>, specifies which builders should be used for
the <a href="try.html#try">try</a> build.
<br><dt><code>try_vc</code><dd>Equivalent to <code>--vc</code> for <a href="try.html#try">try</a>, this specifies the version control
system being used.
<br><dt><code>try_branch</code><dd>Equivlanent to <code>--branch</code>, this indicates that the current tree is on a non-trunk branch.
<br><dt><code>try_topdir</code><br><dt><code>try_topfile</code><dd>Use <code>try_topdir</code>, equivalent to <code>--try-topdir</code>, to explicitly
indicate the top of your working tree, or <code>try_topfile</code>, equivalent to
<code>--try-topfile</code> to name a file that will only be found in that top-most
directory.
<br><dt><code>try_host</code><br><dt><code>try_username</code><br><dt><code>try_dir</code><dd>When <code>try_connect</code> is “ssh”, the command will use <code>try_host</code> for
<code>--tryhost</code>, <code>try_username</code> for <code>--username</code>, and <code>try_dir</code>
for <code>--trydir</code>. Apologies for the confusing presence and absence of
'try'.
<br><dt><code>try_username</code><br><dt><code>try_password</code><br><dt><code>try_master</code><dd>Similarly, when <code>try_connect</code> is “pb”, the command will pay attention to
<code>try_username</code> for <code>--username</code>, <code>try_password</code> for
<code>--passwd</code>, and <code>try_master</code> for <code>--master</code>.
<br><dt><code>try_wait</code><br><dt><code>masterstatus</code><dd><code>try_wait</code> and <code>masterstatus</code> (equivalent to <code>--wait</code> and
<code>master</code>, respectively) are used to ask the <a href="try.html#try">try</a> command to wait for
the requested build to complete.
</dl>
</body></html>
