Update the release manager guide to clean up the tagging instructions
[p5sagit/p5-mst-13.2.git] / Porting / release_managers_guide.pod
index 4b33165..bbdfdf5 100644 (file)
@@ -309,7 +309,7 @@ Update the F<Changes> file to contain the git log command which would show
 all the changes in this release. You will need assume the existence of a
 not-yet created tag for the forthcoming release; e.g.
 
-    git log ... perl-5.10.0..perl5.12.0
+    git log ... perl-5.10.0..perl-5.12.0
 
 Due to warts in the perforce-to-git migration, some branches require extra
 exclusions to avoid other branches being pulled in. Make sure you have the
@@ -405,7 +405,7 @@ within your working directory:
 If any of the files managed by F<regen.pl> have changed, then you should
 re-make perl to check that it's okay, then commit the updated versions:
 
-    $ git commit -a -m 'make regn; make regn_perly'
+    $ git commit -a -m 'make regen; make regen_perly'
 
 =item *
 
@@ -445,9 +445,9 @@ Then change to your perl checkout, and if necessary,
     $ make perl
 
 If this not the first update for this version, first edit
-F<lib/Module/CoreList.pm>to delete the existing entries for this version
-from the C<%released> and C<%version> hashes: they will have a key like
-C<5.010001> for 5.10.1.
+F<ext/Module-CoreList/lib/Module/CoreList.pm> to delete the existing
+entries for this version from the C<%released> and C<%version> hashes:
+they will have a key like C<5.010001> for 5.10.1.
 
 XXX the edit-in-place functionality of Porting/corelist.pl should
 be fixed to handle this automatically.
@@ -462,11 +462,12 @@ Otherwise, run:
 
 This will chug for a while, possibly reporting various warnings about
 badly-indexed CPABN modules unreltaed to the modules actually in core.
-Assuming all goes well, it will update F<lib/Module/CoreList.pm>.
+Assuming all goes well, it will update
+F<ext/Module-CoreList/lib/Module/CoreList.pm>.
 
 Check that file over carefully:
 
-    $ git diff lib/Module/CoreList.pm
+    $ git diff ext/Module-CoreList/lib/Module/CoreList.pm
 
 If necessary, bump C<$VERSION> (there's no need to do this for
 every RC; in RC1, bump the version to a new clean number that will
@@ -493,7 +494,7 @@ Finally, commit the new version of Module::CoreList:
 (unless this is for maint; in which case commit it blead first, then
 cherry-pick it back).
 
-    $ git commit -m 'Update Module::CoreList for 5.x.y' lib/Module/CoreList.pm
+    $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm
 
 =item *
 
@@ -501,6 +502,7 @@ Check that the manifest is sorted and correct:
 
     $ make manisort
     $ make distclean
+    $ git clean -xdf # This shouldn't be necessary if distclean is correct
     $ perl Porting/manicheck
     $ git status
 
@@ -578,12 +580,27 @@ Push all your recent commits:
 
 =item *
 
+I<You MUST SKIP this step for SNAPSHOT>
+
+Tag the release:
+
+    $ git tag v5.11.0 -m'First release of the v5.11 series!'
+
+It is VERY important that from this point forward, you not push
+your git changes to the Perl master repository.  If anything goes
+wrong before you publish your newly-created tag, you can delete
+and recreate it.  Once you push your tag, we're stuck with it
+and you'll need to use a new version number for your release.
+
+=item *
+
 Create a tarball. Use the C<-s> option to specify a suitable suffix for
 the tarball and directory name:
 
     $ cd root/of/perl/tree
     $ make distclean
-    $ git clean -xdf           #  make sure perl and git agree on files
+    $ git clean -xdf           # make sure perl and git agree on files
+    $ git status               # and there's nothing lying around
 
     $ perl Porting/makerel -b -s `git describe` # for a snapshot
     $ perl Porting/makerel -b -s RC1            # for a release candidate
@@ -594,6 +611,7 @@ the MANIFEST files into it, sets the correct permissions on them,
 adds DOS line endings to some, then tars it up as
 F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file.
 
+
 XXX if we go for extra tags and branches stuff, then add the extra details
 here
 
@@ -666,7 +684,7 @@ previous is 5.10.0:
 
 Bootstrap the CPAN client on the clean install:
 
-    $ ./bin/perl -MCPAN -e'shell' 
+    $ bin/perl -MCPAN -e'shell' 
 
 =item *
 
@@ -678,7 +696,7 @@ has dependencies; for example:
 
 Check that your perl can run this:
 
-    $ ./bin/perl -lwe 'use Inline C => "int f() { return 42;} "; print f'
+    $ bin/perl -lwe 'use Inline C => "int f() { return 42;} "; print f'
     42
     $
 
@@ -686,7 +704,7 @@ Check that your perl can run this:
 
 Bootstrap the CPANPLUS client on the clean install:
 
-    $ ./bin/cpanp
+    $ bin/cpanp
 
 =item *
 
@@ -695,7 +713,7 @@ Install an XS module, for example:
     CPAN Terminal> i DBI
     CPAN Terminal> quit
     $ bin/perl -MDBI -e 1
-
+    $
 
 =item *
 
@@ -718,8 +736,8 @@ Check that the C<perlbug> utility works. Try the following:
 
 and carefully examine the output (in F<perlbug.rep]>), especially
 the "Locally applied patches" section. If everything appears okay, then
