From 559fbe0cbdb16f0c7c3a2f33e326a3b5930fd3f3 Mon Sep 17 00:00:00 2001
From: Karen Arutyunov <karen@codesynthesis.com>
Date: Wed, 17 Apr 2019 22:46:39 +0300
Subject: Add support for overrides parameter in CI request handler

---
 doc/manual.cli | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

(limited to 'doc/manual.cli')

diff --git a/doc/manual.cli b/doc/manual.cli
index 56ae05e..61ef1f8 100644
--- a/doc/manual.cli
+++ b/doc/manual.cli
@@ -221,6 +221,11 @@ case all the versions of this package present in the repository will be
 tested, or both the name and version in the \c{<name>/<version>} form (for
 example, \c{libhello/1.2.3}.|
 
+\li|Verify the optional \c{overrides} parameter.
+
+The overrides parameter, if specified, must be the CI overrides manifest
+upload.|
+
 \li|Verify other parameters are valid manifest name/value pairs.
 
 The value can only contain printable ASCII characters as well as tab
@@ -236,6 +241,10 @@ is created in the \c{ci-data} directory with this id as its name.|
 The CI request manifest is saved as \c{request.manifest} into the request
 subdirectory created on the previous step.|
 
+\li|Save the CI overrides manifest into the request directory.
+
+If the CI overrides manifest is uploaded, then it is saved as
+\c{overrides.manifest} into the request subdirectory.|
 
 \li|Invoke the CI handler program.
 
@@ -283,7 +292,8 @@ reference: <request-id>
 \li|Send the CI request email.
 
 If \c{ci-email} is configured, send an email to this address containing the CI
-request manifest and the CI result manifest.|
+request manifest, the potentially empty CI overrides manifest, and the CI
+result manifest.|
 
 \li|Respond to the client.
 
@@ -329,6 +339,21 @@ is in the ISO-8601 \c{<YYYY>-<MM>-<DD>T<hh>:<mm>:<ss>Z} form (always
 UTC). Note also that \c{client-ip} can be IPv4 or IPv6.
 
 
+\h#ci-overrides-manifest|CI Overrides Manifest|
+
+The CI overrides manifest is a package manifest fragment that should be
+applied to all the packages being tested. The contained values override the
+whole value groups they belong to, resetting all the group values prior to
+being applied. Currently, only the following value groups can be overridden:
+
+\
+build-email build-{warning,error}-email
+builds build-{include,exclude}
+\
+
+See \l{bpkg#manifest-package Package Manifest} for details on these values.
+
+
 \h#ci-result-manifest|CI Result Manifest|
 
 The CI result manifest starts with the below values and in that order
-- 
cgit v1.1