diff --git a/docs/HowToAddABuilder.html b/docs/HowToAddABuilder.html deleted file mode 100644 index 985b30e4f7b..00000000000 --- a/docs/HowToAddABuilder.html +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - How To Add Your Build Configuration To LLVM Buildbot Infrastructure - - - - - -

How To Add Your Build Configuration To LLVM Buildbot Infrastructure

-
    -
  1. Introduction
    2. -
  2. Steps To Add Builder To LLVM Buildbot
    3. -
-
-

Written by Galina Kistanova

-
- - -

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:

- -
    -

  1. 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.

    2. - -

  2. 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.

    3. - -

  3. 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.

    4. - -

  4. Create a designated user account, your buildslave will be running - under, and set appropriate permissions.

    5. - -

  5. 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.

    6. - -

  6. Create a buildslave in context of that buildslave account. - Point it to the lab.llvm.org port 9990 (see - - Buildbot documentation, Creating a slave - for more details) by running the following command:

    - -
    -
    -$ buildslave create-slave buildslave-root-directory \
-             lab.llvm.org:9990 \
-             buildslave-access-name buildslave-access-password
-
    -
    7. - -

  7. 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
-
    -
    8. - -

  8. 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.

    9. - -

  9. 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
      • -
    10. - -

  10. Send the buildslave access name and the access password directly - to Galina Kistanova, and wait - till she will let you know that your changes are applied and buildmaster - is reconfigured.

    - -

  11. Check the status of your buildslave on the - Waterfall Display - 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.

    -
    12. - -

  12. Wait for the first build to succeed and enjoy.

    13. -
- -
- - -
-
- Valid CSS - Valid HTML 4.01 - The LLVM Compiler Infrastructure -
- Last modified: $Date: 2011-10-31 12:50:0 -0700 (Mon, 31 Oct 2011) $ -
- - diff --git a/docs/HowToAddABuilder.rst b/docs/HowToAddABuilder.rst new file mode 100644 index 00000000000..b0cd2907f97 --- /dev/null +++ b/docs/HowToAddABuilder.rst @@ -0,0 +1,90 @@ +.. _how_to_add_a_builder: + +=================================================================== +How To Add Your Build Configuration To LLVM Buildbot Infrastructure +=================================================================== + +.. sectionauthor:: Galina Kistanova + +Introduction +============ + +This document contains information about adding a build configuration and +buildslave to private slave builder to LLVM Buildbot Infrastructure +``_. + + +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 + ``_ 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 + `_ + for more details) by running the following command: + + .. code-block:: bash + + $ buildslave create-slave \ + lab.llvm.org:9990 \ + + +#. 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 `_, 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 + `_ to make sure it is connected, and + ``http://lab.llvm.org:8011/buildslaves/`` to see + if administrator contact and slave information are correct. + +#. Wait for the first build to succeed and enjoy. diff --git a/docs/userguides.rst b/docs/userguides.rst index 26a5a8ccc23..fa6e3cfff23 100644 --- a/docs/userguides.rst +++ b/docs/userguides.rst @@ -13,6 +13,7 @@ User Guides FAQ Lexicon Packaging + HowToAddABuilder * `The LLVM Getting Started Guide `_ @@ -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 `_ +* :ref:`how_to_add_a_builder` Instructions for adding new builder to LLVM buildbot master.