msm: consistency for equally ranked keys
[platform/upstream/rpm.git] / doc / gendiff.1
1 .TH GENDIFF 1 "Mon Jan 10 2000"
2 .UC 4
3 .SH NAME
4 gendiff \- utility to aid in error-free diff file generation
5 .SH SYNOPSIS
6 \fBgendiff\fR <directory> <diff-extension>
7 .SH DESCRIPTION
8 \fBgendiff\fR is a rather simple script which aids in generating a
9 diff file from a single directory.  It takes a directory name and a
10 "diff-extension" as its only arguments.  The diff extension should be
11 a unique sequence of characters added to the end of all original,
12 unmodified files.  The output of the program is a diff file which may
13 be applied with the \fBpatch\fR program to recreate the changes.
14 .PP
15 The usual sequence of events for creating a diff is to create two
16 identical directories, make changes in one directory, and then use the
17 \fBdiff\fR utility to create a list of differences between the two.
18 Using gendiff eliminates the need for the extra, original and
19 unmodified directory copy.  Instead, only the individual files that
20 are modified need to be saved.
21 .PP
22 Before editing a file, copy the file, appending the extension you have chosen
23 to the filename.  I.e. if you were going to edit somefile.cpp and have chosen
24 the extension "fix", copy it to somefile.cpp.fix before editing it.
25 Then edit the first copy (somefile.cpp).
26 .PP
27 After editing all the files you need to edit in this fashion, enter the
28 directory one level above where your source code resides, and then type
29 .sp
30 .nf
31     $ gendiff somedirectory .fix > mydiff-fix.patch
32 .fi
33 .PP
34 You should redirect the output to a file (as illustrated) unless you want to
35 see the results on stdout.
36
37 .PD
38 .SH "SEE ALSO"
39 .BR diff (1),
40 .BR patch (1)
41
42 .SH AUTHOR
43 .nf
44 Marc Ewing <marc@redhat.com>
45 .fi