+=encoding utf8
+
=for comment
Consistent formatting of this file is achieved with:
perl ./Porting/podtidy pod/perlrepository.pod
If you cloned using the git protocol, which is faster than ssh, then
you will need to modify the URL for the origin remote to enable
-pushing. To do that edit F<.git/config> with git-config(1) like
-this:
+pushing. To do that edit F<.git/config> with git-config(1) like this:
% git config remote.origin.url ssh://perl5.git.perl.org/perl.git
is also what you see as a template if you do not provide a message to
C<git commit>.
-Assuming that you'd like to commit all the changes you've just made as a
-a single atomic unit, run this command:
+Assuming that you'd like to commit all the changes you've just made as
+a a single atomic unit, run this command:
% git commit -a
(That C<-a> tells git to add every file you've changed to this commit.
-New files aren't automatically added to your commit when you use C<commit
--a> If you want to add files or to commit some, but not all of your
-changes, have a look at the documentation for C<git add>.)
+New files aren't automatically added to your commit when you use
+C<commit -a> If you want to add files or to commit some, but not all of
+your changes, have a look at the documentation for C<git add>.)
Git will start up your favorite text editor, so that you can craft a
commit message for your change. See L</Commit message> below for more
information about what makes a good commit message.
-Once you've finished writing your commit message and exited your editor,
-git will write your change to disk and tell you something like this:
+Once you've finished writing your commit message and exited your
+editor, git will write your change to disk and tell you something like
+this:
Created commit daf8e63: explain git status and stuff about remotes
1 files changed, 83 insertions(+), 3 deletions(-)
Creating a topic branch makes it easier for the maintainers to rebase
or merge back into the master blead for a more linear history. If you
-don't work on a topic branch the maintainer has to manually cherry
-pick your changes onto blead before they can be applied.
+don't work on a topic branch the maintainer has to manually cherry pick
+your changes onto blead before they can be applied.
-That'll get you scolded on perl5-porters, so don't do that. Be
-Awesome.
+That'll get you scolded on perl5-porters, so don't do that. Be Awesome.
Then make your changes. For example, if Leon Brocard changes his name
to Orange Brocard, we should change his name in the AUTHORS file:
Lesley Binks <lesley.binks@gmail.com>
Lincoln D. Stein <lstein@cshl.org>
+For changes significant enough to warrant a F<pod/perldelta.pod> entry, the
+porters would greatly appreciate it if you submit an entry along with your
+actual change. Significant changes include, but are not limited to:
+
+=over 4
+
+=item *
+
+adding, deprecating, or removing core features
+
+=item *
+
+adding, deprecating, removing, or upgrading core or dual-life modules
+
+=item *
+
+adding new core tests
+
+=item *
+
+fixing security issues and user-visible bugs in the core
+
+=item *
+
+changes that might break existing code, either on the perl or C level
+
+=item *
+
+significant performance improvements
+
+=item *
+
+adding, removing, or significantly changing documentation in the F<pod/>
+directory
+
+=item *
+
+important platform-specific changes
+
+=back
+
+Please make sure you add the perldelta entry to the right section within
+F<pod/perldelta.pod>. More information on how to write good perldelta entries is
+available in the C<Style> section of F<Porting/how_to_write_a_perldelta.pod>.
+
Now commit your change locally:
% git commit -a -m 'Rename Leon Brocard to Orange Brocard'
Created commit 6196c1d: Rename Leon Brocard to Orange Brocard
1 files changed, 1 insertions(+), 1 deletions(-)
+The C<-a> option is used to include all files that git tracks that you have
+changed. If at this time, you only want to commit some of the files you have
+worked on, you can omit the C<-a> and use the command C<S<git add I<FILE ...>>>
+before doing the commit. C<S<git add --interactive>> allows you to even just
+commit portions of files instead of all the changes in them.
+
+The C<-m> option is used to specify the commit message. If you omit it, git
+will open a text editor for you to compose the message interactively. This
+is useful when the changes are more complex than the sample given here, and,
+depending on the editor, to know that the first line of the commit message
+doesn't exceed the 50 character legal maximum.
+
You can examine your last commit with:
% git show HEAD
% git format-patch -M origin..
0001-Rename-Leon-Brocard-to-Orange-Brocard.patch
-You should now send an email to either perlbug@perl.org or
-perl5-porters@perl.org with a description of your changes, and include
-this patch file as an attachment. The perlbug address is preferred,
-but use perl5-porters for patches intended for discussion.
+You should now send an email to to
+L<perlbug@perl.org|mailto:perlbug@perl.org> with a description of your
+changes, and include this patch file as an attachment. In addition to
+being tracked by RT, mail to perlbug will automatically be forwarded to
+perl5-porters. You should only send patches to
+L<perl5-porters@perl.org|mailto:perl5-porters@perl.org> directly if the
+patch is not ready to be applied, but intended for discussion.
See the next section for how to configure and use git to send these
emails for you.
patching them, because git won't see the changes to them, and the build
process will overwrite them. Patch the originals instead. Most
utilities (like perldoc) are in this category, i.e. patch
-F<utils/perldoc.PL> rather than F<utils/perldoc>. Similarly, don't create
-patches for files under $src_root/ext from their copies found in
+F<utils/perldoc.PL> rather than F<utils/perldoc>. Similarly, don't
+create patches for files under $src_root/ext from their copies found in
$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<MANIFEST>.
-As a special case, several files are regenerated by 'make regen' if
-your patch alters C<embed.fnc>. 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?
=head2 Getting your patch accepted
-If you are submitting a code patch there are several things that
-you need to do.
+If you are submitting a code patch there are several things that you
+need to do.
=over 4
important to write a good commit message.
The first line of the commit message should be a short description and
-should skip the full stop. It should be no longer than the subject
-line of an E-Mail, 50 characters being a good rule of thumb.
+should skip the full stop. It should be no longer than the subject line
+of an E-Mail, 50 characters being a good rule of thumb.
A lot of Git tools (Gitweb, GitHub, git log --pretty=oneline, ..) will
only display the first line (cut off at 50 characters) when presenting
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
-matters to Perl.
+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 matters to Perl.
=over 4
=item Testsuite
-If your patch changes code (rather than just changing documentation) you
-should also include one or more test cases which illustrate the bug you're
-fixing or validate the new functionality you're adding. In general,
-you should update an existing test file rather than create a new one.
+If your patch changes code (rather than just changing documentation)
+you should also include one or more test cases which illustrate the bug
+you're fixing or validate the new functionality you're adding. In
+general, you should update an existing test file rather than create a
+new one.
Your testsuite additions should generally follow these guidelines
(courtesy of Gurusamy Sarathy <gsar@activestate.com>):
the history, which commit should be blamed for introducing a given bug.
Suppose that we have a script F<~/testcase.pl> that exits with C<0>
-when some behaviour is correct, and with C<1> when it's faulty. You need
-an helper script that automates building C<perl> and running the
+when some behaviour is correct, and with C<1> when it's faulty. You
+
need an helper script that automates building C<perl> and running the
testcase:
% cat ~/run
# If you get './makedepend: 1: Syntax error: Unterminated quoted
# string' when bisecting versions of perl older than 5.9.5 this hack
# will work around the bug in makedepend.SH which was fixed in
- # version 96a8704c. Make sure to comment out `git co makedepend.SH'
+ # version 96a8704c. Make sure to comment out `git checkout makedepend.SH'
# below too.
git show blead:makedepend.SH > makedepend.SH
./perl -Ilib ~/testcase.pl
ret=$?
[ $ret -gt 127 ] && ret=127
- # git co makedepend.SH
+ # git checkout makedepend.SH
git clean -dxf
exit $ret
=head1 Committing to maintenance versions
-Maintenance versions should only be altered to add critical bug
-
fixes, see L<perlpolicy>.
+Maintenance versions should only be altered to add critical bug fixes,
+see L<perlpolicy>.
To commit to a maintenance version of perl, you need to create a local
tracking branch:
https://perl5.git.perl.org / perl5.git / blobdiff