Skip to content

Commit fb4d3f5

Browse files
thibaultduponchellekhwilliamson
authored andcommitted
RMG: Simplify the corelist section
1 parent 7c8d192 commit fb4d3f5

File tree

1 file changed

+20
-42
lines changed

1 file changed

+20
-42
lines changed

Porting/release_managers_guide.pod

Lines changed: 20 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -717,54 +717,32 @@ F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm>
717717

718718
=head4 Update C<Module::CoreList> with module version data for the new release
719719

720-
Note that if this is a MAINT release, you should run the following actions
721-
from the maint branch, but commit the C<CoreList.pm> changes in
722-
I<blead> and subsequently cherry-pick any releases since the last
723-
maint release and then your recent commit. XXX need a better example
724-
725-
[ Note that the procedure for handling Module::CoreList in maint branches
726-
is a bit complex, and the RMG currently don't describe a full and
727-
workable approach. The main issue is keeping Module::CoreList
728-
and its version number synchronised across all maint branches, blead and
729-
CPAN, while having to bump its version number for every RC release.
730-
See this brief p5p thread:
731-
732-
Message-ID: <[email protected]>
733-
734-
If you can devise a workable system, feel free to try it out, and to
735-
update the RMG accordingly!
720+
For BLEAD-POINT, RC and BLEAD-FINAL, run:
736721

737-
DAPM May 2013 ]
738-
739-
F<corelist.pl> uses www.cpan.org to verify information about dual-lived
740-
modules on CPAN. It can use a full, local CPAN mirror and/or fall back
741-
on HTTP::Tiny to fetch package metadata remotely.
742-
743-
(If you'd prefer to have a full CPAN mirror, see
744-
L<How to mirror CPAN|https://www.cpan.org/misc/how-to-mirror.html>)
722+
$ ./perl -Ilib Porting/corelist.pl cpan
745723

746-
Change to your perl checkout, and if necessary,
724+
Check those files over carefully:
747725

748-
$ make
726+
$ git diff dist/Module-CoreList/lib/Module/CoreList.pm
727+
$ git diff dist/Module-CoreList/lib/Module/CoreList/Utils.pm
749728

750-
Then, If you have a local CPAN mirror, run:
729+
If you have a L<local CPAN mirror|https://www.cpan.org/misc/how-to-mirror.html>, run:
751730

752731
$ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
753732

754-
Otherwise, run:
733+
For MAINT, the prodecure is not straightforward and implies to pick past
734+
updates (e.g. from BLEAD-POINT) into the corelist.
755735

756-
$ ./perl -Ilib Porting/corelist.pl cpan
736+
In practice, you should run the previous actions
737+
from the maint branch, but commit the C<CoreList.pm> changes in
738+
I<blead> and subsequently cherry-pick any releases since the last
739+
maint release and then your recent commit.
757740

758-
This will chug for a while, possibly reporting various warnings about
759-
badly-indexed CPAN modules unrelated to the modules actually in core.
760-
Assuming all goes well, it will update
761-
F<dist/Module-CoreList/lib/Module/CoreList.pm> and possibly
762-
F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm>.
741+
The main issue is keeping Module::CoreList
742+
and its version number synchronised across all maint branches, blead and
743+
CPAN, while having to bump its version number for every RC release.
763744

764-
Check those files over carefully:
765-
766-
$ git diff dist/Module-CoreList/lib/Module/CoreList.pm
767-
$ git diff dist/Module-CoreList/lib/Module/CoreList/Utils.pm
745+
See L<Handling Module::CoreList in MAINT branches (Dave Mitchell)|https://www.nntp.perl.org/group/perl.perl5.porters/2013/03/msg200007.html>.
768746

769747
=head4 Bump version in Module::CoreList F<Changes>
770748

@@ -1567,13 +1545,13 @@ and F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm>.
15671545

15681546
=item *
15691547

1570-
If you have a local CPAN mirror, run:
1548+
In most cases, run:
15711549

1572-
$ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
1550+
$ ./perl -Ilib Porting/corelist.pl cpan
15731551

1574-
Otherwise, run:
1552+
If you have a L<local CPAN mirror|https://www.cpan.org/misc/how-to-mirror.html>, run:
15751553

1576-
$ ./perl -Ilib Porting/corelist.pl cpan
1554+
$ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
15771555

15781556
This will update F<dist/Module-CoreList/lib/Module/CoreList.pm> and
15791557
F<dist/Module-CoreList/lib/Module/CoreList/Utils.pm> as it did before,

0 commit comments

Comments
 (0)