From 2cdf8357b2eb3ddaf726c2cd51bff524e8faa3d6 Mon Sep 17 00:00:00 2001
From: Karen Arutyunov <karen@codesynthesis.com>
Date: Thu, 2 Feb 2023 14:45:42 +0300
Subject: Add support for package config options in worker

---
 doc/manual.cli | 39 ++++++++++++++++++++++-----------------
 1 file changed, 22 insertions(+), 17 deletions(-)

(limited to 'doc')

diff --git a/doc/manual.cli b/doc/manual.cli
index 59b20c7..4e5a3c0 100644
--- a/doc/manual.cli
+++ b/doc/manual.cli
@@ -174,13 +174,14 @@ configuration, this information is best conveyed as part of \c{<target>} as
 described in \l{#arch-controller Controller Logic}.
 
 A package can be built in multiple package configurations per target
-configuration. A build package configuration normally specifies the package
-configuration variables that need to be used for the build. It may also
-include the information regarding the dependency packages which need to
-additionally be configured. The build package configurations originate from
-the package manifest \c{*-build-config}, \c{*-builds}, \c{*-build-include},
-and \c{*-build-exclude} values. See \l{bpkg#manifest-package Package Manifest}
-for more information on these values.
+configuration. A build package configuration normally specifies the options
+and/or the package configuration variables that need to be used for the
+build. It may also include the information regarding the dependency packages
+which need to additionally be configured. The build package configurations
+originate from the package manifest \c{*-build-config}, \c{*-builds},
+\c{*-build-include}, and \c{*-build-exclude} values. See
+\l{bpkg#manifest-package Package Manifest} for more information on these
+values.
 
 \h#arch-machine-header|Machine Header Manifest|
 
@@ -966,7 +967,7 @@ breakpoint and normally as a prefix in the \c{<tgt-config-args>},
 \l{#arch-controller Controller Logic}. The \c{<>}-values are from the task
 manifest and the environment though some are assigned by the worker during the
 script execution (configuration directories, UUIDs, etc). In particular, the
-\c{<pkg-config-vars>}, \c{<dependency-name>},
+\c{<pkg-config-opts>}, \c{<pkg-config-vars>}, \c{<dependency-name>},
 \c{<dependency-version-constraint>}, and \c{<dep-config-vars>} values result
 from parsing the \l{#arch-task-package-config \c{package-config}} task
 manifest value.
@@ -1021,11 +1022,13 @@ bpkg -v fetch --trust <repository-fp>
 #   bpkg.global.configure.build,
 #   (bpkg.target.configure.build : b.configure, bpkg.configure.build))
 #
-bpkg -v build --configure-only <env-config-args> <tgt-config-args> \\
+bpkg -v build --configure-only \\
+     [<pkg-config-opts>] <env-config-args> <tgt-config-args> \\
      [{ <pkg-config-vars> }+] <package-name>/<package-version> \\
      [<test-package-name>[ <test-version-constraint>]...] \\
      [([{ <dep-config-vars> }+] \\
-       ?[sys:]<dependency-name>[ <dependency-version-constraint>])...]
+       (?[sys:]|sys:)<dependency-name> \\
+       [<dependency-version-constraint>])...]
 
 # bpkg.update
 #
@@ -1107,7 +1110,7 @@ bpkg -v update <package-name>
     #
     bpkg -v build --configure-only <env-config-args> <tgt-config-args> \\
          <test-package-name>[ <test-version-constraint>]... \\
-         ?sys:<package-name>
+         ?sys:<package-name>/<package-version>
 
     # For each (runtime) tests, examples, or benchmarks package
     # referred to by the task manifest:
@@ -1237,7 +1240,8 @@ bpkg -v fetch -d <host-conf> --trust <repository-fp>
 # - All parts have the same fallback step ids: b.configure and
 #   bpkg.configure.build.
 #
-bpkg -v build --configure-only <env-config-args> <tgt-config-args> \\
+bpkg -v build --configure-only \\
+[<pkg-config-opts>] <env-config-args> <tgt-config-args> \\
 \\
 { --config-uuid <host-uuid> \\
   <env-config-args> <tgt-config-args> [<pkg-config-vars>] }+ \\
@@ -1255,7 +1259,7 @@ bpkg -v build --configure-only <env-config-args> <tgt-config-args> \\
 \\
 ({ --config-uuid <host-uuid> [--config-uuid <install-uuid>] \\
    [<dep-config-vars>] }+ \\
- ?[sys:]<dependency-name>[ <dependency-version-constraint>])...
+ (?[sys:]|sys:)<dependency-name>[ <dependency-version-constraint>])...
 
 # bpkg.update
 #
@@ -1398,7 +1402,7 @@ bpkg -v update -d <host-conf> <package-name>
     { --config-name <target-conf> }+ \\
     <buildtime-test-package-name>[ <test-version-constraint>]... \\
     \\
-    ?sys:<package-name>
+    ?sys:<package-name>/<package-version>
 
     # For each tests, examples, or benchmarks package referred
     # to by the task manifest:
@@ -1517,7 +1521,8 @@ bpkg -v fetch -d <module-conf> --trust <repository-fp>
 # - All parts have the same fallback step ids: b.configure and
 #   bpkg.configure.build.
 #
-bpkg -v build --configure-only <env-config-args> <tgt-config-args> \\
+bpkg -v build --configure-only \\
+[<pkg-config-opts>] <env-config-args> <tgt-config-args> \\
 \\
 { --config-uuid <module-uuid> \\
   <env-config-args> <tgt-config-args> [<pkg-config-vars>] }+ \\
@@ -1532,7 +1537,7 @@ bpkg -v build --configure-only <env-config-args> <tgt-config-args> \\
 \\
 ({ --config-uuid <host-uuid> [--config-uuid <install-uuid>] \\
    [<dep-config-vars>] }+ \\
- ?[sys:]<dependency-name>[ <dependency-version-constraint>])...
+ (?[sys:]|sys:)<dependency-name>[ <dependency-version-constraint>])...
 
 # bpkg.update
 #
@@ -1615,7 +1620,7 @@ bpkg -v update -d <module-conf> <package-name>
     { --config-name <target-conf> }+ \\
     <buildtime-test-package-name>[ <test-version-constraint>]... \\
     \\
-    ?sys:<package-name>
+    ?sys:<package-name>/<package-version>
 
     # For each (build-time) tests, examples, or benchmarks package
     # referred to by the task manifest:
-- 
cgit v1.1