From 7deb025de3b2142a19d0e93a7c9f55015069bd5b Mon Sep 17 00:00:00 2001 From: Giuseppe Di Natale Date: Thu, 24 Aug 2017 20:29:07 -0700 Subject: [PATCH] Updated Buildbot Options (markdown) --- Buildbot-Options.md | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/Buildbot-Options.md b/Buildbot-Options.md index 6f7be31..dc1aef2 100644 --- a/Buildbot-Options.md +++ b/Buildbot-Options.md @@ -4,7 +4,6 @@ testing. More detailed information regarding its implementation can be found at [ZFS Buildbot Github page](https://github.com/zfsonlinux/zfs-buildbot). ## Choosing Builders - By default, all commits in your ZFS pull request are compiled by the BUILD builders. Additionally, the top commit of your ZFS pull request is tested by TEST builders. However, there is the option to override which types of builder @@ -43,6 +42,7 @@ This text is part of the commit message body. Signed-off-by: Contributor Requires-builders: style test ``` + ## Requiring SPL Versions The ZFS Buildbot supports specifying the SPL version to build to provide SPL pull request testing. By opening a pull request against ZFS and using the `Requires-spl:` @@ -58,6 +58,47 @@ Signed-off-by: Contributor Requires-spl: refs/pull/123/head ``` +## Build Steps Overrides +Each builder will execute or skip build steps based on its default +preferences. In some scenarios, it might be possible to skip various build +steps. The ZFS buildbot supports overriding the defaults of all builders +in a commit message. The list of available overrides are: + +* `Build-linux: `: All builders should build Linux for this commit +* `Build-lustre: `: All builders should build Lustre for this commit +* `Build-spl: `: All builders should build the SPL for this commit +* `Build-zfs: `: All builders should build ZFS for this commit +* `Built-in: `: All Linux builds should build in SPL and ZFS +* `Check-lint: `: All builders should perform lint checks for this commit +* `Configure-lustre: `: Provide `` as configure parameters when building Lustre +* `Configure-spl: `: Provide `` as configure parameters when building the SPL +* `Configure-zfs: `: Provide `` as configure parameters when building ZFS + +A couple of examples on how to use overrides in commit messages can be found below. + +### Skip building the SPL and build Lustre without ldiskfs +``` +This is a commit message + +This text is part of the commit message body. + +Signed-off-by: Contributor +Build-lustre: Yes +Configure-lustre: --disable-ldiskfs +Build-spl: No +``` + +### Build ZFS Only +``` +This is a commit message + +This text is part of the commit message body. + +Signed-off-by: Contributor +Build-lustre: No +Build-spl: No +``` + ## Configuring Tests with the TEST File At the top level of the ZFS source tree, there is the [`TEST` file](https://github.com/zfsonlinux/zfs/blob/master/TEST) which contains variables