summaryrefslogtreecommitdiff
path: root/repa.1
blob: f95b7cff3d0740d6969e249ccbdd13c89fb7a562 (plain)
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
.TH REPA "1" "December 2013" "repa 0.2" "User Commands"

.SH NAME

.PP
repa - maintain code submissions to Tizen projects

.SH SYNOPSIS

.PP
.B repa [<global options>] <command> [<options>] <args>

.SH DESCRIPTION

.PP
\fIRepa\fR is a generic tool for maintaining code submissions to Tizen projects.
It allows to list submissions, group them into submission groups, accept or reject
them.

Submission is a code in the git tree(s) tagged with sumbit tag. Submission includes
code from one or multiple projects(so called group submission).

Submission group is a temporary group of submissions, created for testing purposes.

.PP
\fIRepa\fR commands:
.PP
.RS 2
1. \fBlist\fR - list submissions and submission groups
.RE
.RS 2
2. \fBinfo\fR - show detailed info about submission or submission group
.RE
.RS 2
3. \fBaccept\fR - accept submissions
.RE
.RS 2
4. \fBreject\fR - reject submissions
.RE
.RS 2
5. \fBgroup\fR - group submissions into submission group
.RE
.RS 2
6. \fBrmgroup\fR - remove submission group
.RE

.\" ===========================================================================
.\" Global options
.\" ===========================================================================
.SH GLOBAL OPTIONS

.RE
.B \-\-version
.RS 2
Print \fIrepa\fR version and exit.
.RE

.PP
.B \-h, \-\-help
.RS 2
Print short help text and exit.
.RE

.PP
.B \-s, \-\-section SECTION
.RS 2
Config section to use
.RE

.PP
.B \-p, \-\-project PROJECT
.RS 2
Target OBS project.
.RE


.\" ===========================================================================
.\" Commands descriptions
.\" ===========================================================================
.SH COMMANDS
.PP
.\"
.\" The "list" command description
.\"
.SS \fBlist\fR [\-\-help] [\-\-regexp <regexp>] [\-\-processes <processes>]

.RS 2
List submissions in the following format:

<Submission>  <Target OBS Project>  <status>  <list of git paths>

Example of output:

submit/tizen/20140327.041126          broken source          sdbd
.RS 0
submit/tizen/20140327.052722          package build failed   emulator-yagl
.RS 0
submit/tizen/20140327.055105          package building       libav zlib
.RS 0
submit/tizen/20140327.080733          image building         bluez
.RS 0
submit/tizen/20140328.063916          ready                  connman
.RS 0
submit/tizen/20140328.080409          ready                  sdbd
.RS 0

.RE

.\"
.\" The "list" command's options
.\"
.RS 2
\fBOPTIONS\fR
.RS 2
.B \-h, \-\-help
.RS 2
Print short help text about the "list" command and exit.
.RE

.PP
.B \-\-regexp
REGEXP
.RS 2
Use REGEXP to filter out submission project. Regexp is applied to OBS project name.
Note, that regexp can also be specified in \fIrepa\fR configuration file.
.RE

.PP
.B \-\-processes
PROCESSES
.RS 2
Use PROCESSES to specify the amount of python processes to run in parallel. Usage of this option can significantly speed up repa list.
Note, that this parameter can also be specified in \fIrepa\fR configuration file.

.RE

.PP
.\"
.\" The "info" command description
.\"
.SS \fBinfo\fR [\-\-help] \-\-project <project> <submission or group>

.RS 2
Show detailed information about submission

    Download Url: url of prerelease directory on download server
    OBS Url: url of prerelease OBS project
    Images: list of image names and their build statuses
    Package build failures: list of failed package builds

.PP

Example of output:

.RS 0
Submission: submit/tizen/20140328.213722
.RS 0
Download Url: http://download.tizen.org/prerelease/tizen/ivi/ivi/tizen_20140328.8/tizen_20140328.8.20140328.213722/
.RS 0
OBS Url: https://build.tizen.org/project/show?project=home:prerelease:Tizen:IVI:submit:tizen:20140328.213722
.RS 0

