Generate bindist-result.manifest if bbot.bindist.upload worker step is enabled

1 files changed, 33 insertions, 0 deletions

diff --git a/doc/manual.cli b/doc/manual.cli
index f916049..eb48a31 100644
--- a/doc/manual.cli
+++ b/doc/manual.cli
@@ -2101,6 +2101,39 @@ shift
 exec \"$@\" cc config.c=\"gcc-9 $mode\" config.cxx=\"g++-9 $mode\"
 \
 
+\h2#arch-worker-bindist-result|Bindist Result Manifest|
+
+At the \c{bbot.bindist.upload} step the worker also creates the
+\c{bindist-result.json} and \c{bindist-result.manifest} files in the
+\c{upload/bindist/<distribution>/} directory, next to the generated binary
+distribution package files. The \c{bindist-result.json} file contains the
+structured JSON output of the \l{bpkg-pkg-bindist(1)} command. The
+\c{bindist-result.manifest} file contains the subset of the information from
+\c{bindist-result.json}. Specifically, it starts with the binary distribution
+package header manifest followed by a list of package file manifests. The
+manifest values are:
+
+\
+distribution:
+architecture:
+os-release-name-id:
+os-release-version-id:
+package-name:
+package-version:
+[package-system-version]:
+
+package-file-type:
+package-file-path:
+[package-file-system-name]:
+\
+
+The manifest values derive from the corresponding JSON object values and
+preserve their semantics. The only differences are that the
+\c{os-release-version-id} value may not be absent and the
+\c{package-file-path} values are relative to the
+\c{upload/bindist/<distribution>/} directory and are in the POSIX
+representation. See \l{bpkg-pkg-bindist(1)} for the JSON values semantics.
+
 \h#arch-controller|Controller Logic|
 
 A \c{bbot} controller that issues own build tasks maps available build