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
  47 .\" ===========================================================================
  48 .\" Global options
  49 .\" ===========================================================================
  50 .SH GLOBAL OPTIONS
  51
  52 .RE
  53 .B \-\-version
  54 .RS 2
  55 Print \fIrepa\fR version and exit.
  56 .RE
  57
  58 .PP
  59 .B \-h, \-\-help
  60 .RS 2
  61 Print short help text and exit.
  62 .RE
  63
  64 .PP
  65 .B \-s, \-\-section SECTION
  66 .RS 2
  67 Config section to use
  68 .RE
  69
  70 .PP
  71 .B \-p, \-\-project PROJECT
  72 .RS 2
  73 Target OBS project.
  74 .RE
  75
  76 .PP
  77 .B \-c, \-\-colorize
  78 .RS 2
  79 Turn on colorized output
  80 .RE
  81
  82 .\" ===========================================================================
  83 .\" Commands descriptions
  84 .\" ===========================================================================
  85 .SH COMMANDS
  86 .PP
  87 .\"
  88 .\" The "list" command description
  89 .\"
  90 .SS \fBlist\fR [\-\-help] [\-\-processes <processes>]
  91
  92 .RS 2
  93 List submissions in the following format:
  94
  95 <Submission>  <Target OBS Project>  <status>  <list of git paths>
  96
  97 Example of output:
  98
  99 submit/tizen/20140327.041126          broken source          sdbd
 100 .RS 0
 101 submit/tizen/20140327.052722          package build failed   emulator-yagl
 102 .RS 0
 103 submit/tizen/20140327.055105          package building       libav zlib
 104 .RS 0
 105 submit/tizen/20140327.080733          image building         bluez
 106 .RS 0
 107 submit/tizen/20140328.063916          ready                  connman
 108 .RS 0
 109 submit/tizen/20140328.080409          ready                  sdbd
 110 .RS 0
 111
 112 .RE
 113
 114 .\"
 115 .\" The "list" command's options
 116 .\"
 117 .RS 2
 118 \fBOPTIONS\fR
 119 .RS 2
 120 .B \-h, \-\-help
 121 .RS 2
 122 Print short help text about the "list" command and exit.
 123 .RE
 124
 125 .PP
 126 .B \-\-processes
 127 PROCESSES
 128 .RS 2
 129 Use PROCESSES to specify the amount of python processes to run in parallel. Usage of this option can significantly speed up repa list.
 130 Note, that this parameter can also be specified in \fIrepa\fR configuration file.
 131
 132 .RE
 133
 134 .PP
 135 .\"
 136 .\" The "info" command description
 137 .\"
 138 .SS \fBinfo\fR [\-\-help] \-\-project <project> <submission or group>
 139
 140 .RS 2
 141 Show detailed information about submission
 142
 143     Download Url: url of prerelease directory on download server
 144     OBS Url: url of prerelease OBS project
 145     Images: list of image names and their build statuses
 146     Package build failures: list of failed package builds
 147
 148 .PP
 149
 150 Example of output:
 151
 152 .RS 0
 153 Submission: submit/tizen/20140328.213722
 154 .RS 0
 155 Download Url: http://download.tizen.org/prerelease/tizen/ivi/ivi/tizen_20140328.8/tizen_20140328.8.20140328.213722/
 156 .RS 0
 157 OBS Url: https://build.tizen.org/project/show?project=home:prerelease:Tizen:IVI:submit:tizen:20140328.213722
 158 .RS 0
 159
 160 Images:
 161     ivi-min-mbr-i586                success
 162     ivi-min-efi-i586                success
 163     ivi-mbr-i586-emul               success
 164     ivi-mbr-i586                    success
 165     ivi-efi-i586                    success
 166     ivi-mbr-i586-JJ                 failed
 167
 168 Package build failures:
 169     wifi-direct-manager             failed
 170 .RE
 171
 172 .\"
 173 .\" The "info" command's options
 174 .\"
 175 .RS 2
 176 \fBOPTIONS\fR
 177 .RS 2
 178 \-h, \-\-help
 179 .RS 2
 180 Print short help text about the "info" command and exit.
 181 .RE
 182
 183 .\"
 184 .\" The "accept" command description
 185 .\"
 186 .SS \fBaccept\fR [options] <list of submissions and groups>
 187
 188 .RS 2
 189 Accept submissions and submission groups. Acceptance is done by creating
 190 Submit Requests in OBS for every submission and immediately accepting them.
 191
 192 .\"
 193 .\" The "accept" command's options
 194 .\"
 195 .RS 2
 196 \fBOPTIONS\fR
 197 .RS 2
 198 \-h, \-\-help
 199 .RS 2
 200 Print short help text about the "accept" command and exit.
 201 .RE
 202
 203 .PP
 204 \-comment COMMENT
 205 .RS 2
 206 Add acceptance comment to created SRs.
 207 .RE
 208
 209 .\"
 210 .\" The "reject" command description
 211 .\"
 212 .SS \fBreject\fR [options] <list of submissions and groups>
 213
 214 .RS 2
 215 Reject submissions and submission groups. Rejection is done by creating
 216 Submit Requests in OBS for every submission and immediately rejecting them.
 217
 218 .\"
 219 .\" The "reject" command's options
 220 .\"
 221 .RS 2
 222 \fBOPTIONS\fR
 223 .RS 2
 224 \-h, \-\-help
 225 .RS 2
 226 Print short help text about the "reject" command and exit.
 227 .RE
 228
 229 .PP
 230 \-comment COMMENT
 231 .RS 2
 232 Add rejection comment to created SRs.
 233 .RE
 234
 235 .\"
 236 .\" The "group" command description
 237 .\"
 238 .SS \fBgroup\fR [options] <list of submissions>
 239
 240 .RS 2
 241 Group submissions into submit group. Submit group is a temporary by its nature.
 242 It's created for testing purposes. Internally submit group is an OBS project with
 243 aggregated packages from groupped submissions. It's a way to test, accept or
 244 or reject multiple submissions at once.
 245
 246 Note! No package builds are performed in group projects. The grouping function
 247 aggregates binaries only and is intended only for image testing.
 248
 249 .\"
 250 .\" The "group" command's options
 251 .\"
 252 .RS 2
 253 \fBOPTIONS\fR
 254 .RS 2
 255 \-h, \-\-help
 256 .RS 2
 257 Print short help text about the "group" command and exit.
 258 .RE
 259
 260 .PP
 261 \-comment COMMENT
 262 .RS 2
 263 Add  comment to created submit group. It will be shown by list command.
 264 .RE
 265
 266 .PP
 267 \-f, \-\-force
 268 .RS 2
 269 Force group creation for submissions without binary packages. Useful when grouping failed submissions for rejection.
 270 .RE
 271
 272 .\"
 273 .\" The "rmgroup" command description
 274 .\"
 275 .SS \fBrmgroup\fR [options] <submit group>
 276
 277 .RS 2
 278 Remove submit group.
 279
 280 .\"
 281 .\" The "rmgroup" command's options
 282 .\"
 283 .RS 2
 284 \fBOPTIONS\fR
 285 .RS 2
 286 \-h, \-\-help
 287 .RS 2
 288 Print short help text about the "rmgroup" command and exit.
 289 .RE
 290
 291 .SH CONFIGURATION FILE
 292
 293 .RS 2
 294 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.
 295 .RE
 296
 297 .RS 2
 298 Example:
 299 .RE
 300
 301 .RS 2
 302 [general]
 303 .RE
 304 .RS 2
 305 apiurl = https://api.tizen.org
 306 .RE
 307 .RS 2
 308 apiuser = your_user_name
 309 .RE
 310 .RS 2
 311 apipasswd = your_password
 312 .RE
 313 .RS 2
 314 processes = 20
 315 .RE
 316 .RS 2
 317 project = Tizen:IVI
 318 .RE
 319 .RS 2
 320 color = off
 321 .RE
 322
 323 .RS 2
 324 Mandatory options: apiurl, apiuser, apipasswd and project
 325 .RE
 326
 327 .RS 2
 328 Some options (project, processes, colorize) can be overridden by commandline options (--project, --processes, --colorize)
 329 .RE
 330
 331 .SH BUGS
 332 Please, report bugs to Ed Bartosh <eduard.bartosh@intel.com>.
 333
 334 .SH COPYRIGHT
 335
 336 Copyright (C) Intel Corporation 2013
 337
 338 .SH LICENCE
 339   This program is free software; you can redistribute it and/or modify
 340   it under the terms of the GNU General Public License, version 2,
 341   as published by the Free Software Foundation.
 342   .
 343   This program is distributed in the hope that it will be useful, but
 344   WITHOUT ANY WARRANTY; without even the implied warranty of
 345   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 346   General Public License for more details.
 347
 348 .SH AUTHORS
 349
 350 Repa is developed and maintained by Ed Bartosh <eduard.bartosh@intel.com>.
 351