1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
// file : bbot/agent.cli
// copyright : Copyright (c) 2014-2017 Code Synthesis Ltd
// license : TBC; see accompanying LICENSE file
include <bbot/common.cli>;
"\section=1"
"\name=bbot-agent"
"\summary=build bot agent"
namespace bbot
{
{
"<options> <url>",
"
\h|SYNOPSIS|
\cb{bbot-agent --help}\n
\cb{bbot-agent --version}\n
\c{\b{bbot-agent} [<options>] <url>...}
\h|DESCRIPTION|
\cb{bbot-agent} @@ TODO.
Note that on termination \cb{bbot-agent} may leave a working machine
snapshot behind. It is expected that the caller (normally Build OS
monitor) cleans them up before restarting the agent.
"
}
class agent_options
{
"\h|OPTIONS|"
bool --help {"Print usage information and exit."}
bool --version {"Print version and exit."}
bool --systemd-daemon
{
"Start as a simple systemd daemon."
}
string --toolchain-name = "default"
{
"<str>",
"Toolchain name, \cb{default} by default."
}
size_t --toolchain-num = 1
{
"<num>",
"Toolchain number, 1 by default."
}
string --toolchain-id
{
"<str>",
"Toolchain id. If unspecified or empty, then no re-bootstrapping on
toolchain changes will be performed (which is primarily useful for
testing)."
}
size_t --cpu = 1
{
"<num>",
"Number of CPUs (threads) to use, 1 by default."
}
size_t --ram (1024 * 1024) // 1G
{
"<num>",
"Amount of RAM (in kB) to use, 1G by default."
}
dir_path --machines = "/build/machines/"
{
"<dir>",
"The location of the build machines, \cb{/build/machines/} by default."
}
dir_path --tftp = "/build/tftp/"
{
"<dir>",
"The location of the TFTP server root, \cb{/build/tftp/} by default."
}
size_t --bootstrap-timeout = 600
{
"<sec>",
"Maximum number of seconds to wait for machine bootstrap completion,
600 (10 minutes) by default."
}
size_t --build-timeout = 1800
{
"<sec>",
"Maximum number of seconds to wait for build completion, 1800 (30
minutes) by default."
}
size_t --request-timeout = 300
{
"<sec>",
"Maximum number of seconds to wait for controller request completion,
300 (5 minutes) by default."
}
uint16_t --verbose = 1
{
"<level>",
"Set the diagnostics verbosity to <level> between 0 and 6 with level 1
being the default."
}
// Testing options.
//
bool --dump-machines
{
"Dump the available machines to \cb{stdout}, (re)-bootstrapping any if
necessary, and exit."
}
bool --dump-task
{
"Dump the received build task to \cb{stdout} and exit."
}
bool --dump-result
{
"Dump the obtained build result to \cb{stdout} and exit."
}
bool --fake-bootstrap
{
"Fake the machine bootstrap process by creating the expected bootstrapped
machine manifest."
}
bool --fake-build
{
"Fake the package building process by creating the aborted build result."
}
path --fake-request
{
"<file>",
"Fake the task request process by reading the task manifest from <file>
(or \cb{stdin} if <file> is '\cb{-}')."
}
};
"
\h|EXIT STATUS|
Non-zero exit status is returned in case of an error.
"
}
|
