path: root/repa.1

.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. \fBshow\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
.RS 2
7. \fBdiff\fR - show the difference between projects
.RE
.RS 2
8. \fBrebuild\fR - rebuild submission
.RE
.RS 2
9. \fBlock\fR - lock submission
.RE
.RS 2
10. \fBunlock\fR - unlock submission
.RE
.RS 2
11. \fBremove\fR - remove submission
.RE
.RS 2
12. \fBupdate\fR - update submission
.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

.PP
.B \-c, \-\-colorize
.RS 2
Turn on colorized output
.RE

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

.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 01:20:14         connman
.RS 0
submit/tizen/20140328.080409          ready 00:14:30         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 \-\-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
.B \-\-showurls
.RS 2
Show OBS and download urls in the output. It's switched off by default.
Note, that this parameter can also be specified in \fIrepa\fR configuration file.
.RE

.PP
.B \-\-ignore <regexp>
.RS 2
Ignore packaging failures for specified regexp. <regexp> is a slash-separated string <repository>/<architecture>/<package>, for example arm.*/armv7./.*_aggregate.
Note, that this parameter can also be specified in \fIrepa\fR configuration file.
.RE

.PP
.B \-\-base <project>
.RS 2
Show status of the submission in the base project.
Note, that this parameter can also be specified in \fIrepa\fR configuration file.
.RE

.PP
.B \-\-showtime
.RS 2
Show submission build time for the submissions in 'ready' status. It's switched off by default.
Note, that this parameter can also be specified in \fIrepa\fR configuration file.
.RE


.PP
.\"
.\" The "show" command description
.\"
.SS \fBshow\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 "show" command's options
.\"
.RS 2
\fBOPTIONS\fR
.RS 2
\-h, \-\-help
.RS 2
Print short help text about the "show" command and exit.
.RE

.\"
.\" The "accept" command description
.\"
.SS \fBaccept\fR [options] <submission or group>

.RS 2
Accept submission or submission group. Acceptance is done by creating
Submit Request in OBS for submission or group and immediately accepting it.

.\"
.\" 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 for created SR.
.RE

.PP
\-j \-\-jenkins
.RS 2
Trigger Jenkins job to accept submission.
.RE

.PP
\-e \-\-edit
.RS 2
Run editor to edit comment. Editor is taken from EDITOR environment variable.
.RE

.\"
.\" The "reject" command description
.\"
.SS \fBreject\fR [options] <submission or group>

.RS 2
Reject submission or submission group. Rejection is done by creating
Submit Request in OBS for submission or group and immediately rejecting it.

.\"
.\" 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 for created SR.
.RE

.PP
\-j \-\-jenkins
.RS 2
Trigger Jenkins job to reject submission.
.RE

.PP
\-e \-\-edit
.RS 2
Run editor to edit comment. Editor is taken from EDITOR environment variable.
.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
\--noaggregate <regexp>
.RS 2
Do not aggregate binary packages matching regexp. This is useful to skip aggregates, propagated by OBS from target project to prerlease projects, e.g. qemu-accel-*, mic-bootstrap, etc.
.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

.PP
.\"
.\" The "diff" command description
.\"
.SS \fBdiff\fR [\-\-help] <project to compare> <manifest to compare> <manifest of target project>

.RS 2
Show the difference between manifest of target project and manifest of <project to compare> in the following format:

<Git path>  <Revision in project to compare> <Revision in the target OBS Project>  <Tag, accepted into project to compare>
.RS 0

Example of output:

$ repa -p Tizen:IVI diff Tizen:Common ivi_0140508.2_ia32.xml common_20140507.5_ia32.xml

platform/core/appfw/aul-1                          3644ad5459  e4f2b22012  submit/tizen/20140502.084937
.RS 0
platform/core/appfw/shortcut                       502c7807b3  27bbf892e0  submit/tizen/20140430.020549
.RS 0
platform/core/connectivity/nfc-manager-neard       ea952dc454  88793ab1ff  None
.RS 0
platform/core/connectivity/smartcard-service       e45ae0bdfb  7d5da70551  submit/tizen/20140506.101200
.RS 0
platform/core/messaging/msg-service                c988cc8b55  a9eed6a734  submit/tizen/20140502.105814
.RS 0
platform/core/system/tlm                           3ddbc6bc14  None        submit/tizen/20140430.130050
.RS 0
platform/framework/web/crosswalk                   42dcc1327b  4280e52757  submit/tizen/20140506.123703
.RS 0

