Skip to content

Commit 50dbfbb

Browse files
committed
Fix keepalive, port table, and info path in buildbot worker docs
1 parent 7c37b96 commit 50dbfbb

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

testing/new-buildbot-worker.rst

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -274,9 +274,10 @@ machine reboots:
274274
service as described in the `buildbot documentation
275275
<https://docs.buildbot.net/current/manual/installation/misc.html#launching-worker-as-windows-service>`__.
276276

277-
To start the worker running for your initial testing, you can do::
277+
If you have not already started the worker through a service manager, you
278+
can start it manually for initial testing::
278279

279-
buildbot-worker start buildarea
280+
buildbot-worker start /path/to/workerdir
280281

281282
Then you can either wait for someone to make a commit, or you can pick a
282283
builder associated with your worker from the `list of builders
@@ -289,11 +290,11 @@ only of failures on your builders, so doing periodic spot checks is also a good
289290
idea.
290291

291292
.. note::
292-
If your buildbot worker is disconnecting regularly, it may be a symptom of the
293-
default ``keepalive`` value (``600`` for 10 minutes) being `set
294-
<https://docs.buildbot.net/latest/manual/installation/worker.html#cmdoption-buildbot-worker-create-worker-keepalive>`__
295-
too high. You can change it to a lower value (for example, ``180`` for 3 minutes)
296-
in the ``buildbot.tac`` file found in your build area.
293+
The buildmaster uses a ``keepalive`` interval of ``60`` seconds. Ensure
294+
the ``keepalive`` setting in your ``buildbot.tac`` matches (the default
295+
of ``600`` is too high and can cause spurious disconnections). It is
296+
also recommended to set ``delete_leftover_dirs = 1`` so that build
297+
directories the master no longer needs are cleaned up automatically.
297298

298299

299300
Latent workers
@@ -357,7 +358,7 @@ Necessary tasks include, obviously, keeping the buildbot running. Currently
357358
the system for notifying buildbot owners when their workers go offline is not
358359
working; this is something we hope to resolve. So currently it is helpful if
359360
you periodically check the status of your worker. We will also contact you
360-
via your contact address in ``buildarea/info/admin`` when we notice there is a
361+
via your contact address in ``info/admin`` when we notice there is a
361362
problem that has not been resolved for some period of time and you have
362363
not responded to a posting on the python-buildbots list about it.
363364

@@ -386,19 +387,19 @@ a table listing all of the outbound ports used by the buildbot and the python
386387
test suite (this list may not be complete as new tests may have been added
387388
since this table was last vetted):
388389

389-
======= =================== ================================================
390-
Port Host Description
391-
======= =================== ================================================
392-
20, 21 ftp.debian.org test_urllib2net
393-
53 your DNS server test_socket, and others implicitly
394-
80 python.org (several tests)
390+
======= ========================== ================================================
391+
Port Host Description
392+
======= ========================== ================================================
393+
20, 21 ftp.debian.org test_urllib2net
394+
53 your DNS server test_socket, and others implicitly
395+
80 python.org (several tests)
395396
example.com
396-
119 news.gmane.org test_nntplib (Python versions < 3.13)
397-
443 (various) test_ssl
398-
465 smtp.gmail.com test_smtpnet
399-
587 smtp.gmail.com test_smtpnet
400-
9020 python.org connection to buildmaster
401-
======= =================== ================================================
397+
119 news.gmane.org test_nntplib (Python versions < 3.13)
398+
443 (various) test_ssl
399+
465 smtp.gmail.com test_smtpnet
400+
587 smtp.gmail.com test_smtpnet
401+
9020 buildbot-api.python.org connection to buildmaster
402+
======= ========================== ================================================
402403

403404
Many tests will also create local TCP sockets and connect to them, usually
404405
using either ``localhost`` or ``127.0.0.1``.

0 commit comments

Comments
 (0)