path: root/doc
diff options
authorKaren Arutyunov <karen@codesynthesis.com>2019-04-17 22:46:39 +0300
committerKaren Arutyunov <karen@codesynthesis.com>2019-04-26 18:34:05 +0300
commit559fbe0cbdb16f0c7c3a2f33e326a3b5930fd3f3 (patch)
tree6b767619db5cd11737b3bdd6b2e7c10e100c7018 /doc
parent86c8ca15782026e1927fd36021a8b2b2972b7d71 (diff)
Add support for overrides parameter in CI request handler
Diffstat (limited to 'doc')
2 files changed, 29 insertions, 1 deletions
diff --git a/doc/cli.sh b/doc/cli.sh
index 4f0547f..e32ee02 100755
--- a/doc/cli.sh
+++ b/doc/cli.sh
@@ -39,12 +39,14 @@ function compile ()
cli -I .. -v project="brep" -v version="$version" -v date="$date" \
--include-base-last "${o[@]}" --generate-html --html-prologue-file \
man-prologue.xhtml --html-epilogue-file man-epilogue.xhtml --html-suffix .xhtml \
+--link-regex '%bpkg([-.].+)%../../bpkg/doc/bpkg$1%' \
--link-regex '%brep(#.+)?%build2-repository-interface-manual.xhtml$1%' \
cli -I .. -v project="brep" -v version="$version" -v date="$date" \
--include-base-last "${o[@]}" --generate-man --man-prologue-file \
man-prologue.1 --man-epilogue-file man-epilogue.1 --man-suffix .1 \
+--link-regex '%bpkg(#.+)?%$1%' \
--link-regex '%brep(#.+)?%$1%' \
@@ -71,6 +73,7 @@ cli -I .. \
--html-epilogue-file doc-epilogue.xhtml \
--link-regex '%b([-.].+)%../../build2/doc/b$1%' \
--link-regex '%bpkg([-.].+)%../../bpkg/doc/bpkg$1%' \
+--link-regex '%bpkg(#.+)?%../../bpkg/doc/build2-package-manager-manual.xhtml$1%' \
--output-prefix build2-repository-interface- manual.cli
html2ps -f doc.html2ps:a4.html2ps -o build2-repository-interface-manual-a4.ps build2-repository-interface-manual.xhtml
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
\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