repa.1

   1 .TH REPA "1" "December 2013" "repa 0.2" "User Commands"
   2
   3 .SH NAME
   4
   5 .PP
   6 repa - maintain code submissions to Tizen projects
   7
   8 .SH SYNOPSIS
   9
  10 .PP
  11 .B repa [<global options>] <command> [<options>] <args>
  12
  13 .SH DESCRIPTION
  14
  15 .PP
  16 \fIRepa\fR is a generic tool for maintaining code submissions to Tizen projects.
  17 It allows to list submissions, group them into submission groups, accept or reject
  18 them.
  19
  20 Submission is a code in the git tree(s) tagged with sumbit tag. Submission includes
  21 code from one or multiple projects(so called group submission).
  22
  23 Submission group is a temporary group of submissions, created for testing purposes.
  24
  25 .PP
  26 \fIRepa\fR commands:
  27 .PP
  28 .RS 2
  29 1. \fBlist\fR - list submissions and submission groups
  30 .RE
  31 .RS 2
  32 2. \fBinfo\fR - show detailed info about submission or submission group
  33 .RE
  34 .RS 2
  35 3. \fBaccept\fR - accept submissions
  36 .RE
  37 .RS 2
  38 4. \fBreject\fR - reject submissions
  39 .RE
  40 .RS 2
  41 5. \fBgroup\fR - group submissions into submission group
  42 .RE
  43 .RS 2
  44 6. \fBrmgroup\fR - remove submission group
  45 .RE
  46 .RS 2
  47 7. \fBdiff\fR - show the difference between projects
  48 .RE
  49
  50 .\" ===========================================================================
  51 .\" Global options
  52 .\" ===========================================================================
  53 .SH GLOBAL OPTIONS
  54
  55 .RE
  56 .B \-\-version
  57 .RS 2
  58 Print \fIrepa\fR version and exit.
  59 .RE
  60
  61 .PP
  62 .B \-h, \-\-help
  63 .RS 2
  64 Print short help text and exit.
  65 .RE
  66
  67 .PP
  68 .B \-s, \-\-section SECTION
  69 .RS 2
  70 Config section to use
  71 .RE
  72
  73 .PP
  74 .B \-p, \-\-project PROJECT
  75 .RS 2
  76 Target OBS project.
  77 .RE
  78
  79 .PP
  80 .B \-c, \-\-colorize
  81 .RS 2
  82 Turn on colorized output
  83 .RE
  84
  85 .\" ===========================================================================
  86 .\" Commands descriptions
  87 .\" ===========================================================================
  88 .SH COMMANDS
  89 .PP
  90 .\"
  91 .\" The "list" command description
  92 .\"
  93 .SS \fBlist\fR [\-\-help] [\-\-processes <processes>] [\-\-showurls] [\-\-ignore <regexp>]
  94
  95 .RS 2
  96 List submissions in the following format:
  97
  98 <Submission>  <Target OBS Project>  <status>  <list of git paths>
  99
 100 Example of output:
 101
 102 submit/tizen/20140327.041126          broken source          sdbd
 103 .RS 0
 104 submit/tizen/20140327.052722          package build failed   emulator-yagl
 105 .RS 0
 106 submit/tizen/20140327.055105          package building       libav zlib
 107 .RS 0
 108 submit/tizen/20140327.080733          image building         bluez
 109 .RS 0
 110 submit/tizen/20140328.063916          ready                  connman
 111 .RS 0
 112 submit/tizen/20140328.080409          ready                  sdbd
 113 .RS 0
 114
 115 .RE
 116
 117 .\"
 118 .\" The "list" command's options
 119 .\"
 120 .RS 2
 121 \fBOPTIONS\fR
 122 .RS 2
 123 .B \-h, \-\-help
 124 .RS 2
 125 Print short help text about the "list" command and exit.
 126 .RE
 127
 128 .PP
 129 .B \-\-processes
 130 PROCESSES
 131 .RS 2
 132 Use PROCESSES to specify the amount of python processes to run in parallel. Usage of this option can significantly speed up repa list.
 133 Note, that this parameter can also be specified in \fIrepa\fR configuration file.
 134 .RE
 135
 136 .PP
 137 .B \-\-showurls
 138 .RS 2
 139 Show OBS and download urls in the output. It's switched off by default.
 140 Note, that this parameter can also be specified in \fIrepa\fR configuration file.
 141 .RE
 142
 143 .PP
 144 .B \-\-ignore <regexp>
 145 .RS 2
 146 Ignore packaging failures for specified regexp. <regexp> is a slash-separated string <repository>/<architecture>/<package>, for example arm.*/armv7./.*_aggregate.
 147 Note, that this parameter can also be specified in \fIrepa\fR configuration file.
 148 .RE
 149
 150 .PP
 151 .\"
 152 .\" The "info" command description
 153 .\"
 154 .SS \fBinfo\fR [\-\-help] \-\-project <project> <submission or group>
 155
 156 .RS 2
 157 Show detailed information about submission
 158
 159     Download Url: url of prerelease directory on download server
 160     OBS Url: url of prerelease OBS project
 161     Images: list of image names and their build statuses
 162     Package build failures: list of failed package builds
 163
 164 .PP
 165
 166 Example of output:
 167
 168 .RS 0
 169 Submission: submit/tizen/20140328.213722
 170 .RS 0
 171 Download Url: http://download.tizen.org/prerelease/tizen/ivi/ivi/tizen_20140328.8/tizen_20140328.8.20140328.213722/
 172 .RS 0
 173 OBS Url: https://build.tizen.org/project/show?project=home:prerelease:Tizen:IVI:submit:tizen:20140328.213722
 174 .RS 0
 175
 176 Images:
 177     ivi-min-mbr-i586                success
 178     ivi-min-efi-i586                success
 179     ivi-mbr-i586-emul               success
 180     ivi-mbr-i586                    success
 181     ivi-efi-i586                    success
 182     ivi-mbr-i586-JJ                 failed
 183
 184 Package build failures:
 185     wifi-direct-manager             failed
 186 .RE
 187
 188 .\"
 189 .\" The "info" command's options
 190 .\"
 191 .RS 2
 192 \fBOPTIONS\fR
 193 .RS 2
 194 \-h, \-\-help
 195 .RS 2
 196 Print short help text about the "info" command and exit.
 197 .RE
 198
 199 .\"
 200 .\" The "accept" command description
 201 .\"
 202 .SS \fBaccept\fR [options] <submission or group>
 203
 204 .RS 2
 205 Accept submission or submission group. Acceptance is done by creating
 206 Submit Request in OBS for submission or group and immediately accepting it.
 207
 208 .\"
 209 .\" The "accept" command's options
 210 .\"
 211 .RS 2
 212 \fBOPTIONS\fR
 213 .RS 2
 214 \-h, \-\-help
 215 .RS 2
 216 Print short help text about the "accept" command and exit.
 217 .RE
 218
 219 .PP
 220 \-comment COMMENT
 221 .RS 2
 222 Add acceptance comment for created SR.
 223 .RE
 224
 225 .\"
 226 .\" The "reject" command description
 227 .\"
 228 .SS \fBreject\fR [options] <submission or group>
 229
 230 .RS 2
 231 Reject submission or submission group. Rejection is done by creating
 232 Submit Request in OBS for submission or group and immediately rejecting it.
 233
 234 .\"
 235 .\" The "reject" command's options
 236 .\"
 237 .RS 2
 238 \fBOPTIONS\fR
 239 .RS 2
 240 \-h, \-\-help
 241 .RS 2
 242 Print short help text about the "reject" command and exit.
 243 .RE
 244
 245 .PP
 246 \-comment COMMENT
 247 .RS 2
 248 Add rejection comment for created SR.
 249 .RE
 250
 251 .\"
 252 .\" The "group" command description
 253 .\"
 254 .SS \fBgroup\fR [options] <list of submissions>
 255
 256 .RS 2
 257 Group submissions into submit group. Submit group is a temporary by its nature.
 258 It's created for testing purposes. Internally submit group is an OBS project with
 259 aggregated packages from groupped submissions. It's a way to test, accept or
 260 or reject multiple submissions at once.
 261
 262 Note! No package builds are performed in group projects. The grouping function
 263 aggregates binaries only and is intended only for image testing.
 264
 265 .\"
 266 .\" The "group" command's options
 267 .\"
 268 .RS 2
 269 \fBOPTIONS\fR
 270 .RS 2
 271 \-h, \-\-help
 272 .RS 2
 273 Print short help text about the "group" command and exit.
 274 .RE
 275
 276 .PP
 277 \-comment COMMENT
 278 .RS 2
 279 Add  comment to created submit group. It will be shown by list command.
 280 .RE
 281
 282 .PP
 283 \-f, \-\-force
 284 .RS 2
 285 Force group creation for submissions without binary packages. Useful when grouping failed submissions for rejection.
 286 .RE
 287
 288 .\"
 289 .\" The "rmgroup" command description
 290 .\"
 291 .SS \fBrmgroup\fR [options] <submit group>
 292
 293 .RS 2
 294 Remove submit group.
 295
 296 .\"
 297 .\" The "rmgroup" command's options
 298 .\"
 299 .RS 2
 300 \fBOPTIONS\fR
 301 .RS 2
 302 \-h, \-\-help
 303 .RS 2
 304 Print short help text about the "rmgroup" command and exit.
 305 .RE
 306
 307 .PP
 308 .\"
 309 .\" The "diff" command description
 310 .\"
 311 .SS \fBdiff\fR [\-\-help] <project1> <manifest of target project> <manifest1>
 312
 313 .RS 2
 314 Show the difference between manifest of target project and manifest of <project1> in the following format:
 315
 316 <Git path>  <Revision in project1> <Revision in the target OBS Project>  <Tag, accepted into project1>  <status>
 317 .RS 0
 318
 319 Example of output:
 320
 321 $ repa -p Tizen:IVI diff Tizen:Common ivi_0140508.2_ia32.xml common_20140507.5_ia32.xml
 322
 323 platform/core/appfw/aul-1                          3644ad5459 e4f2b22012 submit/tizen/20140502.084937 pending
 324 .RS 0
 325 platform/core/appfw/shortcut                       502c7807b3 27bbf892e0 submit/tizen/20140430.020549 pending
 326 .RS 0
 327 platform/core/connectivity/nfc-manager-neard       ea952dc454 88793ab1ff
 328 .RS 0
 329 platform/core/connectivity/smartcard-service       e45ae0bdfb 7d5da70551 submit/tizen/20140506.101200 pending
 330 .RS 0
 331 platform/core/messaging/msg-service                c988cc8b55 a9eed6a734 submit/tizen/20140502.105814 pending
 332 .RS 0
 333 platform/core/system/tlm                           3ddbc6bc14 dc72779317 submit/tizen/20140430.130050
 334 .RS 0
 335 platform/framework/web/crosswalk                   42dcc1327b 4280e52757 submit/tizen/20140506.123703 pending
 336 .RS 0
 337
 338 Status 'pending' means that submission is pending for the target project. In colorized mode pending submissions are colorized and 'pending' status is not shown.
 339
 340
 341 .RE
 342
 343 .\"
 344 .\" The "diff" command's options
 345 .\"
 346 .RS 2
 347 \fBOPTIONS\fR
 348 .RS 2
 349 .B \-h, \-\-help
 350 .RS 2
 351 Print short help text about the "diff" command and exit.
 352 .RE
 353
 354
 355 .SH CONFIGURATION FILE
 356
 357 .RS 2
 358 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.
 359 .RE
 360
 361 .RS 2
 362 Example:
 363 .RE
 364
 365 .RS 2
 366 [general]
 367 .RE
 368 .RS 2
 369 apiurl = https://api.tizen.org
 370 .RE
 371 .RS 2
 372 apiuser = your_user_name
 373 .RE
 374 .RS 2
 375 apipasswd = your_password
 376 .RE
 377 .RS 2
 378 processes = 20
 379 .RE
 380 .RS 2
 381 project = Tizen:IVI
 382 .RE
 383 .RS 2
 384 color = off
 385 .RE
 386 .RS 2
 387 showurls = off
 388 .RE
 389 .RS 2
 390 ignore = arm-.*/armv7./.*_aggregate$
 391 .RE
 392
 393
 394 .RS 2
 395 Mandatory options: apiurl, apiuser, apipasswd and project
 396 .RE
 397
 398 .RS 2
 399 Some options (project, processes, colorize, showurls, ignore) can be overridden by commandline options (--project, --processes, --colorize, --showurls, --ignore)
 400 .RE
 401
 402 .SH BUGS
 403 Please, report bugs to Ed Bartosh <eduard.bartosh@intel.com>.
 404
 405 .SH COPYRIGHT
 406
 407 Copyright (C) Intel Corporation 2013
 408
 409 .SH LICENCE
 410   This program is free software; you can redistribute it and/or modify
 411   it under the terms of the GNU General Public License, version 2,
 412   as published by the Free Software Foundation.
 413   .
 414   This program is distributed in the hope that it will be useful, but
 415   WITHOUT ANY WARRANTY; without even the implied warranty of
 416   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 417   General Public License for more details.
 418
 419 .SH AUTHORS
 420
 421 Repa is developed and maintained by Ed Bartosh <eduard.bartosh@intel.com>.
 422