.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "COMMIT-PATCH 1"
.TH COMMIT-PATCH 1 "2013-05-16" "perl v5.14.2" "User Commands"
.\" 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"
commit\-patch \- commit patches to Darcs, Git, Mercurial, Bazaar, Monotone, Subversion, or CVS repositories
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
commit-patch [\fB\-\-amend\fR] [\fB\-m\fR \fImessage\fR] [\fB\-F\fR \fImessage-file\fR] [\fB\-v\fR] [\fB\-\-dry\-run\fR] [\fIpatch-file\fR]
.PP
commit-partial [\fB\-\-amend\fR] [\fB\-v\fR] [\fB\-\-dry\-run\fR] [\fB\-\-retry\fR] [\fIfile\fR ...]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Normally version control systems don't allow fine grained
commits. \fBcommit-patch\fR allows the user to control \fIexactly\fR what
gets committed (or \*(L"recorded\*(R", in \fIDarcs\fR parlance) by letting the user
supply a patch to be committed rather than using the files in the
current working directory. If \fIpatch-file\fR is not supplied on the
command line then the patch will be read from standard input.
.PP
\&\fBcommit-partial\fR is like commit-patch except that it will create a
patch from the current changes in the current working directory and
launch your editor so that you can edit the patch and the commit
message (using the \fB\s-1VISUAL\s0\fR environment variable, or if that isn't
set the \fB\s-1EDITOR\s0\fR environment variable, or, if \fIthat\fR isn't set,
\&\fBvi\fR. Any files you specify will be passed to your version control's
diff command.
.PP
\&\fBcommit-patch\fR currently supports the following version control systems:
\&\fB\f(BIDarcs\fB\fR, \fB\f(BIGit\fB\fR, \fB\f(BIMercurial\fB\fR, \fB\f(BIBazaar\fB\fR, \fB\f(BIMonotone\fB\fR, \fB\f(BISubversion\fB\fR, and \fB\f(BI\s-1CVS\s0\fB\fR.
.SH "OPTIONS"
.IX Header "OPTIONS"
\&\fB\-a\fR, \fB\-\-amend\fR \- Amend a previous commit. Currently only \fB\f(BIDarcs\fB\fR and
\&\fB\f(BIGit\fB\fR support this option. When used with \fB\f(BIGit\fB\fR it will amend the
previous commit. When used with \fB\f(BIDarcs\fB\fR, \fB\f(BIDarcs\fB\fR will ask you which
patch you want to amend.
.PP
\&\fB\-m\fR, \fB\-\-message\fR=\fImessage\fR \- An optional \fImessage\fR to use as the commit
text. If the message is multiple lines then \fIDarcs\fR, \fIGit\fR, and \fIMercurial\fR
will use the first line as the patch name and the rest as commit
details. If the \f(CW\*(C`\-m\*(C'\fR option is not specified then the result will be
the same as whatever the underlying version control system would do if
you didn't specify a message name on the command line. That is,
\&\fBcommit-patch\fR does not interfere with the patch naming process of
the underlying version control system; \fIDarcs\fR will still ask you
interactively; \fI\s-1CVS\s0\fR and \fISubversion\fR will still launch your editor.
.PP
\&\fB\-F\fR, \fB\-\-message\-file\fR=\fIfilename\fR \- You can optionally get the
commit message from a file. This is generally only useful for
scripting \fBcommit-patch\fR.
.PP
\&\fB\-v\fR, \fB\-\-verbose\fR \- Turn on debugging. This will print the commands
that \fBcommit-patch\fR is running to get the patch committed.
.PP
\&\fB\-n\fR, \fB\-\-dry\-run\fR \- Turn on more paranoid debugging. This will print
the commands that \fBcommit-patch\fR will run to get the patch committed
but it won't actually run those commands.
.PP
\&\fB\-r\fR, \fB\-\-retry\fR \- Only available in \fIcommit-partial\fR. This will reload the
last patch that was attempted to be committed into your editor instead of the
current changes in the directory. This is for cases where the patch fails to
commit for some reason and you want to try to fix it instead of starting over.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
\&\fBcommit-patch\fR works by manipulating the working directory using
\&\f(CW\*(C`patch\*(C'\fR, \f(CW\*(C`interdiff\*(C'\fR, and the underlying version control system's
\&\f(CW\*(C`diff\*(C'\fR.  If any part of the process fails, \fBcommit-patch\fR will
attempt to restore the working directory to the state it was before
the command was run. Any errors from the underlying version control
system or from patch will be printed.
.SH "CAVEATS"
.IX Header "CAVEATS"
The patch specified on the command line must originate from the same
place as the current directory. That is, the following will not work:
.PP
.Vb 3
\&  cvs diff \-u > ../a.patch
\&  cd ..
\&  commit\-patch a.patch
.Ve
.PP
You \fBmust\fR run \fBcommit-patch\fR from the same directory that the
original patch was based from.
.PP
\&\fIDarcs\fR, \fIGit\fR and \fIMercurial\fR put \f(CW\*(C`a/\*(C'\fR and \f(CW\*(C`b/\*(C'\fR in front of all the paths
in the diff output. Don't worry about this; \fBcommit-patch\fR takes it into
account.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
Typical \fI\s-1CVS\s0\fR usage:
.PP
.Vb 3
\&  cvs diff \-u > a.patch
\&  emacs a.patch
\&  commit\-patch a.patch
.Ve
.PP
\&\fIMercurial\fR usage with a message specified:
.PP
.Vb 3
\&  hg diff > a.patch
\&  emacs a.patch
\&  commit\-patch \-m "This is a commit message" a.patch
.Ve
.PP
\&\fIDarcs\fR usage with a multi-line message specified:
.PP
.Vb 4
\&  darcs diff \-u > a.patch
\&  emacs a.patch
\&  commit\-patch \-m \*(AqThis is the patch name
\&  Here are the patch details\*(Aq a.patch
.Ve
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
David Caldwell <david@porkrind.org>
.IP "\(bu" 4
Jim Radford <radford@blackbean.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2003\-2013 by David Caldwell and Jim Radford.
.PP
\&\fBcommit-patch\fR is distributed under the \s-1GNU\s0 General Public
License. See the \s-1COPYING\s0 file in the distribution for more details.
.SH "HISTORY"
.IX Header "HISTORY"
\&\fBcommit-patch\fR was originally called \f(CW\*(C`cvs\-commit\-patch\*(C'\fR and was a
bash script written in 2003 by Jim Radford (with David Caldwell in the
room drawing the procedure on a white board). David later converted it
do \f(CW\*(C`darcs\-commit\-patch\*(C'\fR, then integrated them back together into
\&\fBcommit-patch\fR. \fIMercurial\fR support was then added. At some point
David translated from bash into perl because funky bash quoting issues
were causing problems with a repository that had a space in one of the
directory names.