Status 'pending' means that submission is pending for the target project. In colorized mode pending submissions are colorized and 'pending' status is not shown.


.RE

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


.\"
.\" The "rebuild" command description
.\"
.SS \fBrebuild\fR [options] <submision>

.RS 2
Rebuild submission by triggering 're' Jenkins job. 're' job triggering rebuild by re-exports packages in submission. By default it re-exports all packages. It's also possible to re-export only one package using --package command line option.

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

.PP
.B \-c \-\-comment COMMENT
.RS 2
Provide a comment with the explanation of a reason for rebuild. Mandatory option.
.RE

.PP
.B \-p \-\-package <package name>
.RS 2
Rebuild only one package.
.RE

.PP
\-e \-\-edit
.RS 2
Run editor to edit comment. Editor is taken from EDITOR environment variable.
.RE

.\"
.\" The "lock" command description
.\"
.SS \fBlock\fR [options] <submision>

.RS 2
Lock submission by triggering 're' Jenkins job. 're' job locks submission by disabling build in prerelease OBS project.

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

.PP
.B \-c \-\-comment COMMENT
.RS 2
Provide a comment with the explanation of a reason for lock. Mandatory option.
.RE

.PP
\-e \-\-edit
.RS 2
Run editor to edit comment. Editor is taken from EDITOR environment variable.
.RE

.\"
.\" The "unlock" command description
.\"
.SS \fBunlock\fR [options] <submision>

.RS 2
Unlock submission by triggering 're' Jenkins job. 're' job unlocks submission by re-enabling build in prerelease OBS project.

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

.PP
.B \-c \-\-comment COMMENT
.RS 2
Provide a comment with the explanation of a reason for unlock.
.RE

.PP
\-e \-\-edit
.RS 2
Run editor to edit comment. Editor is taken from EDITOR environment variable.
.RE

.\"
.\" The "remove" command description
.\"
.SS \fBremove\fR [options] <submision>

.RS 2
Remove submission by triggering 're' Jenkins job. 're' job remove prerelease OBS project.

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

.PP
.B \-c \-\-comment COMMENT
.RS 2
Provide a comment with the explanation of a reason for remove. This is mandatory option.
.RE

.PP
\-e \-\-edit
.RS 2
Run editor to edit comment. Editor is taken from EDITOR environment variable.
.RE

.\"
.\" The "update" command description
.\"
.SS \fBupdate\fR <submission> [options]

.RS 2
Update submission

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

.PP
.B \-r \-\-refprj COMMENT
.RS 2
Provide a update with the reference project. This is mandatory option.
.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://build.tizen.org
.RE
.RS 2
apiuser = your_user_name
.RE
.RS 2
apipasswd = your_password
.RE
.RS 2
jenkins_url = https://robot.tizen.org
.RE
.RS 2
jenkins_user = your_jenkins_user_name
.RE
.RS 2
jenkins_passwd = your_jenkins_password
.RE
.RS 2
processes = 20
.RE
.RS 2
project = Tizen:IVI
.RE
.RS 2
base = Tizen:Common
.RE
.RS 2
color = off
.RE
.RS 2
showurls = off
.RE
.RS 2
ignore = arm-.*/armv7./.*_aggregate$
.RE
.RS 2
noaggregate = mic-bootstrap-x86-arm.rpm|mic-bootstrap.rpm|mic-bootstrap-debugsource.rpm|qemu-accel-armv7l.rpm|qemu-accel-armv7l-cross-arm.rpm|qemu-linux-user-cross-arm.rpm
.RE
.RS 2
showtime = off
.RE
.RS 2
accept_comment = default comment
 for accept
 command
.RE
.RS 2
reject_comment = default comment
 for reject
 command
.RE
.RS 2
rebuild_comment = default comment
 for rebuild
 command
.RE
.RS 2
lock_comment = default comment
 for lock
 command
.RE
.RS 2
unlock_comment = default comment
 for unlock
 command
.RE
.RS 2
remove_comment = default comment
 for remove
 command
.RE

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

.RS 2
Some options (project, processes, colorize, showurls, ignore, noaggregate, base, showtime) can be overridden by commandline options (--project, --processes, --colorize, --showurls, --ignore, --noaggregate, --base, --showtime)
.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>.