Patch by Sean Silva!
authorGalina Kistanova <gkistanova@gmail.com>
Thu, 13 Sep 2012 23:51:08 +0000 (23:51 +0000)
committerGalina Kistanova <gkistanova@gmail.com>
Thu, 13 Sep 2012 23:51:08 +0000 (23:51 +0000)
The patch converts the "How to add a builder" document over to reStructuredText..

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@163860 91177308-0d34-0410-b5e6-96231b3b80d8

docs/HowToAddABuilder.html [deleted file]
docs/HowToAddABuilder.rst [new file with mode: 0644]
docs/userguides.rst

diff --git a/docs/HowToAddABuilder.html b/docs/HowToAddABuilder.html
deleted file mode 100644 (file)
index 985b30e..0000000
+++ /dev/null
@@ -1,142 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
-                      "http://www.w3.org/TR/html4/strict.dtd">
-<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>
-  <link rel="stylesheet" href="_static/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="#steps">Steps To Add Builder To LLVM Buildbot</a></li>
-</ol>
-<div class="doc_author">
-  <p>Written by <a href="mailto:gkistanova@gmail.com">Galina Kistanova</a></p>
-</div>
-
-<!-- *********************************************************************** -->
-<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>
-
-</div>
-
-<!-- *********************************************************************** -->
-<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.</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
-      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. 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
-      install it manually.</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:gkistanova@gmail.com">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>
-
-<!-- *********************************************************************** -->
-<hr>
-<address>
-  <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
-  src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
-  <a href="http://validator.w3.org/check/referer"><img
-  src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
-  <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a>
-  <br>
-  Last modified: $Date: 2011-10-31 12:50:0 -0700 (Mon, 31 Oct 2011) $
-</address>
-</body>
-</html>
diff --git a/docs/HowToAddABuilder.rst b/docs/HowToAddABuilder.rst
new file mode 100644 (file)
index 0000000..b0cd290
--- /dev/null
@@ -0,0 +1,90 @@
+.. _how_to_add_a_builder:
+
+===================================================================
+How To Add Your Build Configuration To LLVM Buildbot Infrastructure
+===================================================================
+
+.. sectionauthor:: Galina Kistanova <gkistanova@gmail.com>
+
+Introduction
+============
+
+This document contains information about adding a build configuration and
+buildslave to private slave builder to LLVM Buildbot Infrastructure
+`<http://lab.llvm.org:8011>`_.
+
+
+Steps To Add Builder To LLVM Buildbot
+=====================================
+Volunteers can provide their build machines to work as build slaves to
+public LLVM Buildbot.
+
+Here are the steps you can follow to do so:
+
+#. 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.
+
+#. 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.
+
+#. 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
+   `<http://trac.buildbot.net>`_ and install it manually.
+
+#. Create a designated user account, your buildslave will be running under,
+   and set appropriate permissions.
+
+#. 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.
+
+#. Create a buildslave in context of that buildslave account.  Point it to
+   the **lab.llvm.org** port **9990** (see `Buildbot documentation,
+   Creating a slave
+   <http://buildbot.net/buildbot/docs/current/full.html#creating-a-slave>`_
+   for more details) by running the following command:
+
+    .. code-block:: bash
+
+       $ buildslave create-slave <buildslave-root-directory> \
+                    lab.llvm.org:9990 \
+                    <buildslave-access-name> <buildslave-access-password>
+
+#. Fill the buildslave description and admin name/e-mail.  Here is an
+   example of the buildslave description::
+
+       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
+
+#. 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.
+
+#. Send a patch which adds your build slave and your builder to zorg.
+
+   * slaves are added to ``buildbot/osuosl/master/config/slaves.py``
+   * builders are added to ``buildbot/osuosl/master/config/builders.py``
+
+#. Send the buildslave access name and the access password directly to
+   `Galina Kistanova <mailto:gkistanova@gmail.com>`_, and wait till she
+   will let you know that your changes are applied and buildmaster is
+   reconfigured.
+
+#. Check the status of your buildslave on the `Waterfall Display
+   <http://lab.llvm.org:8011/waterfall>`_ to make sure it is connected, and
+   ``http://lab.llvm.org:8011/buildslaves/<your-buildslave-name>`` to see
+   if administrator contact and slave information are correct.
+
+#. Wait for the first build to succeed and enjoy.
index 26a5a8ccc237b141a29a02bca663c1a37564e240..fa6e3cfff23c7e3694a703718fc5c64af8425c45 100644 (file)
@@ -13,6 +13,7 @@ User Guides
    FAQ
    Lexicon
    Packaging
+   HowToAddABuilder
 
 * `The LLVM Getting Started Guide <GettingStarted.html>`_
     
@@ -78,7 +79,7 @@ User Guides
 
    Definition of acronyms, terms and concepts used in LLVM.
 
-* `How To Add Your Build Configuration To LLVM Buildbot Infrastructure <HowToAddABuilder.html>`_
+* :ref:`how_to_add_a_builder`
 
    Instructions for adding new builder to LLVM buildbot master.