Blame doc/gendiff.1

2ff057
.TH GENDIFF 1 "Mon Jan 10 2000"
2ff057
.UC 4
2ff057
.SH NAME
2ff057
gendiff \- utility to aid in error-free diff file generation
2ff057
.SH SYNOPSIS
2ff057
\fBgendiff\fR <directory> <diff-extension>
2ff057
.SH DESCRIPTION
2ff057
\fBgendiff\fR is a rather simple script which aids in generating a
2ff057
diff file from a single directory.  It takes a directory name and a
2ff057
"diff-extension" as its only arguments.  The diff extension should be
2ff057
a unique sequence of characters added to the end of all original,
2ff057
unmodified files.  The output of the program is a diff file which may
2ff057
be applied with the \fBpatch\fR program to recreate the changes.
2ff057
.PP
2ff057
The usual sequence of events for creating a diff is to create two
2ff057
identical directories, make changes in one directory, and then use the
2ff057
\fBdiff\fR utility to create a list of differences between the two.
2ff057
Using gendiff eliminates the need for the extra, original and
2ff057
unmodified directory copy.  Instead, only the individual files that
2ff057
are modified need to be saved.
2ff057
.PP
2ff057
Before editing a file, copy the file, appending the extension you have chosen
2ff057
to the filename.  I.e. if you were going to edit somefile.cpp and have chosen
2ff057
the extension "fix", copy it to somefile.cpp.fix before editing it.
2ff057
Then edit the first copy (somefile.cpp).
2ff057
.PP
2ff057
After editing all the files you need to edit in this fashion, enter the
2ff057
directory one level above where your source code resides, and then type
2ff057
.sp
2ff057
.nf
2ff057
    $ gendiff somedirectory .fix > mydiff-fix.patch
2ff057
.fi
2ff057
.PP
2ff057
You should redirect the output to a file (as illustrated) unless you want to
2ff057
see the results on stdout.
2ff057
2ff057
.PD
2ff057
.SH "SEE ALSO"
2ff057
.BR diff (1),
2ff057
.BR patch (1)
2ff057
2ff057
.SH AUTHOR
2ff057
.nf
2ff057
Marc Ewing <marc@redhat.com>
2ff057
.fi