.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "dpt-forward 1" .TH dpt-forward 1 2024-03-04 "pkg-perl-tools 0.78" "Debian Perl packaging Tools" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME dpt\-forward \- Forward a bug or a patch upstream .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 2 \& dpt forward [option...] path/to/some.patch [bug\-number] \& dpt forward [option...] bug\-number [path/to/some.patch] .Ve .SH OPTIONS .IX Header "OPTIONS" .IP "\fB\-\-dist\fR \fIname\fR" 4 .IX Item "--dist name" .PD 0 .IP "\fB\-d\fR \fIname\fR" 4 .IX Item "-d name" .PD Distribution name. Determined from \fIMETA\fR, the \f(CW\*(C`Name\*(C'\fR field in \&\fIdebian/upstream/metadata\fR, the \f(CW\*(C`Homepage\*(C'\fR field in \&\fIdebian/control\fR file or the \f(CW\*(C`Source\*(C'\fR field in \fIdebian/copyright\fR, in that order. .IP \fB\-\-force\fR 4 .IX Item "--force" Normally \fBdpt-forward\fR checks if the bug/patch is already forwarded upstream and aborts if so. With this option, the check is still done, but execution is not aborted and only a warning is issued. .IP "\fB\-\-meta\fR \fIfile\fR" 4 .IX Item "--meta file" Specifies the location of the \fIMETA\fR file. Defaults to \fIMETA.json\fR or \&\fIMETA.yml\fR in the current directory, whichever is found first. .IP "\fB\-\-mode\fR bug|patch" 4 .IX Item "--mode bug|patch" .PD 0 .IP "\fB\-m\fR bug|patch" 4 .IX Item "-m bug|patch" .PD Mode of operation. Should rarely be needed. .Sp Determines the meaning of the arguments. \fIbug\fR means that the first argument is a bug number, and the second argument is a patch file name. \fIpatch\fR means the opposite. .Sp Determined from the first non-option argument and whether it looks like a bug number or a patch file name. .IP \fB\-\-offline\-test\fR 4 .IX Item "--offline-test" All operations that require network are replaced with stubs, allowing for off-line testing. .IP "\fB\-\-ticket\fR \fInumber\fR" 4 .IX Item "--ticket number" If present, the information is submitted to the ticket as an additional comment. .Sp If missing, a new ticket is created. .IP "\fB\-\-tracker\fR \fIname\fR" 4 .IX Item "--tracker name" .PD 0 .IP "\fB\-t\fR \fIname\fR" 4 .IX Item "-t name" .PD Tracker used by the distribution. \fBdpt forward\fR currently supports \fBcpan\fR () and \fBgithub\fR. The default is determined from the \f(CW\*(C`resources\->bugtracker\->web\*(C'\fR field of \fIMETA\fR. If that field is not present, \&\fBcpan\fR is used. .IP "\fB\-\-tracker\-url\fR \fIurl\fR" 4 .IX Item "--tracker-url url" .PD 0 .IP "\fB\-u\fR \fIurl\fR" 4 .IX Item "-u url" .PD Tracker URL to submit the information to. Taken from the \f(CW\*(C`resources\->bugtracker\->web\*(C'\fR field of \fIMETA\fR or the \f(CW\*(C`Bug\-Database\*(C'\fR field in \fIdebian/upstream/metadata\fR. Defaults to \f(CW\*(C`https://rt.cpan.org/Public/Dist/Display.html?Name=\fR\f(CIdist\-name\fR\f(CW\*(C'\fR for \fBcpan\fR and is mandatory for \fBgithub\fR. .IP \fB\-\-use\-mail\fR 4 .IX Item "--use-mail" Send bug and patch submissions by e\-mail instead of creating an issue or pull request via API. As the resulting ticket URL is not known to \&\fBdpt forward\fR, it cannot mark patch and bug as forwarded. .IP "\fB\-\-mailto\fR \fIaddress\fR" 4 .IX Item "--mailto address" This option sets the e\-mail address to forward to. The default is determined from the \f(CW\*(C`resources\->bugtracker\->mailto\*(C'\fR field of \fIMETA\fR or CPAN RT bug address if that field is not present. .IP \fB\-\-fallback\fR 4 .IX Item "--fallback" Enable fallback to forwarding patches as bug reports when pull requests fail for any reason. Defaults to false. .SH FILES .IX Header "FILES" .IP ~/.pause 4 .IX Item "~/.pause" Your pause credentials. At least \fBuser\fR and \fBpassword\fR are needed in order to create tickets on rt.cpan.org via REST API. \fBdpt forward\fR will fall back to email (slower, won't mark patches and bugs forwarded) otherwise. .SH ENVIRONMENT .IX Header "ENVIRONMENT" .IP DPT_GITHUB_OAUTH 4 .IX Item "DPT_GITHUB_OAUTH" In order to perform github operations, DPT_GITHUB_OAUTH must be set. See \fBdpt\-github\-oauth\fR\|(1) on how to obtain an access token for your github account, and \fBdpt\-config\fR\|(5) on storing settings permanently in dpt.conf. .IP DPT_GITHUB_ORGNAME 4 .IX Item "DPT_GITHUB_ORGNAME" Producing merge requests on github as a result of forwarding a patch requires that you belong to an organization that will own the cloned repositories from upstream. Therefore you'll need that some organization administrator invites you; for instance by using \&\fBdpt\-invite\-github\fR\|(1). .Sp For more details about tuning merge requests through environment variables and their defaults, please see \fBDebian::PkgPerl::GitHub\fR\|(1). .SH "SEE ALSO" .IX Header "SEE ALSO" Forwarding tutorial .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" .IP "Copyright 2016 Alex Muntada." 4 .IX Item "Copyright 2016 Alex Muntada." .PD 0 .IP "Copyright 2014 Salvatore Bonaccorso." 4 .IX Item "Copyright 2014 Salvatore Bonaccorso." .IP "Copyright 2014 Damyan Ivanov." 4 .IX Item "Copyright 2014 Damyan Ivanov." .IP "Copyright 2011 Alessandro Ghedini." 4 .IX Item "Copyright 2011 Alessandro Ghedini." .PD .PP This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License. .PP See http://dev.perl.org/licenses/ for more information.