33 Commits

Author SHA1 Message Date
David Spickett
ee4fb3a876 [llvm][docs] Correct setence in How To Add A Builder
Looks like a few different phrasings got mashed up together.
2024-11-19 13:36:13 +00:00
Alex Bradbury
2baead09b2 [docs] Add blank line before bulletpoint list to fix HowToAddABuilder
The bulletpoint list wasn't rendering properly due to a missing blank
line.
2024-11-13 05:26:02 +00:00
Alex Bradbury
8da61a3434
[llvm][docs] Expand HowToAddABuilder with guidance on testing locally (#115024)
With <https://github.com/llvm/llvm-zorg/pull/289> and <https://github.com/llvm/llvm-zorg/pull/293> landed, it's now reasonable to ask people to test their builder configurations locally. This patch adds documentation on how to do so.
2024-11-12 22:02:20 +00:00
David Spickett
7c04da12f0
[llvm][docs] Add terminology note to Buildbot docs (#115856)
Choosing another term for this one document would only create confusion,
and vendoring Buildbot to change it is a lot of work (as explained in
the linked Buildbot issue).
2024-11-12 12:45:43 +00:00
David Spickett
57cd6d8634
[llvm][docs] Document how to get admin permissions for a Buildbot worker (#108561)
I spent a long time trying different combinations of primary and
verified emails, until a colleague tried it who happened to have a
public profile email set when I did not.

Document how this works to save everyone else the legwork.
2024-10-14 09:09:20 +01:00
Kazu Hirata
96ddbd6dd8 [llvm] Fix typos in documentation 2023-05-12 23:47:46 -07:00
David Spickett
611491d73b [llvm][docs] Correct chose to choose in the builder docs 2023-04-26 09:47:11 +00:00
David Spickett
73f4f56c9f [llvm][docs] Update "Adding a Builder" docs
* Move step 8 to later, after worker credentials have
  been added to the buildmaster.
* Added command for starting the worker, in addition
  to creating the worker. The latter only sets up the
  directories.
* Noted that in step 6, it is expected that you get a
  refused connection.
* Stated that the connection should be tried once,
  and the worker then stopped.

We could mention that repeated connections with invalid
credentials will result in an IP ban, but it's probably
detail people don't need here.

If it did happen, then you would not know until you tried
the later steps. At which point you are already in contact
with Galina, who is the person who would help you with that
issue in any case.

Reviewed By: gkistanova

Differential Revision: https://reviews.llvm.org/D148913
2023-04-24 10:58:35 +01:00
Alex Bradbury
cac180523e [docs] Document how frequently the staging buildmaster configuration is reconfigured
Differential Revision: https://reviews.llvm.org/D144465
2023-03-08 10:48:01 +00:00
Alex Bradbury
50613578d9 [docs] Improve guidance on installing the correct buildbot-worker version
The docs currently state that buildbot-worker 2.8.5 is used. However,
looking at the buildbot release notes
<http://docs.buildbot.net/current/relnotes/index.html>, this release
doesn't seem to exist (it's not on PyPI either). The document also links
to http://trac.buildbot.net/ as a source to retrieve an old version and
install it manually, but this is dead.

Instead, drop that advice and suggest pip3 install
buildbot-worker==2.8.4, as done by the Dockerfiles in
llvm-zorg/buildbot/google/docker/*.

Differential Revision: https://reviews.llvm.org/D144464
2023-02-21 18:39:42 +00:00
Philip Reames
157d565502 [docs] Update new builder instructions to starting on the staging buildmaster
This adds a step in the instructions to switch to the production buildmaster at the very end (after explicit approval), and updates the early instruction to start with the builder pointed at the staging buildmaster.

Differential Revision: https://reviews.llvm.org/D116129
2021-12-22 18:21:17 -08:00
Philip Reames
1a76a3a7e4 [docs] Incorprate first round of feedback on D114325
This builds on the text landed in 73d52ee78, and incorporates the points that Renato brought up.

Differential Revision: https://reviews.llvm.org/D114325
2021-11-22 11:02:38 -08:00
Philip Reames
73d52ee785 Add a best practice section on how to configure a fast builder
This is based on conversations with a couple of folks currently running buildbots. There's a couple pieces which didn't make it in, but this tries to cover the common themes.

Differential Revision: https://reviews.llvm.org/D114325
2021-11-21 08:01:29 -08:00
Shao-Ce SUN
0c660256eb [NFC] Trim trailing whitespace in *.rst 2021-11-15 09:17:08 +08:00
Philip Reames
ab4375e999 [docs] Update new builder instructions to default to building each change
We generally prefer build bots which build each change as they come in as long as they can keep up. This generates much higher quality feedback to a developer. However, the code structure is such that we currently default new builders to batching.

This change updates the getting started instruction for a builder to explicitly advocate for not collapsing requests.

Differential Revision: https://reviews.llvm.org/D112776
2021-11-04 09:36:53 -07:00
Philip Reames
386633a041 [doc] Update a broken link in buildbot instructions 2021-10-28 18:46:51 -07:00
Philip Reames
a70a5636a8 [docs] Expand a bit on the basics of a buildbot policy
We don't have much publicly documented about how build bots are maintained, and who has what responsibility with regards to the bots themselves and failures they report.

This change adds some basic framing on the topic. It is intended to simplify document long standing practice, and to avoid introducing any new policy elements. I do want to propose a couple of changes, but those will happen with their own review and broader discussion.

Differential Revision: https://reviews.llvm.org/D112755
2021-10-28 14:51:18 -07:00
Mehdi Amini
90babc86c3 Fix URLs to the prod/staging buildbot master in the doc
Differential Revision: https://reviews.llvm.org/D110565
2021-09-28 06:18:26 +00:00
Douglas Yung
f20bb857ad Update filename to workers.py file in documentation
Commit be9f322e8dc530a56f03356aad31fa9031b27e26 moved the list of workers from
slaves.py to workers.py, but the documentation in "How To Add A Builder" was
never updated and now references a non-existing file. This fixes that.

Reviewed By: gkistanova

Differential Revision: https://reviews.llvm.org/D94886
2021-01-22 00:20:26 -08:00
Konrad Kleine
f0f76aea37 [doc] Apply buildbot worker terminology change: slave->worker
Recently [1], there was an upgrade to the version of buildbot being
deployed. The new setup will still work with old buildslaves but I
thought it might be a good idea to update the documentation to reflect,
that you now can use a newer buildbot version to when setting up your
worker (formely known as slave).

The upgrade from buildbot 0.8.5 to 2.8.5 went a long with a transition
to a new "worker" terminology [2] which is also reflected by this
change.

[1]: http://lists.llvm.org/pipermail/llvm-dev/2020-October/145629.html
[2]: http://docs.buildbot.net/0.9.12/manual/worker-transition.html

Reviewed By: gkistanova

Differential Revision: https://reviews.llvm.org/D89230
2020-10-20 06:43:09 -04:00
Eric Christopher
ae2fa770e1 [docs/examples] As part of using inclusive language within the llvm
project, migrate away from the use of blacklist and whitelist.
2020-06-20 00:51:18 -07:00
Mircea Trofin
fa42620afb [docs] Referenced llvm workflow in HowToAddABuilder
Reviewers: gkistanova, dblaikie

Subscribers: llvm-commits

Tags: #llvm

Differential Revision: https://reviews.llvm.org/D81046
2020-06-04 16:39:11 -07:00
Mircea Trofin
ee33ee68fe [docs] Add link to zorg github project
Reviewers: gkistanova

Subscribers: llvm-commits

Tags: #llvm

Differential Revision: https://reviews.llvm.org/D79891
2020-05-13 13:41:16 -07:00
Nico Weber
3b42eb3512 wrap an rst file to 80 cols, to cycle bots 2019-12-06 17:28:02 -05:00
Galina Kistanova
0d1990e2e7 Added more info on silent master to the doc.
llvm-svn: 307200
2017-07-05 20:45:44 +00:00
Galina Kistanova
5fda6a90e0 Cosmetic change.
llvm-svn: 301253
2017-04-24 21:06:29 +00:00
Galina Kistanova
c7524f05b2 Small addition on how to add a builder.
llvm-svn: 301248
2017-04-24 20:48:40 +00:00
Dylan McKay
7457130f7a [docs] Document the staging buildbot
Summary:
This also adds docs to suggest that maintainers of buildbots for
experimental backends should use this buildmaster.

Reviewers: dsanders, grosser, asb, mehdi_amini

Reviewed By: grosser

Subscribers: llvm-commits

Differential Revision: https://reviews.llvm.org/D29560

llvm-svn: 294144
2017-02-05 21:21:23 +00:00
Dylan McKay
32add8121d [docs] Fix a broken URL in 'HowToAddABuilder'
llvm-svn: 282718
2016-09-29 13:29:49 +00:00
Dylan McKay
fa9fbfe248 [docs] Fix typo in 'How to add a builder'
llvm-svn: 282713
2016-09-29 12:51:26 +00:00
Sean Silva
92a44897a2 docs: Fix long standing linking antipattern.
Before we learned about :doc:, we used :ref: and put a dummy link at the
top of each page. Don't do that anymore.

This fixes PR14891 as a special case.

llvm-svn: 172162
2013-01-11 02:28:08 +00:00
Chris Lattner
045a73e62d remove the rest of the "written by" lines in the documentation. It is
against the developer policy to include this sort of thing as SVN blame
already captures this in a far more fine-grained way.

llvm-svn: 172109
2013-01-10 21:24:04 +00:00
Galina Kistanova
8201936f60 Patch by Sean Silva!
The patch converts the "How to add a builder" document over to reStructuredText..

llvm-svn: 163860
2012-09-13 23:51:08 +00:00