Skip to content

Commit

Permalink
Cleaned text, fixed HTML.
Browse files Browse the repository at this point in the history 
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@143607 91177308-0d34-0410-b5e6-96231b3b80d8
  • Loading branch information
@gkistanova
gkistanova committed Nov 3, 2011
1 parent 463fe24 commit b65bc5a
Showing 1 changed file with 88 additions and 72 deletions.
160 changes: 88 additions & 72 deletions docs/HowToAddABuilder.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,20 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>How To Add Your Build Configuration To LLVM Buildbot Infrastructure</title>
<title>
How To Add Your Build Configuration To LLVM Buildbot Infrastructure
</title>
<link rel="stylesheet" href="llvm.css" type="text/css">
</head>
<body>

<h1>How To Add Your Build Configuration To LLVM Buildbot Infrastructure</h1>
<ol>
<li><a href="#introduction">Introduction</a></li>
<li><a href="#process">Steps To Add Builder To LLVM Buildbot</a></li>
<li><a href="#steps">Steps To Add Builder To LLVM Buildbot</a></li>
</ol>
<div class="doc_author">
<p>Written by <a href="mailto:[email protected]">Galina Kistanova</a>
</p>
<p>Written by <a href="mailto:[email protected]">Galina Kistanova</a></p>
</div>

<!-- *********************************************************************** -->
Expand All @@ -24,89 +25,104 @@ <h2><a name="introduction">Introduction</a></h2>

<div>

<p>This document contains information about adding a build configuration and
buildslave to private slave builder to LLVM Buildbot Infrastructure
<a href="http://lab.llvm.org:8011">http://lab.llvm.org:8011</a>
<p>This document contains information about adding a build configuration and
buildslave to private slave builder to LLVM Buildbot Infrastructure
<a href="http://lab.llvm.org:8011">http://lab.llvm.org:8011</a></p>

</div>

<!-- *********************************************************************** -->
<h2><a name="process">Steps To Add Builder To LLVM Buildbot</a></h2>
<h2><a name="steps">Steps To Add Builder To LLVM Buildbot</a></h2>
<!-- *********************************************************************** -->

<div>

<p>Volunteers can provide their build machines to work as build slaves to
public LLVM Buildbot. Below described recommended steps to implement this
task.</p>
public LLVM Buildbot.</p>

<p>The steps are roughly as follows:</p>
<p>Here are the steps you can follow to do so:</p>

<ol>
<li><p>Check the existing build configurations to make sure the one you are
interested in is not covered yet or gets built on your computer much
faster than on the existing one. We prefer faster builds so developers
<li><p>Check the existing build configurations to make sure the one you are
interested in is not covered yet or gets built on your computer much
faster than on the existing one. We prefer faster builds so developers
will get feedback sooner after changes get committed.</p></li>

<li><p>The computer you will be registering with the LLVM buildbot
infrastructure should have all dependencies installed and you can
actually build your configuration successfully. You can build multiple
configurations on one computer.</p></li>
<li><p>The computer you will be registering with the LLVM buildbot
infrastructure should have all dependencies installed and you can
actually build your configuration successfully. Please check what degree
of parallelism (-j param) would give the fastest build.
You can build multiple configurations on one computer.</p></li>

<li><p>Install buildslave (currently we are using buildbot version 0.8.5).
Depending on the platform, buildslave could be available to download and
install with your packet manager, or you can download it directly from
<a href="http://trac.buildbot.net">http://trac.buildbot.net</a> and
<li><p>Install buildslave (currently we are using buildbot version 0.8.5).
Depending on the platform, buildslave could be available to download and
install with your packet manager, or you can download it directly from
<a href="http://trac.buildbot.net">http://trac.buildbot.net</a> and
install it manually.</p></li>

<li><p>Create a designated user account your buildslave will be running
under.</p></li>

<li><p>Choose the buildslave root directory (all builds will be placed under
it), buildslave access name and password the build master will be using
to authenticate your build slave.</p></li>

<li><p>Then create a build slave in context of that buildslave account.
Point it to the lab.llvm.org port 9990<br />
(see <tt>http://buildbot.net/buildbot/docs/current/full.html#creating-a-slave</tt>
for more details) by running the following command:
<div class="doc_code">
<pre>
$ buildslave create-slave <i>buildslave-root-directory</i> lab.llvm.org: 9990 \
<i>buildslave-access-name buildslave-access-password</i>
</pre></div></p></li>