Images:
    ivi-min-mbr-i586                success
    ivi-min-efi-i586                success
    ivi-mbr-i586-emul               success
    ivi-mbr-i586                    success
    ivi-efi-i586                    success
    ivi-mbr-i586-JJ                 failed

Package build failures:
    wifi-direct-manager             failed
.RE

.\"
.\" The "info" command's options
.\"
.RS 2
\fBOPTIONS\fR
.RS 2
\-h, \-\-help
.RS 2
Print short help text about the "info" command and exit.
.RE

.\"
.\" The "accept" command description
.\"
.SS \fBaccept\fR [options] <list of submissions and groups>

.RS 2
Accept submissions and submission groups. Acceptance is done by creating
Submit Requests in OBS for every submission and immediately accepting them.

.\"
.\" The "accept" command's options
.\"
.RS 2
\fBOPTIONS\fR
.RS 2
\-h, \-\-help
.RS 2
Print short help text about the "accept" command and exit.
.RE

.PP
\-comment COMMENT
.RS 2
Add acceptance comment to created SRs.
.RE

.\"
.\" The "reject" command description
.\"
.SS \fBreject\fR [options] <list of submissions and groups>

.RS 2
Reject submissions and submission groups. Rejection is done by creating
Submit Requests in OBS for every submission and immediately rejecting them.

.\"
.\" The "reject" command's options
.\"
.RS 2
\fBOPTIONS\fR
.RS 2
\-h, \-\-help
.RS 2
Print short help text about the "reject" command and exit.
.RE

.PP
\-comment COMMENT
.RS 2
Add rejection comment to created SRs.
.RE

.\"
.\" The "group" command description
.\"
.SS \fBgroup\fR [options] <list of submissions>

.RS 2
Group submissions into submit group. Submit group is a temporary by its nature.
It's created for testing purposes. Internally submit group is an OBS project with
aggregated packages from groupped submissions. It's a way to test, accept or
or reject multiple submissions at once.

Note! No package builds are performed in group projects. The grouping function
aggregates binaries only and is intended only for image testing.

.\"
.\" The "group" command's options
.\"
.RS 2
\fBOPTIONS\fR
.RS 2
\-h, \-\-help
.RS 2
Print short help text about the "group" command and exit.
.RE

.PP
\-comment COMMENT
.RS 2
Add  comment to created submit group. It will be shown by list command.
.RE

.PP
\-f, \-\-force
.RS 2
Force group creation for submissions without binary packages. Useful when grouping failed submissions for rejection.
.RE

.\"
.\" The "rmgroup" command description
.\"
.SS \fBrmgroup\fR [options] <submit group>

.RS 2
Remove submit group.

.\"
.\" The "rmgroup" command's options
.\"
.RS 2
\fBOPTIONS\fR
.RS 2
\-h, \-\-help
.RS 2
Print short help text about the "rmgroup" command and exit.
.RE

.SH CONFIGURATION FILE

.RS 2
Configuration file has an INI-file syntax. \fIrepa\fR looks for config files in two locations: global /etc/repa.conf and local ~/.repa.conf. Values from global configuration file are overwritten by values from local configuration file. Command line options have highest priority and overwrite options from configuration files.
.RE

.RS 2
Example:
.RE

.RS 2
[general]
.RE
.RS 2
apiurl = https://api.tizen.org
.RE
.RS 2
apiuser = your_user_name
.RE
.RS 2
apipasswd = your_password
.RE
.RS 2
processes = 20
.RE
.RS 2
project = Tizen:IVI
.RE

.RS 2
Mandatory options: apiurl, apiuser, apipasswd and project
.RE

.RS 2
Some options (project, processes) can be overridden by commandline options (--project, --processes)
.RE

.SH BUGS
Please, report bugs to Ed Bartosh <eduard.bartosh@intel.com>.

.SH COPYRIGHT

Copyright (C) Intel Corporation 2013

.SH LICENCE
  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License, version 2,
  as published by the Free Software Foundation.
  .
  This program is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

.SH AUTHORS

Repa is developed and maintained by Ed Bartosh <eduard.bartosh@intel.com>.