aboutsummaryrefslogtreecommitdiff
path: root/doc/manual.cli
diff options
context:
space:
mode:
authorKaren Arutyunov <karen@codesynthesis.com>2023-04-04 01:10:44 +0300
committerKaren Arutyunov <karen@codesynthesis.com>2023-04-06 16:19:54 +0300
commitb92c1c200deef9a4e2bbd686080ecc4c64c22d10 (patch)
treeba84aa43cdacd678bf8fe082f16b2735731531df /doc/manual.cli
parentab8a3a6c226e047afeda08423ff5d8873631314d (diff)
Add support for bpkg.bindist.* step ids
Diffstat (limited to 'doc/manual.cli')
-rw-r--r--doc/manual.cli91
1 files changed, 83 insertions, 8 deletions
diff --git a/doc/manual.cli b/doc/manual.cli
index 8b64687..5c76c32 100644
--- a/doc/manual.cli
+++ b/doc/manual.cli
@@ -1060,13 +1060,29 @@ bpkg -v update <package-name>
bpkg -v test <package-name>
}
-# If config.install.root is specified:
+# If config.install.root is specified and no
+# bpkg.bindist.{debian,fedora,archive} step is enabled:
#
{
# bpkg.install
#
bpkg -v install <package-name>
+}
+
+# If bpkg.bindist.{debian,fedora,archive} step is enabled:
+#
+{
+ # bpkg.bindist.{debian,fedora,archive}
+ #
+ bpkg -v bindist --distribution <distribution> \\
+ <env-config-args> <tgt-config-args> <pkg-config-args> \\
+ <package-name>
+}
+# If the main package is installed either from source or from the
+# binary distribution package:
+#
+{
# If the package contains subprojects that support the test
# operation:
#
@@ -1090,7 +1106,7 @@ bpkg -v update <package-name>
}
# If task manifest refers to any (runtime) tests, examples, or
- # benchmarks packages.
+ # benchmarks packages:
#
{
# bpkg.test-separate-installed.create (
@@ -1134,7 +1150,11 @@ bpkg -v update <package-name>
bpkg -v test <package-name>
}
}
+}
+# If the main package is installed from source:
+#
+{
# bpkg.uninstall
#
bpkg -v uninstall <package-name>
@@ -1315,13 +1335,30 @@ bpkg -v update -d <host-conf> <package-name>
bpkg -v test -d <target-conf> <package-name>
}
-# If configuration is self-hosted and config.install.root is specified:
+# If configuration is self-hosted, config.install.root is specified,
+# and no bpkg.bindist.{debian,fedora,archive} step is enabled:
#
{
# bpkg.install
#
bpkg -v install -d <install-conf> <package-name>
+}
+# If configuration is self-hosted and
+# bpkg.bindist.{debian,fedora,archive} step is enabled:
+#
+{
+ # bpkg.bindist.{debian,fedora,archive}
+ #
+ bpkg -v bindist --distribution <distribution> \\
+ <env-config-args> <tgt-config-args> <pkg-config-args> \\
+ <package-name>
+}
+
+# If the main package is installed either from source or from the
+# binary distribution package:
+#
+{
# If the package contains subprojects that support the test
# operation:
#
@@ -1437,7 +1474,11 @@ bpkg -v update -d <host-conf> <package-name>
bpkg -v test <package-name>
}
}
+}
+# If the main package is installed from source:
+#
+{
# bpkg.uninstall
#
bpkg -v uninstall -d <install-conf> <package-name>
@@ -1591,13 +1632,30 @@ bpkg -v update -d <module-conf> <package-name>
bpkg -v test -d <target-conf> <package-name>
}
-# If configuration is self-hosted and config.install.root is specified:
+# If configuration is self-hosted, config.install.root is specified,
+# and no bpkg.bindist.{debian,fedora,archive} step is enabled:
#
{
# bpkg.install
#
bpkg -v install -d <install-conf> <package-name>
+}
+# If configuration is self-hosted and
+# bpkg.bindist.{debian,fedora,archive} step is enabled:
+#
+{
+ # bpkg.bindist.{debian,fedora,archive}
+ #
+ bpkg -v bindist --distribution <distribution> \\
+ <env-config-args> <tgt-config-args> <pkg-config-args> \\
+ <package-name>
+}
+
+# If the main package is installed either from source or from the
+# binary distribution package:
+#
+{
# If task manifest refers to any (build-time) tests, examples, or
# benchmarks packages:
#
@@ -1665,7 +1723,11 @@ bpkg -v update -d <module-conf> <package-name>
bpkg -v test -d <target-conf> <package-name>
}
}
+}
+# If the main package is installed from source:
+#
+{
# bpkg.uninstall
#
bpkg -v uninstall -d <install-conf> <package-name>
@@ -1781,14 +1843,27 @@ bpkg.update
bpkg.test
bpkg.test-separate.update
bpkg.test-separate.test
-bpkg.bindist # Disabled by default.
-bpkg.install # Disabled if bpkg.bindist is enabled.
-bbot.sys-install # Disabled if bpkg.bindist is disabled.
+
+# Disabled if bpkg.bindist.* is enabled.
+#
+bpkg.install
+
+# Disabled by default.
+#
+bpkg.bindist.{debian,fedora,archive}
+
+# Disabled if bpkg.bindist.* is disabled.
+#
+bbot.sys-install
+
b.test-installed.test
bpkg.test-separate-installed.update
bpkg.test-separate-installed.test
\
+Note that the \c{bpkg.bindist.*} steps are mutually exclusive and only the
+last step status change via the \c{(+|-)bpkg.bindist.*} prefix is considered.
+
Unprefixed values only apply to the \c{*.create[_for_*]} steps. Note that
options with values can only be specified using the single argument
notation. For example:
@@ -1796,7 +1871,7 @@ notation. For example:
\
bpkg:--fetch-timeout=600 \\
bpkg.configure.fetch:--fetch-timeout=60 \\
-+bpkg.bindist: \\
++bpkg.bindist.debian: \\
b:-j1
\