<li><p>Fill the build slave description and admin name/e-mail.
Here is an example of the build slave description:
<div class="doc_code">
<pre>
Windows 7 x64
Core i7 (2.66GHz), 16GB of RAM

g++.exe (TDM-1 mingw32) 4.4.0
GNU Binutils 2.19.1
cmake version 2.8.4
Microsoft(R) 32-bit C/C++ Optimizing Compiler Version 16.00.40219.01 for 80x86
</pre></div></p></li>

<li><p>Make sure you can actually start the buildslave successfully. Then set
up your build slave to start automatically at the start up time.
See buildbot manual for help. You may want to restart your computer to see if it works.</p></li>

<li><p>Send a patch which adds your build slave and builder to zorg.<br />
* slaves are added to<br />
<tt>http://llvm.org/svn/llvm-project/zorg/trunk/buildbot/osuosl/master/config/slaves.py</tt><br />
* builders are added to<br />
<tt>http://llvm.org/svn/llvm-project/zorg/trunk/buildbot/osuosl/master/config/builders.py</tt></p></li>

<li><p>Then send the buildslave access name and password directly to
<a href="mailto:[email protected]">Galina Kistanova</a>

<li><p>Check the status of your buildslave on
http://lab.llvm.org:8011/waterfall to make sure it is connected, and
http://lab.llvm.org:8011/buildslaves/&lt;your buildslave name&gt; to see
if the information is correct.</p></li>

<li><p>Wait for the first build to succeed and see if it could go faster with
higher degree of parallelism (-j param).</p></li>
<li><p>Create a designated user account, your buildslave will be running
under, and set appropriate permissions.</p></li>

<li><p>Choose the buildslave root directory (all builds will be placed under
it), buildslave access name and password the build master will be using
to authenticate your buildslave.</p></li>

<li><p>Create a buildslave in context of that buildslave account.
Point it to the <b>lab.llvm.org</b> port <b>9990</b> (see
<a href="http://buildbot.net/buildbot/docs/current/full.html#creating-a-slave">
Buildbot documentation, Creating a slave</a>
for more details) by running the following command:</p>

<div class="doc_code">
<pre>
$ buildslave create-slave <i>buildslave-root-directory</i> \
lab.llvm.org:9990 \
<i>buildslave-access-name buildslave-access-password</i>
</pre>
</div></li>

<li><p>Fill the buildslave description and admin name/e-mail.
Here is an example of the buildslave description:</p>

<div class="doc_code">
<pre>
Windows 7 x64
Core i7 (2.66GHz), 16GB of RAM

g++.exe (TDM-1 mingw32) 4.4.0
GNU Binutils 2.19.1
cmake version 2.8.4
Microsoft(R) 32-bit C/C++ Optimizing Compiler Version 16.00.40219.01 for 80x86
</pre>
</div></li>

<li><p>Make sure you can actually start the buildslave successfully. Then set
up your buildslave to start automatically at the start up time.
See the buildbot documentation for help.
You may want to restart your computer to see if it works.</p></li>

<li><p>Send a patch which adds your build slave and your builder to zorg.</p>
<ul>
<li>slaves are added to
<tt>buildbot/osuosl/master/config/slaves.py</tt></li>
<li>builders are added to
<tt>buildbot/osuosl/master/config/builders.py</tt></li>
</ul></li>

<li><p>Send the buildslave access name and the access password directly
to <a href="mailto:[email protected]">Galina Kistanova</a>, and wait
till she will let you know that your changes are applied and buildmaster
is reconfigured.</p>

<li><p>Check the status of your buildslave on the
<a href="http://lab.llvm.org:8011/waterfall">Waterfall Display</a>
to make sure it is connected, and
<a href="http://lab.llvm.org:8011/buildslaves/your-buildslave-name">
http://lab.llvm.org:8011/buildslaves/&lt;your-buildslave-name&gt;</a>
to see if administrator contact and slave information are correct.</p>
</li>

<li><p>Wait for the first build to succeed and enjoy.</p></li>
</ol>

</div>
Expand Down

0 comments on commit b65bc5a

Please sign in to comment.