[PATCH] D148913: [llvm][docs] Update "Adding a Builder" docs

[David Spickett via Phabricator via llvm-commits]

This revision was automatically updated to reflect the committed changes.
Closed by commit rG73f4f56c9fc8: [llvm][docs] Update "Adding a Builder" docs (authored by DavidSpickett).

Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D148913/new/

https://reviews.llvm.org/D148913

Files:
  llvm/docs/HowToAddABuilder.rst


Index: llvm/docs/HowToAddABuilder.rst
===================================================================
--- llvm/docs/HowToAddABuilder.rst
+++ llvm/docs/HowToAddABuilder.rst
@@ -63,8 +63,8 @@
    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
+   infrastructure should have all dependencies installed and be able to
+   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.
 
@@ -92,11 +92,25 @@
                     <buildbot-worker-access-name> \
                     <buildbot-worker-access-password>
 
-   This will cause your new worker to connect to the staging buildmaster
-   which is silent by default.  Only once a new worker is stable, and
+   Only once a new worker is stable, and
    approval from Galina has been received (see last step) should it
    be pointed at the main buildmaster.
 
+   Now start the worker:
+
+    .. code-block:: bash
+
+       $ buildbot-worker start <buildbot-worker-root-directory>
+
+   This will cause your new worker to connect to the staging buildmaster
+   which is silent by default.
+
+   Try this once then check the log file
+   ``<buildbot-worker-root-directory>/worker/twistd.log``. If your settings
+   are correct you will see a refused connection. This is good and expected,
+   as the credentials have not been established on both ends. Now stop the
+   worker and proceed to the next steps.
+
 #. Fill the buildbot-worker description and admin name/e-mail.  Here is an
    example of the buildbot-worker description::
 
@@ -108,10 +122,8 @@
        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 buildbot-worker successfully. Then set
-   up your buildbot-worker 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.
+   See `here <http://docs.buildbot.net/current/manual/installation/worker.html>`_
+   for which files to edit.
 
 #. Send a patch which adds your build worker and your builder to
    `zorg <https://github.com/llvm/llvm-zorg>`_. Use the typical LLVM
@@ -138,10 +150,15 @@
    otherwise.
 
 #. Send the buildbot-worker access name and the access password directly to
-   `Galina Kistanova <mailto:gkistanova at gmail.com>`_, and wait till she
-   will let you know that your changes are applied and buildmaster is
+   `Galina Kistanova <mailto:gkistanova at gmail.com>`_, and wait until she
+   lets you know that your changes are applied and buildmaster is
    reconfigured.
 
+#. Make sure you can start the buildbot-worker and successfully connect
+   to the silent buildmaster. Then set up your buildbot-worker 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.
+
 #. Check the status of your buildbot-worker on the `Waterfall Display (Staging)
    <http://lab.llvm.org/staging/#/waterfall>`_ to make sure it is
    connected, and the `Workers Display (Staging)


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D148913.516330.patch
Type: text/x-patch
Size: 3393 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20230424/e7607009/attachment.bin>