Skip to content

Commit 47ef154

Browse files
Grinnztoddr
authored andcommitted
Update documentation, comments, metadata to reference GitHub as canonical repository (#1186)
* Update repository and bugtracker URLs to GitHub in makemeta regen META files * Update POD and comments to reference GitHub as canonical repository * Update Porting/corelist.pl to recognize GitHub issue tracker * remove "A note on camel and dromedary" * Remove redundant 'Committing your changes' section
1 parent cff6de5 commit 47ef154

14 files changed

+36
-129
lines changed

Changes

+2-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,8 @@ For a list of contributors to perl, see AUTHORS.
88

99
If you need a detailed commit history (i.e. descriptions of each
1010
individual commit), you can view the git version control history online
11-
at https://perl5.git.perl.org/perl.git (follow the 'shortlog' link beside
12-
the relevant tag). Or, you can download a copy of the git repository and
13-
then run a command like
11+
at https://github.com/Perl/perl5. Or, you can download a copy of the git
12+
repository and then run a command like
1413

1514
git log --name-status v5.12.0..v5.14.0
1615

META.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -117,14 +117,14 @@
117117
"release_status" : "unstable",
118118
"resources" : {
119119
"bugtracker" : {
120-
"web" : "https://rt.perl.org/"
120+
"web" : "https://github.com/Perl/perl5/issues"
121121
},
122122
"homepage" : "https://www.perl.org/",
123123
"license" : [
124124
"https://dev.perl.org/licenses/"
125125
],
126126
"repository" : {
127-
"url" : "https://perl5.git.perl.org/"
127+
"url" : "https://github.com/Perl/perl5"
128128
}
129129
},
130130
"version" : "5.031006",

META.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,9 @@ no_index:
110110
- vutil.h
111111
- vxs.inc
112112
resources:
113-
bugtracker: https://rt.perl.org/
113+
bugtracker: https://github.com/Perl/perl5/issues
114114
homepage: https://www.perl.org/
115115
license: https://dev.perl.org/licenses/
116-
repository: https://perl5.git.perl.org/
116+
repository: https://github.com/Perl/perl5
117117
version: '5.031006'
118118
x_serialization_backend: 'CPAN::Meta::YAML version 0.018'

Porting/README.pod

+1-1
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,7 @@ A helper tool for perl's 2038 support See F<Porting/README.y2038> for details.
361361
=head2 F<todo.pod>
362362

363363
This is a list of wishes for Perl. The most up-to-date version of this file is
364-
at L<https://perl5.git.perl.org/perl.git/blob_plain/HEAD:/Porting/todo.pod>.
364+
at L<https://github.com/Perl/perl5/blob/blead/Porting/todo.pod>.
365365
The tasks we think are smaller or easier are listed first. Anyone is welcome
366366
to work on any of these, but it's a good idea to first contact
367367
I<[email protected]> to avoid duplication of effort, and to learn from

Porting/corelist.pl

+1
Original file line numberDiff line numberDiff line change
@@ -291,6 +291,7 @@ ($)
291291
$bug_tracker = $bug_tracker->{web} if ref($bug_tracker) eq "HASH";
292292

293293
$bug_tracker = defined $bug_tracker ? quote($bug_tracker) : 'undef';
294+
next if $bug_tracker eq "'https://github.com/Perl/perl5/issues'";
294295
next if $bug_tracker eq "'http://rt.perl.org/perlbug/'";
295296
next if $bug_tracker eq "'https://rt.perl.org/perlbug/'";
296297
$tracker .= sprintf " %-24s=> %s,\n", "'$module'", $bug_tracker;

Porting/makemeta

