Created man page

Fixes: #1489
Change-Id: I857e63ee4e816c72eb14871a5d5dd692b156af7e
Signed-off-by: Ed Bartosh <eduard.bartosh@intel.com>
Reviewed-on: https://otctools.jf.intel.com/review/8383
Tested-by: OTC Tools Tester <ed.bartosh@linux.intel.com>

diff --git a/debian/manpages b/debian/manpages
new file mode 100644 (file)
index 0000000..ca329ea
--- /dev/null
+++ b/debian/manpages
@@ -0,0 +1 @@
+repa.1

diff --git a/packaging/repa.spec b/packaging/repa.spec
index 2c6b78bef38fbd18cf2ee0c26035c84bbc23e5b7..211b0a477137f56897939025b3f445f4b685b8fc 100644 (file)
--- a/packaging/repa.spec
+++ b/packaging/repa.spec
@@ -44,5 +44,6 @@ rm -rf %{buildroot}
 %{python_sitelib}/%{name}-%{version}-*-nspkg.pth
 %{python_sitelib}/%{name}
 %{_bindir}/%{name}
+%{_mandir}/man1/*
 
 %changelog

diff --git a/repa.1 b/repa.1
new file mode 100644 (file)
index 0000000..9778ecc
--- /dev/null
+++ b/repa.1
@@ -0,0 +1,237 @@
+.TH REPA "1" "December 2013" "repa 0.1" "User Commands"
+
+.SH NAME
+
+.PP
+repa - maintain code submissions to Tizen projects
+
+.SH SYNOPSIS
+
+.PP
+.B repa [\-\-help] <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. \fBaccept\fR - accept submissions
+.RE
+.RS 2
+3. \fBreject\fR - reject submissions
+.RE
+.RS 2
+4. \fBgroup\fR - group submissions into submission group
+.RE
+.RS 2
+5. \fBrmgroup\fR - remove submission group
+.RE
+
+.\" ===========================================================================
+.\" Global options
+.\" ===========================================================================
+.SH OPTIONS
+
+.RE
+.B \-\-version
+.RS 2
+Print \fIbmaptool\fR version and exit.
+.RE
+
+.PP
+.B \-h, \-\-help
+.RS 2
+Print short help text and exit.
+.RE
+
+.\" ===========================================================================
+.\" Commands descriptions
+.\" ===========================================================================
+.SH COMMANDS
+.PP
+.\"
+.\" The "list" command description
+.\"
+.SS \fBlist\fR [\-\-help] [\-\-regexp <regexp>]
+
+.RS 2
+List submissions in the following format:
+
+Submission OBS project projects:  list of projects paths
+    builds: list of package build statuses from OBS
+    images: list of image build statuses
+
+.PP
+Example of output:
+
+submit/tizen/20131204.010936 Tizen:Mobile projects: platform/upstream/smack
+    builds: unresolvable,succeeded,published
+    images: mobile-ref:success mobile:success
+
+submit/tizen/20131204.012119 Tizen:Mobile projects: platform/core/bash
+    builds: unresolvable,succeeded,published
+    images: mobile-ref:success mobile:success
+
+submit/tizen/20131204.012224 Tizen:Mobile projects: platform/upstream/git
+    builds: unresolvable,succeeded,published
+    images: mobile-ref:success mobile:success
+
+submitgroup/tizen/20131205.102345
+    submissions: submit/tizen/20131204.010936 submit/tizen/20131204.012119
+    images: mobile-ref:success mobile:success
+
+.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
+
+.\"
+.\" 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.
+
+.\"
+.\" 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
+
+.\"
+.\" 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 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>.
+

diff --git a/setup.py b/setup.py
index 42a99b4b313b7cbbda0a78dcfa6baba59392b0ca..f08c1e8b2838e1f319b76b3e08bb27181dfe0124 100755 (executable)
--- a/setup.py
+++ b/setup.py
@@ -38,6 +38,7 @@ setup(name = "repa",
       namespace_packages = ['repa'],
       data_files = [
           ('share/doc/packages/repa/', ['README']),
+          ('share/man/man1/', ['repa.1']),
           (['/etc', 'etc'][bool(os.getenv('VIRTUAL_ENV'))], ['repa.conf'])],
       entry_points = {
           'console_scripts': ['repa = repa.main:main'],