docs/HowToAddABuilder.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2                       "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   6   <title>How To Add Your Build Configuration To LLVM Buildbot Infrastructure</title>
   7   <link rel="stylesheet" href="llvm.css" type="text/css">
   8 </head>
   9 <body>
  10
  11 <h1>How To Release LLVM To The Public</h1>
  12 <ol>
  13   <li><a href="#introduction">Introduction</a></li>
  14   <li><a href="#criteria">Steps To Add Builder To LLVM Buildbot</a></li>
  15 </ol>
  16 <div class="doc_author">
  17   <p>Written by <a href="mailto:gkistanova@gmail.com">Galina Kistanova</a>
  18   </p>
  19 </div>
  20
  21 <!-- *********************************************************************** -->
  22 <h2><a name="introduction">Introduction</a></h2>
  23 <!-- *********************************************************************** -->
  24
  25 <div>
  26
  27 <p>This document contains information about adding private slave builder to
  28    LLVM Buildbot Infrastructure: <tt>http://lab.llvm.org:8011</tt>
  29 </div>
  30
  31 <!-- *********************************************************************** -->
  32 <h2><a name="process">Steps To Add Builder To LLVM Buildbot</a></h2>
  33 <!-- *********************************************************************** -->
  34 <div>
  35
  36 <p>Volunters can provide there build machines to work as slave builders to
  37    public LLVM Buildbot. Below described recommended steps to implement this
  38    task.</p>
  39
  40 <p>The steps are roughly as follows:</p>
  41
  42 <ol>
  43   <li><p>Check the existing build configurations to make sure the one you are
  44       interested in is not covered yet or gets built on your computer much
  45       faster than existing one. We prefer faster builds so developers will get
  46       feedback sooner after changes get committed.</p></li>
  47
  48   <li><p>The computer you will be registering with the LLVM buildbot
  49       infrastructure should have all dependencies installed and you can
  50       actually build your configuration successfully. You can build multiple
  51       configurations on one computer.</p></li>
  52
  53   <li><p>Install buildslave (currently we are using buildbot version 0.8.5).
  54       Depending on the platform, buildslave could be available to download and
  55       install with your packet manager, or you can download it directly from
  56       <tt>http://trac.buildbot.net/</tt> and install it manually.</p></li>
  57
  58   <li><p>Create a designated user account your buildslave will be running
  59       under.</p></li>
  60
  61   <li><p>Choose the buildslave root directory (all builds will be placed under
  62       it), buildslave access name and password the build master will be using
  63       to authenticate your build slave.</p></li>
  64
  65   <li><p>Then create a build slave in context of that buildslave account.
  66       Point it to the <tt>lab.llvm.org port 9990</tt><br />
  67       (see <tt>http://buildbot.net/buildbot/docs/current/full.html#creating-a-slave</tt>
  68       for more details) by running the following command:
  69       <div class="doc_code">
  70       <pre>
  71       $ buildslave create-slave <i>buildslave-root-directory</i> lab.llvm.org: 9990 \
  72       <i>buildslave-access-name buildslave-access-password</i>
  73       </pre></div></p></li>
  74
  75   <li><p>Fill the build slave description and admin name/e-mail.
  76       Here is an example of the build slave description:
  77       <div class="doc_code">
  78       <pre>
  79            Windows 7 x64
  80            Core i7 (2.66GHz), 16GB of RAM
  81
  82            g++.exe (TDM-1 mingw32) 4.4.0
  83            GNU Binutils 2.19.1
  84            cmake version 2.8.4
  85            Microsoft(R) 32-bit C/C++ Optimizing Compiler Version 16.00.40219.01 for 80x86
  86       </pre></div></p></li>
  87
  88   <li><p>Make sure you can actually start the buildslave successfully. Then set
  89       up your build slave to start automatically at the start up time.
  90       See buildbot manual for help.</p></li>
  91
  92   <li><p>Send a patch which adds your build slave and builder to zorg.<br />
  93            * slaves are added to<br />
  94 <tt>http://llvm.org/svn/llvm-project/zorg/trunk/buildbot/osuosl/master/config/slaves.py</tt><br />
  95            * builders are added to<br />
  96 <tt>http://llvm.org/svn/llvm-project/zorg/trunk/buildbot/osuosl/master/config/builders.py</tt></p></li>
  97
  98   <li><p>Then send the buildslave access name and password directly to
  99       <a href="mailto:gkistanova@gmail.com">Galina Kistanova</a>
 100
 101   <li><p>Finally, the end!</p></li>
 102 </ol>
 103
 104 </div>
 105
 106 <!-- *********************************************************************** -->
 107 <hr>
 108 <address>
 109   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 110   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
 111   <a href="http://validator.w3.org/check/referer"><img
 112   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
 113   <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a>
 114   <br>
 115   Last modified: $Date: 2011-10-31 12:50:0 -0700 (Mon, 31 Oct 2011) $
 116 </address>
 117 </body>
 118 </html>