edit-patch: Add manpage. (LP: #538379)

This commit is contained in:
Andrew Starr-Bochicchio 2010-06-25 17:22:31 -04:00
parent 62761f2afd
commit b813c3ea45
2 changed files with 24 additions and 1 deletions

3
debian/changelog vendored
View File

@ -2,8 +2,9 @@ ubuntu-dev-tools (0.101) UNRELEASED; urgency=low
* syncpackage: Update manpage to reflect current usage. (LP: #598477)
* ubuntu-build: Update manpage to reflect current usage. (LP: #490535)
* edit-patch: Add manpage. (LP: #538379)
-- Andrew Starr-Bochicchio <a.starr.b@gmail.com> Fri, 25 Jun 2010 16:11:00 -0400
-- Andrew Starr-Bochicchio <a.starr.b@gmail.com> Fri, 25 Jun 2010 17:13:50 -0400
ubuntu-dev-tools (0.100) maverick; urgency=low

22
doc/edit-patch.1 Normal file
View File

@ -0,0 +1,22 @@
.TH EDIT-PATCH "1" "June 2010" "ubuntu-dev-tools"
.SH NAME
\fBedit-patch\fR \- tool for preparing patches for Debian source packages
.SH SYNOPSIS
\fBedit-patch\fR <path to patch>
.SH DESCRIPTION
\fBedit-patch\fR is a wrapper script around the quilt, cdbs, and dpatch patch systems. It simplifies the process of preparing 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 will copy the patch to /debian/patches 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 "exit" or hitting Ctrl-d will close the subshell and launch an an editor to record the debian/changelong entry.
\fBedit-patch\fR is integrated with the bzr and git version control systems. The patch will be automatically added to the tree, and the debian/changelong 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 debian/patches-applied.
.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.