@@ -18,18 +18,18 @@ Perl, including those with write access to the git repository.
18
18
=head1 CLONING THE REPOSITORY
19
19
20
20
All of Perl's source code is kept centrally in a Git repository at
21
- I<perl5.git.perl.org >.
21
+ I<github.com >.
22
22
23
23
You can make a read-only clone of the repository by running:
24
24
25
- % git clone git://perl5.git.perl.org/perl .git perl
25
+ % git clone git://github.com/Perl/perl5 .git perl
26
26
27
27
This uses the git protocol (port 9418).
28
28
29
29
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:
31
31
32
- % git clone https://perl5.git.perl.org/perl .git perl
32
+ % git clone https://github.com/Perl/perl5 .git perl
33
33
34
34
=head1 WORKING WITH THE REPOSITORY
35
35
@@ -220,7 +220,8 @@ git will open a text editor for you to compose the message
220
220
interactively. This is useful when the changes are more complex than
221
221
the sample given here, and, depending on the editor, to know that the
222
222
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.
224
225
225
226
Once you've finished writing your commit message and exited your
226
227
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:
284
285
% git branch -D orange
285
286
Deleted branch orange.
286
287
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
-
328
288
=head2 Sending patch emails
329
289
330
290
After you've generated your patch you should send it
@@ -341,12 +301,12 @@ patch will be destroyed.
341
301
Someone may download your patch from RT, which will result in the
342
302
subject (the first line of the commit message) being omitted. See
343
303
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>
345
305
for an example. Alternatively someone may
346
306
apply your patch from RT after it arrived in their mailbox, by which
347
307
time RT will have modified the inline content of the message. See
348
308
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>
350
310
for a bad example of this failure mode.
351
311
352
312
=head2 A note on derived files
@@ -586,7 +546,7 @@ Once you have write access, you will need to modify the URL for the
586
546
origin remote to enable pushing. Edit F<.git/config> with the
587
547
git-config(1) command:
588
548
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
590
550
591
551
You can also set up your user name and e-mail address. Most people do
592
552
this once globally in their F<~/.gitconfig> by doing something like:
@@ -602,7 +562,7 @@ execute something like the following in F<perl>:
602
562
It is also possible to keep C<origin> as a git remote, and add a new
603
563
remote for ssh access:
604
564
605
- % git remote add camel perl5. git.perl.org:/perl .git
565
+ % git remote add camel git@github.com:Perl/perl5 .git
606
566
607
567
This allows you to update your local repository by pulling from
608
568
C<origin>, which is faster and doesn't require you to authenticate, and
@@ -814,35 +774,6 @@ original commit in the new commit message.
814
774
Before pushing any change to a maint version, make sure you've
815
775
satisfied the steps in L</Committing to blead> above.
816
776
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
-
846
777
=head2 Using a smoke-me branch to test changes
847
778
848
779
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
853
784
OSes: push it to a "smoke-me" branch and wait for certain automated
854
785
smoke-testers to report the results from their OSes.
855
786
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
857
788
component is precisely C<smoke-me>.
858
789
859
790
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:
917
848
) and then delete your local branch:
918
849
919
850
% 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
-
0 commit comments