3 patch \- simple patch creation and tracking system
35 These scripts are a simple patch submission and tracking system
36 used to propose additions or changes to Plan 9.
37 There is no guarantee that any patch will be accepted, nor
38 that it will be accepted verbatim.
41 (lowercase letters, numbers, dash, dot, and underscore only)
43 .BI /n/sources/patch/ name.
46 creates a new patch consisting of the changes to
47 the listed files from the distribution, reading
48 a description of the patch from standard input:
49 please provide an explanation of what the change is supposed to do,
50 some context, and a rationale for the change.
51 Test data or pointers to same to verify that the fix works are also welcome.
52 When sending a patch, follow these guidelines:
54 Before preparing the patch, run
56 and base your patch on current distribution source code.
58 If this is a bug fix, explain the bug clearly.
59 Don't assume the bug is obvious from the fix.
61 If this is a new feature, explain it clearly.
62 Don't assume it is obvious from the change.
64 Make the new code look as much like the old code as possible:
65 don't make gratuitous changes, and do follow the style of the old code.
68 for the canonical Plan 9 coding style.
70 If your patch changes externally-visible behaviour,
71 update the manual page.
77 will be sent notification messages when the patch is applied, rejected,
79 If rejected, the e-mail will contain a note explaining why and
80 probably listing suggested changes and encouraging you to resubmit.
83 displays information about the named patches,
84 or all currently pending patches if none are specified.
87 shows a patch as diffs between the original
88 source files and the patched source files.
91 applies the patch to the current source tree.
92 It is intended to be run by the Plan 9 developers with
94 as their root file system.
95 If the source has changed since the patch was
98 will report the conflict and not change any files.
99 Before changing any files,
101 makes backup copies of the current source tree's
102 files. The backups are stored in the patch directory.
105 will copy the backups saved by
107 back into the source tree.
108 It will not restore a backup if the file
109 being replaced is not byte-identical to the one
115 which you have modified locally:
118 % patch/create pwd-errors user@host.dom /sys/src/cmd/pwd.c
119 Fix pwd to print errors to fd 2 rather than 1.
124 Then the developers at Bell Labs run
127 patch/diff pwd-errors
130 to inspect the change (possibly viewing
131 .B /n/sources/patch/pwd-errors/pwd.c
132 to see the larger context).
133 To make the change, they run
136 patch/apply pwd-errors
142 % patch/note pwd-errors
143 Pwd should definitely print errors to fd 1 because ...
149 .B /n/sources/pwd-errors/notes
158 .B http://plan9.bell-labs.com/wiki/plan9/How_to_contribute