From: Jim Cromie Date: Thu, 31 Dec 2009 05:09:03 +0000 (-0500) Subject: advice regarding make regen changes X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=ac1cbfb08dc1370fbe2937f6bdd95a86fa70bce4;p=p5sagit%2Fp5-mst-13.2.git advice regarding make regen changes --- diff --git a/pod/perlrepository.pod b/pod/perlrepository.pod index eb1737c..46fbf66 100644 --- a/pod/perlrepository.pod +++ b/pod/perlrepository.pod @@ -399,6 +399,17 @@ $install_root/lib. If you are unsure about the proper location of a file that may have gotten copied while building the source distribution, consult the C. +As a special case, several files are regenerated by 'make regen' if +your patch alters C. These are needed for compilation, but +are included in the distribution so that you can build perl without +needing another perl to generate the files. You must test with these +regenerated files, but it is preferred that you instead note that +'make regen is needed' in both the email and the commit message, and +submit your patch without them. If you're submitting a series of +patches, it might be best to submit the regenerated changes +immediately after the source-changes that caused them, so as to have +as little effect as possible on the bisectability of your patchset. + =for XXX What should we recommend about binary files now? Do we need anything? @@ -418,7 +429,6 @@ important to write a good commit message. Your commit message should start with a description of the problem that the patch corrects or new functionality that the patch adds. - As a general rule of thumb, your commit message should let a programmer with a reasonable familiarity with the Perl core quickly understand what you were trying to do, how you were trying to do it and why the change @@ -428,7 +438,8 @@ matters to Perl. =item What -Your commit message should describe what part of the Perl core you're changing and what you expect your patch to do. +Your commit message should describe what part of the Perl core you're +changing and what you expect your patch to do. =item Why @@ -448,8 +459,6 @@ month or next year. =back - - =item Comments, Comments, Comments Be sure to adequately comment your code. While commenting every line