summaryrefslogtreecommitdiffstats
path: root/doc/edit-patch.1
blob: 70b0ac9a8488ec00070a14db32b7e1144bcc3a68 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
.TH EDIT-PATCH "1" "Debian Utilities" "DEBIAN"
.SH NAME
\fBedit-patch\fR, \fBadd-patch\fR \- tool for preparing patches for Debian
source packages

.SH SYNOPSIS
\fBedit-patch\fR \fIpath/to/patch\fR

\fBadd-patch\fR \fIpath/to/patch\fR

.SH DESCRIPTION
\fBedit-patch\fR is a wrapper script around the Quilt, CDBS, and dpatch patch
systems. It simplifies the process of preparing and editing patches to Debian
source packages and allows the user to not have to be concerned with which patch
system is in use.
Run from inside the root directory of the source package, \fBedit-patch\fR can
be used to edit existing patches located in \fIdebian/patches\fR.

It can also be used to incorporate new patches.
If pointed at a patch not already present, it will copy the patch to
\fIdebian/patches\fR in the correct format for the patch system in use.
Next, the patch is applied and a subshell is opened in order to edit the patch.
Typing \fBexit\fR or pressing Ctrl-d will close the subshell and launch an editor
to record the \fIdebian/changelog\fR entry.

\fBedit-patch\fR is integrated with the Bazaar and Git version control systems.
The patch will be automatically added to the tree, and the \fIdebian/changelog\fR
entry will be used as the commit message.

If no patch system is present, the patch is applied inline,
and a copy is stored in \fIdebian/patches-applied\fR.

\fBadd-patch\fR is the non-interactive version of \fBedit-patch\fR.
The patch will be incorporated but no editor or subshell will be
spawned.

.SH AUTHORS
\fBedit-patch\fR was written by Daniel Holbach <daniel.holbach@canonical.com>,
Michael Vogt <michael.vogt@canonical.com>, and David Futcher <bobbo@ubuntu.com>.

This manual page was written by Andrew Starr-Bochicchio <a.starr.b@gmail.com>.
.PP
Both are released under the terms of the GNU General Public License, version 3.