Previous: Other Tools, Up: Command-line Tool

5.4 .buildbot config directory

Many of the buildbot 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 buildbot command will look for a special directory named .buildbot, 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 options in this directory, and will evaluate it as a python script, looking for certain names to be set. You can just put simple name = 'value' pairs in this file to set the options.

For a description of the names used in this file, please see the documentation for the individual buildbot sub-commands. The following is a brief sample of what this file's contents could be.

     # for status-reading tools
     masterstatus = ''
     # for 'sendchange' or the debug port
     master = ''
     debugPassword = 'eiv7Po'

Note carefully that the names in the options file usually do not match the command-line option name.

Equivalent to --master for statuslog and statusgui, this gives the location of the client.PBListener status port.
Equivalent to --master for debugclient and sendchange. This option is used for two purposes. It is the location of the debugPort for debugclient and the location of the pb.PBChangeSource for sendchange. Generally these are the same port.
Equivalent to --passwd for debugclient.

XXX Must match the value of c['debugPassword'], used to protect the debug port, for the debugclient command.

Equivalent to --username for the sendchange command.
Equivalent to --branch for the sendchange command.
Equivalent to --category for the sendchange command.
Equivalent to --connect, this specifies how the try command should deliver its request to the buildmaster. The currently accepted values are “ssh” and “pb”.
Equivalent to --builders, specifies which builders should be used for the try build.
Equivalent to --vc for try, this specifies the version control system being used.
Equivlanent to --branch, this indicates that the current tree is on a non-trunk branch.
Use try_topdir, equivalent to --try-topdir, to explicitly indicate the top of your working tree, or try_topfile, equivalent to --try-topfile to name a file that will only be found in that top-most directory.
When try_connect is “ssh”, the command will use try_host for --tryhost, try_username for --username, and try_dir for --trydir. Apologies for the confusing presence and absence of 'try'.
Similarly, when try_connect is “pb”, the command will pay attention to try_username for --username, try_password for --passwd, and try_master for --master.
try_wait and masterstatus (equivalent to --wait and master, respectively) are used to ask the try command to wait for the requested build to complete.