+2-2
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ my $distmeta = {
4747
'dynamic_config' => 1,
4848
'resources' => {
4949
'repository' => {
50-
'url' => 'https://perl5.git.perl.org/'
50+
'url' => 'https://github.com/Perl/perl5'
5151
},
5252
'homepage' => 'https://www.perl.org/',
5353
'bugtracker' => {
54-
'web' => 'https://rt.perl.org/'
54+
'web' => 'https://github.com/Perl/perl5/issues'
5555
},
5656
'license' => [
5757
'https://dev.perl.org/licenses/'

Porting/todo.pod

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ todo - Perl TO-DO list
55
=head1 DESCRIPTION
66

77
This is a list of wishes for Perl. The most up to date version of this file
8-
is at L<https://perl5.git.perl.org/perl.git/blob_plain/HEAD:/Porting/todo.pod>
8+
is at L<https://github.com/Perl/perl5/blob/blead/Porting/todo.pod>.
99

1010
The tasks we think are smaller or easier are listed first. Anyone is welcome
1111
to work on any of these, but it's a good idea to first contact

configpm

+2-2
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ $config_txt .= sprintf << 'EOT', $], $export_funcs;
150150

151151
# for a description of the variables, please have a look at the
152152
# Glossary file, as written in the Porting folder, or use the url:
153-
# https://perl5.git.perl.org/perl.git/blob/HEAD:/Porting/Glossary
153+
# https://github.com/Perl/perl5/blob/blead/Porting/Glossary
154154

155155
package Config;
156156
use strict;
@@ -896,7 +896,7 @@ named variable exists.
896896

897897
For a description of the variables, please have a look at the
898898
Glossary file, as written in the Porting folder, or use the url:
899-
https://perl5.git.perl.org/perl.git/blob/HEAD:/Porting/Glossary
899+
https://github.com/Perl/perl5/blob/blead/Porting/Glossary
900900

901901
=over 4
902902

cop.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,8 @@ typedef struct jmpenv JMPENV;
103103
*
104104
* The original patches that introduces flexible exceptions were:
105105
*
106-
* https://perl5.git.perl.org/perl.git/commit/312caa8e97f1c7ee342a9895c2f0e749625b4929
107-
* https://perl5.git.perl.org/perl.git/commit/14dd3ad8c9bf82cf09798a22cc89a9862dfd6d1a
106+
* https://github.com/Perl/perl5/commit/312caa8e97f1c7ee342a9895c2f0e749625b4929
107+
* https://github.com/Perl/perl5/commit/14dd3ad8c9bf82cf09798a22cc89a9862dfd6d1a
108108
*
109109
*/
110110

hints/dec_osf.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ toke_cflags='optimize=-O2'
263263
esac
264264

265265
# The patch 23787
266-
# https://perl5.git.perl.org/perl.git/commit/73cb726371990cd489597c4fee405a9815abf4da
266+
# https://github.com/Perl/perl5/commit/73cb726371990cd489597c4fee405a9815abf4da
267267
# broke things for gcc (at least gcc 3.3) so that many of the pack()
268268
# checksum tests for formats L, j, J, especially when combined
269269
# with the < and > specifiers, started to fail if compiled with plain -O3.

pod/perlgit.pod

+11-103
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,18 @@ Perl, including those with write access to the git repository.
1818
=head1 CLONING THE REPOSITORY
1919

2020
All of Perl's source code is kept centrally in a Git repository at
21-
I<perl5.git.perl.org>.
21+
I<github.com>.
2222

2323
You can make a read-only clone of the repository by running:
2424

25-
% git clone git://perl5.git.perl.org/perl.git perl
25+
% git clone git://github.com/Perl/perl5.git perl
2626

2727
This uses the git protocol (port 9418).
2828

2929
If you cannot use the git protocol for firewall reasons, you can also
30-
clone via http, though this is much slower:
30+
clone via http:
3131

32-
% git clone https://perl5.git.perl.org/perl.git perl
32+
% git clone https://github.com/Perl/perl5.git perl
3333

3434
=head1 WORKING WITH THE REPOSITORY
3535

@@ -220,7 +220,8 @@ git will open a text editor for you to compose the message
220220
interactively. This is useful when the changes are more complex than
221221
the sample given here, and, depending on the editor, to know that the
222222
first line of the commit message doesn't exceed the 50 character legal
223-
maximum.
223+
maximum. See L<perlhack/Commit message> for more information about what
224+
makes a good commit message.
224225

225226
Once you've finished writing your commit message and exited your
226227
editor, git will write your change to disk and tell you something like
@@ -284,47 +285,6 @@ If you want to delete your temporary branch, you may do so with:
284285
% git branch -D orange
285286
Deleted branch orange.
286287

287-
=head2 Committing your changes
288-
289-
Assuming that you'd like to commit all the changes you've made as a
290-
single atomic unit, run this command:
291-
292-
% git commit -a
293-
294-
(That C<-a> tells git to add every file you've changed to this commit.
295-
New files aren't automatically added to your commit when you use
296-
C<commit -a> If you want to add files or to commit some, but not all of
297-
your changes, have a look at the documentation for C<git add>.)
298-
299-
Git will start up your favorite text editor, so that you can craft a
300-
commit message for your change. See L<perlhack/Commit message> for more
301-
information about what makes a good commit message.
302-
303-
Once you've finished writing your commit message and exited your
304-
editor, git will write your change to disk and tell you something like
305-
this:
306-
307-
Created commit daf8e63: explain git status and stuff about remotes
308-
1 files changed, 83 insertions(+), 3 deletions(-)
309-
310-
If you re-run C<git status>, you should see something like this:
311-
312-
% git status
313-
On branch blead
314-
Your branch is ahead of 'origin/blead' by 2 commits.
315-
(use "git push" to publish your local commits)
316-
Untracked files:
317-
(use "git add <file>..." to include in what will be committed)
318-
319-
deliberate.untracked
320-
321-
nothing added to commit but untracked files present (use "git add" to
322-
track)
323-
324-
When in doubt, before you do anything else, check your status and read
325-
it carefully, many questions are answered directly by the git status
326-
output.
327-
328288
=head2 Sending patch emails
329289

330290
After you've generated your patch you should send it
@@ -341,12 +301,12 @@ patch will be destroyed.
341301
Someone may download your patch from RT, which will result in the
342302
subject (the first line of the commit message) being omitted. See
343303
L<RT #74192|https://rt.perl.org/Ticket/Display.html?id=74192> and
344-
L<commit a4583001|https://perl5.git.perl.org/perl.git/commitdiff/a4583001>
304+
L<commit a4583001|https://github.com/Perl/perl5/commit/a4583001>
345305
for an example. Alternatively someone may
346306
apply your patch from RT after it arrived in their mailbox, by which
347307
time RT will have modified the inline content of the message. See
348308
L<RT #74532|https://rt.perl.org/Ticket/Display.html?id=74532> and
349-
L<commit f9bcfeac|https://perl5.git.perl.org/perl.git/commitdiff/f9bcfeac>
309+
L<commit f9bcfeac|https://github.com/Perl/perl5/commit/f9bcfeac>
350310
for a bad example of this failure mode.
351311

352312
=head2 A note on derived files
@@ -586,7 +546,7 @@ Once you have write access, you will need to modify the URL for the
586546
origin remote to enable pushing. Edit F<.git/config> with the
587547
git-config(1) command:
588548

589-
% git config remote.origin.url ssh://perl5.git.perl.org/perl.git
549+
% git config remote.origin.url git@github.com:Perl/perl5.git
590550

591551
You can also set up your user name and e-mail address. Most people do
592552
this once globally in their F<~/.gitconfig> by doing something like:
@@ -602,7 +562,7 @@ execute something like the following in F<perl>:
602562
It is also possible to keep C<origin> as a git remote, and add a new
603563
remote for ssh access:
604564

605-
% git remote add camel perl5.git.perl.org:/perl.git
565+
% git remote add camel git@github.com:Perl/perl5.git
606566

607567
This allows you to update your local repository by pulling from
608568
C<origin>, which is faster and doesn't require you to authenticate, and
@@ -814,35 +774,6 @@ original commit in the new commit message.
814774
Before pushing any change to a maint version, make sure you've
815775
satisfied the steps in L</Committing to blead> above.
816776

817-
=head2 Merging from a branch via GitHub
818-
819-
While we don't encourage the submission of patches via GitHub, that
820-
will still happen. Here is a guide to merging patches from a GitHub
821-
repository.
822-
823-
% git remote add avar git://github.com/avar/perl.git
824-
% git fetch avar
825-
826-
Now you can see the differences between the branch and blead:
827-
828-
% git diff avar/orange
829-
830-
And you can see the commits:
831-
832-
% git log avar/orange
833-
834-
If you approve of a specific commit, you can cherry pick it:
835-
836-
% git cherry-pick 0c24b290ae02b2ab3304f51d5e11e85eb3659eae
837-
838-
Or you could just merge the whole branch if you like it all:
839-
840-
% git merge avar/orange
841-
842-
And then push back to the repository:
843-
844-
% git push origin blead
845-
846777
=head2 Using a smoke-me branch to test changes
847778

848779
Sometimes a change affects code paths which you cannot test on the OSes
@@ -853,7 +784,7 @@ Fortunately, there is a way to get your change smoke-tested on various
853784
OSes: push it to a "smoke-me" branch and wait for certain automated
854785
smoke-testers to report the results from their OSes.
855786
A "smoke-me" branch is identified by the branch name: specifically, as
856-
seen on perl5.git.perl.org it must be a local branch whose first name
787+
seen on github.com it must be a local branch whose first name
857788
component is precisely C<smoke-me>.
858789

859790
The procedure for doing this is roughly as follows (using the example of
@@ -917,26 +848,3 @@ Finally, you should then delete the remote smoke-me branch:
917848
) and then delete your local branch:
918849

919850
% git branch -d win32stat
920-
921-
=head2 A note on camel and dromedary
922-
923-
The committers have SSH access to the two servers that serve
924-
C<perl5.git.perl.org>. One is C<perl5.git.perl.org> itself (I<camel>),
925-
which is the 'master' repository. The second one is
926-
C<users.perl5.git.perl.org> (I<dromedary>), which can be used for
927-
general testing and development. Dromedary syncs the git tree from
928-
camel every few minutes, you should not push there. Both machines also
929-
have a full CPAN mirror in F</srv/CPAN>, please use this. To share files
930-
with the general public, dromedary serves your F<~/public_html/> as
931-
C<L<https://users.perl5.git.perl.org/~yourlogin/>>
932-
933-
These hosts have fairly strict firewalls to the outside. Outgoing, only
934-
rsync, ssh and git are allowed. For http and ftp, you can use
935-
L<http://webproxy:3128> as proxy. Incoming, the firewall tries to detect
936-
attacks and blocks IP addresses with suspicious activity. This
937-
sometimes (but very rarely) has false positives and you might get
938-
blocked. The quickest way to get unblocked is to notify the admins.
939-
940-
These two boxes are owned, hosted, and operated by booking.com. You can
941-
reach the sysadmins in #p5p on irc.perl.org or via mail to
942-

pod/perlhack.pod

+7-8
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ for a bug, comment fixes, etc., it's easy! Here's how:
2727
The perl source is in a git repository. You can clone the repository
2828
with the following command:
2929

30-
% git clone git://perl5.git.perl.org/perl.git perl
30+
% git clone https://github.com/Perl/perl5.git perl
3131

3232
=item * Ensure you're following the latest advice
3333

@@ -157,7 +157,7 @@ Perl core.
157157
=head1 GETTING THE PERL SOURCE
158158

159159
All of Perl's source code is kept centrally in a Git repository at
160-
I<perl5.git.perl.org>. The repository contains many Perl revisions
160+
I<github.com>. The repository contains many Perl revisions
161161
from Perl 1 onwards and all the revisions from Perforce, the previous
162162
version control system.
163163

@@ -169,23 +169,22 @@ L<perlgit>.
169169
You will need a copy of Git for your computer. You can fetch a copy of
170170
the repository using the git protocol:
171171

172-
% git clone git://perl5.git.perl.org/perl.git perl
172+
% git clone git://github.com/Perl/perl5.git perl
173173

174174
This clones the repository and makes a local copy in the F<perl>
175175
directory.
176176

177177
If you cannot use the git protocol for firewall reasons, you can also
178-
clone via http, though this is much slower:
178+
clone via http:
179179

180-
% git clone https://perl5.git.perl.org/perl.git perl
180+
% git clone https://github.com/Perl/perl5.git perl
181181

182182
=head2 Read access via the web
183183

184184
You may access the repository over the web. This allows you to browse
185-
the tree, see recent commits, subscribe to RSS feeds for the changes,
185+
the tree, see recent commits, subscribe to repository notifications,
186186
search for particular commits and more. You may access it at
187-
L<https://perl5.git.perl.org/perl.git>. A mirror of the repository is
188-
found at L<https://github.com/Perl/perl5>.
187+
L<https://github.com/Perl/perl5>.
189188

190189
=head2 Read access via rsync
191190

pod/perlsource.pod

+1-1
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ platform-specific Configure-like scripts, as well as F<Configure>
214214
itself.
215215

216216
The metaconfig system has its own git repository. Please see its README
217-
file in L<https://perl5.git.perl.org/metaconfig.git/> for more details.
217+
file in L<https://github.com/Perl/metaconfig> for more details.
218218

219219
The F<Cross> directory contains various files related to
220220
cross-compiling Perl. See F<Cross/README> for more details.

pod/perltodo.pod

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ perltodo - Link to the Perl to-do list
55
=head1 DESCRIPTION
66

77
The Perl 5 to-do list is maintained in the git repository, and can
8-
be viewed at L<https://perl5.git.perl.org/perl.git/blob/HEAD:/Porting/todo.pod>
8+
be viewed at L<https://github.com/Perl/perl5/blob/blead/Porting/todo.pod>.
99

1010
(The to-do list used to be here in perltodo. That has stopped, as installing a
1111
snapshot that becomes increasingly out of date isn't that useful to anyone.)

0 commit comments

Comments
 (0)