aboutsummaryrefslogtreecommitdiff
path: root/bbot/worker/worker.cli
diff options
context:
space:
mode:
Diffstat (limited to 'bbot/worker/worker.cli')
-rw-r--r--bbot/worker/worker.cli102
1 files changed, 102 insertions, 0 deletions
diff --git a/bbot/worker/worker.cli b/bbot/worker/worker.cli
new file mode 100644
index 0000000..09e09a3
--- /dev/null
+++ b/bbot/worker/worker.cli
@@ -0,0 +1,102 @@
+// file : bbot/worker.cli
+// copyright : Copyright (c) 2014-2017 Code Synthesis Ltd
+// license : TBC; see accompanying LICENSE file
+
+include <bbot/common.cli>;
+
+"\section=1"
+"\name=bbot-worker"
+"\summary=build bot worker"
+
+namespace bbot
+{
+ {
+ "<options> <module> <conf-var>",
+
+ "
+ \h|SYNOPSIS|
+
+ \cb{bbot-worker --help}\n
+ \cb{bbot-worker --version}\n
+ \c{\b{bbot-worker --bootstrap} [<options>]}\n
+ \c{\b{bbot-worker --startup} [<options>]}\n
+ \c{\b{bbot-worker} [<options>] <module>... <conf-var>...}
+
+ \h|DESCRIPTION|
+
+ \cb{bbot-worker} @@ TODO.
+
+ If the \cb{--bootstrap} mode option is specified, then the worker performs
+ the initial machine bootstrap and writes the bootstrap result manifest to
+ \c{stdout}. If the \cb{--startup} mode option is specified, then the
+ worker performs the environment setup and then re-executes in the build
+ mode. If neither of the mode options is specified, then the worker
+ proceeds to performing the build task.
+ "
+ }
+
+ class worker_options
+ {
+ "\h|OPTIONS|"
+
+ //
+ // NOTE: when adding new options, consider whether they should be
+ // propagated from startup to build.
+ //
+
+ bool --help {"Print usage information and exit."}
+ bool --version {"Print version and exit."}
+
+ bool --bootstrap
+ {
+ "Perform the inital machine bootstrap insteading of building."
+ }
+
+ bool --startup
+ {
+ "Perform the environment setup and then re-execute for building."
+ }
+
+ bool --systemd-daemon
+ {
+ "Run as a simple systemd daemon."
+ }
+
+ dir_path --build
+ {
+ "<dir>",
+ "The directory to perform the build in. If not specified, then the
+ current working directory is used."
+ }
+
+ dir_path --environments
+ {
+ "<dir>",
+ "The directory containing the environment setup executables. If not
+ specified, then the user's home directory is used."
+ }
+
+ uint16_t --verbose = 1
+ {
+ "<level>",
+ "Set the diagnostics verbosity to <level> between 0 and 6 with level 1
+ being the default."
+ }
+
+ // Testing options.
+ //
+ string --tftp-host = "196.254.111.222"
+ {
+ "<addr>",
+ "The TFTP host address and, optionally, port to use to download the
+ build task and to upload the build result. By default the link-local
+ address 196.254.111.222 with the standard TFTP port (69) is used."
+ }
+ };
+
+ "
+ \h|EXIT STATUS|
+
+ Non-zero exit status is returned in case of an error.
+ "
+}