From 83843619aad7570a603091d4ae486614b56d54e6 Mon Sep 17 00:00:00 2001
From: Karen Arutyunov <karen@codesynthesis.com>
Date: Fri, 3 Apr 2020 16:39:10 +0300
Subject: Add support for test-exclude task manifest value

---
 doc/manual.cli | 32 ++++++++++++++++++++++++++------
 1 file changed, 26 insertions(+), 6 deletions(-)

(limited to 'doc')

diff --git a/doc/manual.cli b/doc/manual.cli
index 4191d6d..85ad89a 100644
--- a/doc/manual.cli
+++ b/doc/manual.cli
@@ -321,6 +321,7 @@ version: <package-version>
 repository-url: <repository-url>
 [repository-type]: pkg|git|dir
 [trust]: <repository-fp>
+[test-exclude]: <package-name>/<package-version>
 
 machine: <machine-name>
 target: <target-triplet>
@@ -385,6 +386,21 @@ some agents may only trust their internally-specified fingerprints to prevent
 the \"man in the middle\" attacks.
 
 
+\h2#arch-task-test-exclude|\c{test-exclude}|
+
+\
+[test-exclude]: <package-name>/<package-version>
+\
+
+The separate test, example, or benchmark package to exclude from building
+together with the primary package. This value may be specified multiple times.
+
+The controller adds this value for packages specified via the \c{tests},
+\c{examples}, and \c{benchmarks} primary package manifest values which should
+be excluded from building due to their \c{builds}, \c{build-include}, and
+\c{build-exclude} manifest values.
+
+
 \h2#arch-task-machine|\c{machine}|
 
 \
@@ -795,7 +811,8 @@ bpkg -v update <package-name>
 bpkg -v test <package-name>
 
 # for each package referred to by the tests, examples, or benchmarks
-# package manifest values:
+# package manifest values and not excluded by the test-exclude task
+# manifest values:
 #
 {
   # bpkg.configure.build
@@ -837,7 +854,8 @@ bpkg -v test <package-name>
   }
 
   # if any of the tests, examples, or benchmarks package manifest
-  # values are specified:
+  # values are specified and are not all excluded by the test-exclude
+  # task manifest values:
   #
   {
     # bpkg.test-installed.create
@@ -853,7 +871,8 @@ bpkg -v test <package-name>
     bpkg -v fetch --trust <repository-fp>
 
     # for each package referred to by the tests, examples, or
-    # benchmarks package manifest values:
+    # benchmarks package manifest values and not excluded by the
+    # test-exclude task manifest values:
     #
     {
       # bpkg.configure.build
@@ -1062,9 +1081,10 @@ that applies to the \c{bpkg.configure.create} step, then in addition to
 building and possibly running tests, the \c{bbot} worker will also test
 installing and uninstalling each package. Furthermore, if the package contains
 subprojects that support the test operation and/or refers to other packages
-via the \c{tests}, \c{examples}, or \c{benchmarks} manifest values, then the
-worker will additionally build such subprojects/packages against the
-installation and run their tests.
+via the \c{tests}, \c{examples}, or \c{benchmarks} manifest values which are
+not excluded by the \c{test-exclude} task manifest values, then the worker
+will additionally build such subprojects/packages against the installation and
+run their tests.
 
 Two types of installations can be tested: \i{system} and \i{private}. A system
 installation uses a well-known location, such as \c{/usr} or \c{/usr/local},
-- 
cgit v1.1