← Back to branch summary

~ubuntu-branches/ubuntu/maverick/ubuntu-dev-tools/maverick-proposed

« back to all changes in this revision

Viewing changes to doc/requestsync.1

  • Committer: Bazaar Package Importer
  • Author(s): Luca Falavigna
  • Date: 2009-11-28 18:48:35 UTC
  • mfrom: (18.1.66 lucid)
  • Revision ID: james.westby@ubuntu.com-20091128184835-0ot21cscixychr6b
Tags: 0.83debian1
* Merge from Ubuntu Lucid, local Debian changes:
  - Adjust Maintainer and Uploaders.
  - Depend on python-lazr.restfulclient.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/requestsync.1
1
 
.TH REQUESTSYNC "1" "6 August 2007" "devscripts"
 
1
.TH REQUESTSYNC "1" "19 January 2008" "ubuntu-dev-tools"
2
2
.SH NAME
3
3
requestsync \- helper to file sync requests for Ubuntu
4
4
.SH SYNOPSIS
5
 
.B requestsync
6
 
.RI [\fI \-n | \-s \fR] " " <\fIsource\fR " " \fIpackage\fR> " " <\fItarget\fR " " \fIrelease\fR> " "[\fIbase\fR " " \fIversion\fR]
 
5
.B requestsync\fR [\fB\-d distro\fR] [\fB\-nse\fR] [\fB\-k \fIkeyid\fR] <\fBsource package\fR> [\fBtarget release\fR] [\fIbase version\fR]
 
6
.br
 
7
.B requestsync \-\-lp\fR [\fB\-nse\fR] <\fBsource package\fR> <\fBtarget release\fR> [\fIbase version\fR]
 
8
.br
 
9
.B requestsync \-h
7
10
.SH DESCRIPTION
8
 
.PP 
9
 
\fBrequestsync\fR looks at the versions of <source package> in Debian and Ubuntu, prompts for an explanation of why the Ubuntu changes (if there are any) should be dropped, downloads the changelog entry from packages.debian.org, and then prompts for your GPG passphrase so it can sign the mail and send it off, which files a sync request in the form of a bug report in Launchpad.
 
11
\fBrequestsync\fR looks at the versions of <source package> in Debian and
 
12
Ubuntu and prompts for an explanation of why the Ubuntu changes (if there
 
13
are any) should be dropped.
 
14
The changelog entry is then downloaded from packages.debian.org.
 
15
If the sync request is being filed per email (default), a prompt for your
 
16
GPG passphrase follows so that it can sign the mail and send it off to
 
17
Launchpad.
 
18
Alternatively a sync request can be filed directly using the launchpadlib
 
19
Python module (option \fB\-\-lp\fR).
 
20
\fBrequestsync\fR falls back to mail the sync request if submitting using
 
21
the launchpadlib module fails.
 
22
 
 
23
.PP
 
24
\fBrequestsync\fR checks if you have the permissions to request the sync from
 
25
the archive administrators directly by checking if you are a member of the
 
26
\fI~ubuntu\-dev\fR team (for universe/multiverse syncs) or a member of the
 
27
\fI~ubuntu\-core\-dev\fR team (for main/restricted syncs) on Launchpad.
 
28
If you are not a member of the appropriate team, the script will subscribe
 
29
the necessary team with approval rights to the bug report for you.
 
30
 
 
31
.PP
 
32
\fBrequestsync\fR uses launchpadlib authentication to file its requests. Please
 
33
see manage-credentials(1) for more information.
 
34
 
10
35
.SH OPTIONS
11
 
.PP
12
36
Listed below are the command line options for requestsync:
13
37
.TP
14
 
\fB\-n\fR
15
 
Specifies that the package is a new package, and requestsync should not attempt to look it up in Ubuntu since it will not exist.
16
 
.TP
17
 
\fB\-s\fR
 
38
.B \-h
 
39
Display a help message and exit.
 
