.\" -*- 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 "COMMIT-PATCH 1" .TH COMMIT-PATCH 1 2024-02-29 "perl v5.38.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 "recorded", 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 \fBVISUAL\fR environment variable, or if that isn't set the \fBEDITOR\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: \&\fR\f(BIDarcs\fR\fB\fR, \fB\fR\f(BIGit\fR\fB\fR, \fB\fR\f(BIMercurial\fR\fB\fR, \fB\fR\f(BIBazaar\fR\fB\fR, \fB\fR\f(BIMonotone\fR\fB\fR, \fB\fR\f(BISubversion\fR\fB\fR, and \fB\fR\f(BICVS\fR\fB\fR. .SH OPTIONS .IX Header "OPTIONS" \&\fB\-a\fR, \fB\-\-amend\fR \- Amend a previous commit. Currently only \fR\f(BIDarcs\fR\fB\fR and \&\fB\fR\f(BIGit\fR\fB\fR support this option. When used with \fB\fR\f(BIGit\fR\fB\fR it will amend the previous commit. When used with \fB\fR\f(BIDarcs\fR\fB\fR, \fB\fR\f(BIDarcs\fR\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; \fICVS\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 \fICVS\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 .IP \(bu 4 Jim Radford .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright © 2003\-2021 by David Caldwell and Jim Radford. .PP \&\fBcommit-patch\fR is distributed under the GNU General Public License. See the COPYING 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.