-try it again, this time actually submitting the bug report. Check that it
-shows up, then remember to close it!
+delete the file, and try it again, this time actually submitting the bug
+report. Check that it shows up, then remember to close it!
 
 =item *
 
@@ -750,13 +768,11 @@ Upload both the .gz and .bz2 versions of the tarball.
 
 I<You MUST SKIP this step for SNAPSHOT>
 
-Create a tag for the exact git revision you built the release from.
-C<commit> below is the commit corresponding to the tarball. It can be
-omitted if there have been no further commits since the tarball was
-created.
 
-    $ git tag perl-5.10.1-RC1 -m'Release Candidate 1 of Perl 5.10.1' <commit>
-    $ git push origin tag perl-5.10.1-RC1
+Now that you've shipped the new perl release to PAUSE, it's
+time to publish the tag you created earlier to the public git repo:
+
+    $ git push origin tag v5.11.0
 
 =item *
 
@@ -805,41 +821,70 @@ http://dev.perl.org/perl5/
 
 I<You MUST SKIP this step for SNAPSHOT, RC>
 
-Create a new empty perlNNNdelta.pod file for the current release + 1;
-see F<Porting/how_to_write_a_perldelta.pod>.
-[ XXX Perhaps we should have an empty template file we can copy in. ]
+Remind the current maintainer of C<Module::CoreList> to push a new release
+to CPAN.
+
+=item *
 
-In addition, edit F<pod.lst>, adding the new entry as 'D', and unmark previous
-entry as 'D',
+I<You MUST SKIP this step for SNAPSHOT, RC>
 
-Change perlNNNdelta references to the new version in these files
+Bump the perlXYZ version number.
 
-    INSTALL
-    win32/Makefile.mk
-    win32/Makefile
-    Makefile.SH
-    README
+First, create a new empty perlNNNdelta.pod file for the current release + 1;
+see F<Porting/how_to_write_a_perldelta.pod>.
 
-Also, edit the previous delta file to change the C<NAME> from C<perldelta>
-to C<perlNNNdelta>.
+You should be able to do this by just copying in a skeleton template and
+then doing a quick fix up of the version numbers, e.g.
 
-These two lists of files probably aren't exhaustive; do a recursive grep
-on the previous filename to look for suitable candidates.
+    $ cp -i Porting/perldelta_template pod/perl5102delta.pod
+    $ (edit it)
+    $ git add pod/perl5102delta.pod
 
-(see 16410843ea for an example).
+Edit F<pod.lst>: add the new entry, flagged as 'D', and unflag the previous
+entry from being 'D'; for example:
 
-=item *
+    -D perl5101delta                Perl changes in version 5.10.1
+    +D perl5102delta                Perl changes in version 5.10.2
+    +  perl5101delta                Perl changes in version 5.10.1
 
-Run C<perl pod/buildtoc --build-all> to update the following files:
+Run C<perl pod/buildtoc --build-all> to update the F<perldelta> version in
+the following files:
 
     MANIFEST
+    Makefile.SH
+    pod.lst
     pod/perl.pod
-    win32/pod.mak
     vms/descrip_mms.template
+    win32/Makefile
+    win32/makefile.mk
+    win32/pod.mak
 
-If you modified perldelta.pod, (F<vms/descrip_mms.template> will
-needs a manual edit to bump the C<perldelta.pod> entry - it would
-be good for someone to figure out the fix.)
+Then manually edit (F<vms/descrip_mms.template> to bump the version
+in the following entry:
+
+    [.pod]perldelta.pod : [.pod]perl5101delta.pod
+
+XXX this previous step needs to fixed to automate it in pod/buildtoc.
+
+Manually update references to the perlNNNdelta version in these files:
+
+    INSTALL
+    README
+
+Edit the previous delta file to change the C<NAME> from C<perldelta>
+to C<perlNNNdelta>.
+
+These two lists of files probably aren't exhaustive; do a recursive grep
+on the previous filename to look for suitable candidates that may have
+been missed.
+
+Finally, commit:
+
+    $ git commit -a -m 'create perlXXXdelta'
+
+At this point you may want  to compare the commit with a previous bump to
+see if they look similar. See commit ca8de22071 for an example of a
+previous version bump.
 
 =item *
 
@@ -865,16 +910,23 @@ XXX need a git recipe
 
 I<You MUST SKIP this step for SNAPSHOT, RC, BLEAD>
 
-Copy the perlNNNdelta.pod for this release into the other branches, and
-remember to update these files on those branches too:
+Copy the perlNNNdelta.pod for this release into the other branches; for
+example:
 
-    MANIFEST
-    pod.lst
-    pod/perl.pod
-    vms/descrip_mms.template
-    win32/pod.mak
+    $ cp -i ../5.10.x/pod/perl5101delta.pod pod/    # for example
+    $ git add pod/perl5101delta.pod
+
+Edit F<pod.lst> to add an entry for the file, e.g.:
+
+    perl5101delta              Perl changes in version 5.10.1
+    
+Then rebuild various files:
+
+    $ perl pod/buildtoc --build-all
+
+Finally, commit:
 
-(see fc5be80860 for an example).
+    $ git commit -a -m 'add perlXXXdelta'
 
 =item *
 
@@ -890,13 +942,6 @@ e.g.
 
 =item *
 
-I<You MUST SKIP this step for SNAPSHOT, RC>
-
-Remind the current maintainer of C<Module::CoreList> to push a new release
-to CPAN.
-
-=item *
-
 I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some much-needed
 rest and relaxation>.