40
.TP
 
41
.B \-d
 
42
Specifies which Debian distribution a package should be synced from.
 
43
Default is \fItesting\fR.
 
44
.TP
 
45
.B \-n
 
46
Specifies that the package is a new package, and requestsync should not
 
47
attempt to look it up in Ubuntu since it will not exist.
 
48
.TP
 
49
.B \-k \fI<keyid>\fR
 
50
Specifies your GPG key.
 
51
Can also be set with the line `\fIexport GPGKEY=<keyid>\fR' in your shell's
 
52
configuration (for example: \fI$HOME/.bashrc\fR).
 
53
This is only used if the sync request is mailed to Launchpad.
 
54
.TP
 
55
.B \-\-lp
 
56
Use the launchpadlib Python module (packaged as python\-launchpadlib) to
 
57
file the sync request in Launchpad.
 
58
.TP
 
59
.B \-s
18
60
Specifies that you require sponsorship.
19
 
You need this option if you are not a member of ubuntu-dev for universe or multiverse, or ubuntu-core-dev for main or restricted.
20
 
.TP
21
 
\fB<source package>\fR
 
61
You need this option if you are not a member of ubuntu-dev for universe or
 
62
multiverse, or ubuntu-core-dev for main or restricted. This shall disable the
 
63
Launchpad team membership checking described above. 
 
64
.TP
 
65
.B \-e
 
66
Use this flag after FeatureFreeze for non-bug fix syncs. \fBrequestsync\fR will
 
67
subscribe ubuntu-release team (for main/restricted packages) or motu-release
 
68
team (for universe/multiverse packages) instead of sponsorship team.
 
69
.TP
 
70
.B <source package>
22
71
This is the source package that you would like to be synced from Debian.
23
72
.TP
24
 
\fB<target release>\fR
25
 
This is the release that you would like the source package to be synced into.
26
 
This should always be the latest development release of Ubuntu, ie: gutsy.
 
73
.B <target release>
 
74
This is the release that you would like the source package to be synced
 
75
into.
 
76
This should always be the latest development release of Ubuntu.
27
77
.TP
28
 
\fB[base version]\fR
29
 
In some cases, the base version (where the Ubuntu package started differing from the Debian package) can not be automatically determined.
 
78
.B [base version]
 
79
In some cases, the base version (where the Ubuntu package started differing
 
80
from the Debian package) cannot be automatically determined.
30
81
Specify this option in this case.
 
82
 
 
83
.SH ENVIRONMENT VARIABLES
 
84
\fBrequestsync\fR uses the following variables which should be set in your
 
85
shell's configuration by adding \fIexport VARIABLE=\fR lines, where VARIABLE is
 
86
one of the following:
 
87
 
 
88
.TP
 
89
.B GPGKEY
 
90
Specifies your GnuPG key ID.
 
91
.TP
 
92
.B DEBEMAIL
 
93
Specifies which email should be used when sending to Launchpad.
 
94
.TP
 
95
.B DEBSMTP
 
96
Set which SMTP server to use when sending mail.
 
97
If unspecified this defaults to fiordland.ubuntu.com.
 
98
.TP
 
99
.B DEBSMTP_PORT
 
100
Sets which port of the SMTP server to use. Default is 25.
 
101
.TP
 
102
.B DEBSMTP_USER and DEBSMTP_PASS
 
103
Sets the username and password to use when authenticating to the SMTP server.
 
104
 
 
105
.SH SEE ALSO 
 
106
.BR rmadison (1)
 
107
 
31
108
.SH AUTHOR
 
109
.B requestsync
 
110
and this manual page were written by the Ubuntu MOTU Team.
32
111
.PP
33
 
This manual page was pieced together by Steve Kowalik.
34
 
.SH SEE ALSO 
35
 
.PP 
36
 
\fBrmadison\fP\fB(1)\fP
37
 
.UE
 
112
Both are released under the GNU General Public License, version 2.