=================================================================== RCS file: /cvsrepo/anoncvs/cvs/src/usr.bin/patch/patch.1,v retrieving revision 1.8 retrieving revision 1.9 diff -u -r1.8 -r1.9 --- src/usr.bin/patch/patch.1 2003/07/22 20:17:06 1.8 +++ src/usr.bin/patch/patch.1 2003/07/24 04:41:19 1.9 @@ -1,4 +1,4 @@ -.\" $OpenBSD: patch.1,v 1.8 2003/07/22 20:17:06 millert Exp $ -*- nroff -*- +.\" $OpenBSD: patch.1,v 1.9 2003/07/24 04:41:19 jmc Exp $ .\" Copyright 1986, Larry Wall .\" .\" Redistribution and use in source and binary forms, with or without @@ -19,127 +19,99 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.rn '' }` -.de Sh -.br -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp -.if t .sp .5v -.if n .sp -.. -'\" -'\" Set up \*(-- to give an unbreakable dash; -'\" string Tr holds user defined translation string. -'\" Bell System Logo is used as a dummy character. -'\" -'\" Shut up a groff -ww warning. -.if \n(.g .if !dTr .ds Tr -.ie n \{\ -.tr \(*W-\*(Tr -.ds -- \(*W- -.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -.ds L" "" -.ds R" "" -.ds L' ' -.ds R' ' -'br \} -.el \{\ -.ds -- \(em\| -.tr \*(Tr -.ds L" `` -.ds R" '' -.ds L' ` -.ds R' ' -'br\} -.TH PATCH 1 -.SH NAME -patch - apply a diff file to an original -.SH SYNOPSIS -.B patch -[options] [origfile [patchfile]] -.sp -but usually just -.sp -.B patch - or \-\-fuzz -sets the maximum fuzz factor. +skip patches for which a file to patch can't be found (the same as +.Fl f ) ; +skip patches for which the file has the wrong version for the +.Qq Prereq: +line in the patch; +and assume that patches are reversed if they look like they are. +.It Xo +.Fl F Ns Aq Ar number , +.Fl Fl fuzz Aq Ar number +.Xc +Sets the maximum fuzz factor. This switch only applies to context diffs, and causes -.I patch +.Nm to ignore up to that many lines in looking for places to install a hunk. Note that a larger fuzz factor increases the odds of a faulty patch. The default fuzz factor is 2, and it may not be set to more than the number of lines of context in the context diff, ordinarily 3. -.TP 5 -.B \-l or \-\-ignore-whitespace -causes the pattern matching to be done loosely, in case the tabs and +.It Fl l , Fl Fl ignore-whitespace +Causes the pattern matching to be done loosely, in case the tabs and spaces have been munged in your input file. Any sequence of whitespace in the pattern line will match any sequence in the input file. Normal characters must still match exactly. Each line of the context must still match a line in the input file. -.TP 5 -.B \-n or \-\-normal -forces -.I patch +.It Fl n , Fl Fl normal +Forces +.Nm to interpret the patch file as a normal diff. -.TP 5 -.B \-N or \-\-forward -causes -.I patch +.It Fl N , Fl Fl forward +Causes +.Nm to ignore patches that it thinks are reversed or already applied. See also -.B \-R . -.TP 5 -.B \-o or \-\-output -causes the next argument to be interpreted as the output file name. -.TP 5 -.B \-p or \-\-strip -sets the pathname strip count, -which controls how pathnames found in the patch file are treated, in case -you keep your files in a different directory than the person who sent +.Fl R . +.It Fl o , Fl Fl output +Causes the next argument to be interpreted as the output file name. +.It Xo +.Fl p Ns Aq Ar number , +.Fl Fl strip Aq Ar number +.Xc +Sets the pathname strip count, +which controls how pathnames found in the patch file are treated, +in case you keep your files in a different directory than the person who sent out the patch. The strip count specifies how many slashes are to be stripped from the front of the pathname. (Any intervening directory names also go away.) For example, supposing the filename in the patch file was -.sp - /u/howard/src/blurfl/blurfl.c -.sp -setting -.B \-p +.Pa /u/howard/src/blurfl/blurfl.c : +.Pp +Setting +.Fl p or -.B \-p0 -gives the entire pathname unmodified, -.B \-p1 +.Fl p Ns Ar 0 +gives the entire pathname unmodified. +.Pp +.Fl p Ns Ar 1 gives -.sp - u/howard/src/blurfl/blurfl.c -.sp -without the leading slash, -.B \-p4 +.Pp +.D1 Pa u/howard/src/blurfl/blurfl.c +.Pp +without the leading slash. +.Pp +.Fl p Ns Ar 4 gives -.sp - blurfl/blurfl.c -.sp -and not specifying -.B \-p -at all just gives you "blurfl.c", unless all of the directories in the -leading path (u/howard/src/blurfl) exist and that path is relative, +.Pp +.D1 Pa blurfl/blurfl.c +.Pp +Not specifying +.Fl p +at all just gives you +.Pa blurfl.c , +unless all of the directories in the leading path +.Pq Pa u/howard/src/blurfl +exist and that path is relative, in which case you get the entire pathname unmodified. Whatever you end up with is looked for either in the current directory, or the directory specified by the -.B \-d +.Fl d switch. -.TP 5 -.B \-r or \-\-reject-file -causes the next argument to be interpreted as the reject file name. -.TP 5 -.B \-R or \-\-reverse -tells -.I patch +.It Fl r , Fl Fl reject-file +Causes the next argument to be interpreted as the reject file name. +.It Fl R , Fl Fl reverse +Tells +.Nm that this patch was created with the old and new files swapped. (Yes, I'm afraid that does happen occasionally, human nature being what it is.) -.I Patch +.Nm will attempt to swap each hunk around before applying it. Rejects will come out in the swapped format. The -.B \-R +.Fl R switch will not work with ed diff scripts because there is too little information to reconstruct the reverse operation. -.Sp +.Pp If the first hunk of a patch fails, -.I patch +.Nm will reverse the hunk to see if it can be applied that way. If it can, you will be asked if you want to have the -.B \-R +.Fl R switch set. If it can't, the patch will continue to be applied normally. (Note: this method cannot detect a reversed patch if it is a normal diff @@ -383,151 +375,168 @@ Luckily, most patches add or change lines rather than delete them, so most reversed normal diffs will begin with a delete, which will fail, triggering the heuristic.) -.TP 5 -.B \-s or \-\-quiet or \-\-silent -makes -.I patch +.It Xo +.Fl s , Fl Fl quiet , +.Fl Fl silent +.Xc +Makes +.Nm do its work silently, unless an error occurs. -.TP 5 -.B \-u or \-\-unified -forces -.I patch +.It Fl u , Fl Fl unified +Forces +.Nm to interpret the patch file as a unified context diff (a unidiff). -.TP 5 -.B \-v or \-\-version -causes -.I patch +.It Fl v , Fl Fl version +Causes +.Nm to print out its revision header and patch level. -.TP 5 -.B \-V or \-\-version-control -causes the next argument to be interpreted as a method for creating -backup file names. The type of backups made can also be given in the -.B VERSION_CONTROL +.It Fl V , Fl Fl version-control +Causes the next argument to be interpreted as a method for creating +backup file names. +The type of backups made can also be given in the +.Ev VERSION_CONTROL environment variable, which is overridden by this option. The -.B -B +.Fl B option overrides this option, causing the prefix to always be used for making backup file names. The value of the -.B VERSION_CONTROL +.Ev VERSION_CONTROL environment variable and the argument to the -.B -V -option are like the GNU -Emacs `version-control' variable; they also recognize synonyms that -are more descriptive. The valid values are (unique abbreviations are -accepted): -.RS -.TP -`t' or `numbered' +.Fl V +option are like the GNU Emacs +.Dq version-control +variable; they also recognize synonyms that are more descriptive. +The valid values are (unique abbreviations are accepted): +.Bl -tag -width Ds -offset indent +.It t , numbered Always make numbered backups. -.TP -`nil' or `existing' -Make numbered backups of files that already -have them, simple backups of the others. +.It nil , existing +Make numbered backups of files that already have them, +simple backups of the others. This is the default. -.TP -`never' or `simple' +.It never , simple Always make simple backups. -.RE -.TP 5 -.B \-x or \-\-debug -sets internal debugging flags, and is of interest only to -.I patch +.El +.It Xo +.Fl x Ns Aq Ar number , +.Fl Fl debug Aq Ar number +.Xc +Sets internal debugging flags, and is of interest only to +.Nm patchers. -.SH AUTHOR -Larry Wall -.br -with many other contributors. -.SH ENVIRONMENT -.TP -.B TMPDIR -Directory to put temporary files in; default is /tmp. -.TP -.B SIMPLE_BACKUP_SUFFIX -Extension to use for backup file names instead of \*(L".orig\*(R" or -\*(L"~\*(R". -.TP -.B VERSION_CONTROL -Selects when numbered backup files are made. -.SH FILES -$TMPDIR/patch* -.SH SEE ALSO -diff(1) -.SH NOTES FOR PATCH SENDERS +.El +.Sh NOTES FOR PATCH SENDERS There are several things you should bear in mind if you are going to -be sending out patches. -First, you can save people a lot of grief by keeping a patchlevel.h file -which is patched to increment the patch level as the first diff in the +be sending out patches: +.Pp +First, you can save people a lot of grief by keeping a +.Pa patchlevel.h +file which is patched to increment the patch level as the first diff in the patch file you send out. -If you put a Prereq: line in with the patch, it won't let them apply +If you put a +.Qq Prereq: +line in with the patch, it won't let them apply patches out of order without some warning. +.Pp Second, make sure you've specified the filenames right, either in a -context diff header, or with an Index: line. +context diff header, or with an +.Qq Index: +line. If you are patching something in a subdirectory, be sure to tell the patch user to specify a -.B \-p +.Fl p switch as needed. +.Pp Third, you can create a file by sending out a diff that compares a null file to the file you want to create. This will only work if the file you want to create doesn't exist already in the target directory. +.Pp Fourth, take care not to send out reversed patches, since it makes people wonder whether they already applied the patch. +.Pp Fifth, while you may be able to get away with putting 582 diff listings into one file, it is probably wiser to group related patches into separate files in case something goes haywire. -.SH DIAGNOSTICS +.Sh ENVIRONMENT +.Bl -tag -width "SIMPLE_BACKUP_SUFFIX" -compact +.It Ev TMPDIR +Directory to put temporary files in; default is +.Pa /tmp . +.It Ev SIMPLE_BACKUP_SUFFIX +Extension to use for backup file names instead of +.Qq .orig +or +.Qq ~ . +.It Ev VERSION_CONTROL +Selects when numbered backup files are made. +.El +.Sh FILES +.Bl -tag -width Ds +.It Pa $TMPDIR/patch* +.El +.Sh DIAGNOSTICS Too many to list here, but generally indicative that -.I patch +.Nm couldn't parse your patch file. -.PP -The message \*(L"Hmm...\*(R" indicates that there is unprocessed text in -the patch file and that -.I patch +.Pp +The message +.Qq Hmm... +indicates that there is unprocessed text in the patch file and that +.Nm is attempting to intuit whether there is a patch in that text and, if so, what kind of patch it is. -.PP -.I Patch +.Pp +.Nm will exit with a non-zero status if any reject files were created. When applying a set of patches in a loop it behooves you to check this exit status so you don't apply a later patch to a partially patched file. -.SH CAVEATS -.I Patch +.Sh SEE ALSO +.Xr diff 1 +.Sh AUTHORS +.An Larry Wall Aq lwall@netlabs.com +with many other contributors. +.Sh CAVEATS +.Nm cannot tell if the line numbers are off in an ed script, and can only detect -bad line numbers in a normal diff when it finds a \*(L"change\*(R" or -a \*(L"delete\*(R" command. +bad line numbers in a normal diff when it finds a +.Qq change +or a +.Qq delete +command. A context diff using fuzz factor 3 may have the same problem. Until a suitable interactive interface is added, you should probably do a context diff in these cases to see if the changes made sense. Of course, compiling without errors is a pretty good indication that the patch worked, but not always. -.PP -.I Patch +.Pp +.Nm usually produces the correct results, even when it has to do a lot of guessing. However, the results are guaranteed to be correct only when the patch is applied to exactly the same version of the file that the patch was generated from. -.SH BUGS -Could be smarter about partial matches, excessively \&deviant offsets and +.Sh BUGS +Could be smarter about partial matches, excessively deviant offsets and swapped code, but that would take an extra pass. -.PP -Check patch mode ( -.BR -C ) +.Pp +Check patch mode +.Pq Fl C will fail if you try to check several patches in succession that build on -each other. The whole code of -.I patch +each other. +The whole code of +.Nm would have to be restructured to keep temporary files around so that it can handle this situation. -.PP +.Pp If code has been duplicated (for instance with #ifdef OLDCODE ... #else ... #endif), -.I patch +.Nm is incapable of patching both versions, and, if it works at all, will likely patch the wrong one, and tell you that it succeeded to boot. -.PP +.Pp If you apply a patch you've already applied, -.I patch +.Nm will think it is a reversed patch, and offer to un-apply the patch. This could be construed as a feature. -.rn }` ''