1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
|
<?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8"/>
<meta name="generator" content="AsciiDoc 8.6.1"/>
<title>Gentoo Perl Overlay Tips</title>
<style type="text/css">
/*<![CDATA[*/
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
border: 1px solid red;
*/
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
color: navy;
}
strong {
font-weight: bold;
color: #083194;
}
tt {
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
div.sectionbody {
font-family: serif;
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul, ol, li > p {
margin-top: 0;
}
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revnumber, span#revdate, span#revremark {
font-family: sans-serif;
}
div#footer {
font-family: sans-serif;
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.0em;
margin-bottom: 2.0em;
margin-right: 10%;
color: #606060;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock, div.verseblock {
padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
border-left: 5px solid #dddddd;
color: #777777;
}
div.quoteblock > div.attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock > pre.content {
font-family: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 3px solid #dddddd;
}
div.exampleblock > div.content {
border-left: 3px solid #dddddd;
padding-left: 0.5em;
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; }
a.image:visited { color: white; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: normal;
color: navy;
}
dd > *:first-child {
margin-top: 0.1em;
}
ul, ol {
list-style-position: outside;
}
ol.arabic {
list-style-type: decimal;
}
ol.loweralpha {
list-style-type: lower-alpha;
}
ol.upperalpha {
list-style-type: upper-alpha;
}
ol.lowerroman {
list-style-type: lower-roman;
}
ol.upperroman {
list-style-type: upper-roman;
}
div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
margin-top: 0.1em;
margin-bottom: 0.1em;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead, p.table.header {
font-family: sans-serif;
font-weight: bold;
color: #527bbd;
}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
div.tableblock > table[frame="hsides"] {
border-left-style: none;
border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
border-top-style: none;
border-bottom-style: none;
}
div.hdlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hdlist tr {
padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
font-weight: bold;
}
td.hdlist1 {
vertical-align: top;
font-style: normal;
padding-right: 0.8em;
color: navy;
}
td.hdlist2 {
vertical-align: top;
}
div.hdlist.compact tr {
margin: 0;
padding-bottom: 0;
}
.comment {
background: yellow;
}
.footnote, .footnoteref {
font-size: 0.8em;
}
span.footnote, span.footnoteref {
vertical-align: super;
}
#footnotes {
margin: 20px 0 20px 0;
padding: 7px 0 0 0;
}
#footnotes div.footnote {
margin: 0 0 5px 0;
}
#footnotes hr {
border: none;
border-top: 1px solid silver;
height: 1px;
text-align: left;
margin-left: 0;
width: 20%;
min-width: 100px;
}
div.colist td {
padding-right: 0.5em;
padding-bottom: 0.3em;
vertical-align: top;
}
div.colist td img {
margin-top: 0.3em;
}
@media print {
div#footer-badges { display: none; }
}
div#toc {
margin-bottom: 2.5em;
}
div#toctitle {
color: #527bbd;
font-family: sans-serif;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
/*
pygmentize filter
*/
.highlight .hll { background-color: #ffffcc }
.highlight { background: #f4f4f4; }
.highlight .c { color: #008800; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #AA22FF; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
.highlight .cm { color: #008800; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #008800 } /* Comment.Preproc */
.highlight .c1 { color: #008800; font-style: italic } /* Comment.Single */
.highlight .cs { color: #008800; font-weight: bold } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #808080 } /* Generic.Output */
.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #0040D0 } /* Generic.Traceback */
.highlight .kc { color: #AA22FF; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #AA22FF; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #AA22FF; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #AA22FF } /* Keyword.Pseudo */
.highlight .kr { color: #AA22FF; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #00BB00; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #666666 } /* Literal.Number */
.highlight .s { color: #BB4444 } /* Literal.String */
.highlight .na { color: #BB4444 } /* Name.Attribute */
.highlight .nb { color: #AA22FF } /* Name.Builtin */
.highlight .nc { color: #0000FF } /* Name.Class */
.highlight .no { color: #880000 } /* Name.Constant */
.highlight .nd { color: #AA22FF } /* Name.Decorator */
.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #00A000 } /* Name.Function */
.highlight .nl { color: #A0A000 } /* Name.Label */
.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #B8860B } /* Name.Variable */
.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mf { color: #666666 } /* Literal.Number.Float */
.highlight .mh { color: #666666 } /* Literal.Number.Hex */
.highlight .mi { color: #666666 } /* Literal.Number.Integer */
.highlight .mo { color: #666666 } /* Literal.Number.Oct */
.highlight .sb { color: #BB4444 } /* Literal.String.Backtick */
.highlight .sc { color: #BB4444 } /* Literal.String.Char */
.highlight .sd { color: #BB4444; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #BB4444 } /* Literal.String.Double */
.highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #BB4444 } /* Literal.String.Heredoc */
.highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
.highlight .sx { color: #008000 } /* Literal.String.Other */
.highlight .sr { color: #BB6688 } /* Literal.String.Regex */
.highlight .s1 { color: #BB4444 } /* Literal.String.Single */
.highlight .ss { color: #B8860B } /* Literal.String.Symbol */
.highlight .bp { color: #AA22FF } /* Name.Builtin.Pseudo */
.highlight .vc { color: #B8860B } /* Name.Variable.Class */
.highlight .vg { color: #B8860B } /* Name.Variable.Global */
.highlight .vi { color: #B8860B } /* Name.Variable.Instance */
.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
/*]]>*/
</style>
<script type="text/javascript">
/*<+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
var iterate = function (el) {
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
var mo = re.exec(i.tagName);
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
}
iterate(i);
}
}
}
iterate(el);
return result;
}
var toc = document.getElementById("toc");
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
if (entry.element.id == "")
entry.element.id = "_toc_" + i;
var a = document.createElement("a");
a.href = "#" + entry.element.id;
a.appendChild(document.createTextNode(entry.text));
var div = document.createElement("div");
div.appendChild(a);
div.className = "toclevel" + entry.toclevel;
toc.appendChild(div);
}
if (entries.length == 0)
toc.parentNode.removeChild(toc);
},
/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////
/* Based on footnote generation code from:
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
*/
footnotes: function () {
var cont = document.getElementById("content");
var noteholder = document.getElementById("footnotes");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
// Use [\s\S] in place of . so multi-line matches work.
// Because JavaScript has no s (dotall) regex flag.
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
}
if (n == 0)
noteholder.parentNode.removeChild(noteholder);
else {
// Process footnoterefs.
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnoteref") {
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
href = href.match(/#.*/)[0]; // Because IE return full URL.
n = refs[href];
spans[i].innerHTML =
"[<a href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
}
}
}
}
}
/*]]>*/
</script>
</head>
<body class="article">
<div id="header">
<h1>Gentoo Perl Overlay Tips</h1>
<span id="author">The #gentoo-perl team.</span><br/>
<div id="toc">
<div id="toctitle">Table of Contents</div>
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="networks">1. Networks</h2>
<div class="sectionbody">
<div class="paragraph"><p>The Gentoo Perl Herd and the overlay contributors have various channels of
communications and interactions.</p></div>
<div class="sect2">
<h3 id="networks-irc">1.1. IRC</h3>
<div class="paragraph"><p>The primary source for all direct Gentoo Perl communications is <tt>#gentoo-perl</tt>
on <tt>irc.freenode.org</tt></p></div>
</div>
<div class="sect2">
<h3 id="networks-sourcecontrol">1.2. Source-Control</h3>
<div class="paragraph"><p>Overlays for Gentoo can be found on <a href="#repositories-github">Github</a> and
<a href="#repositories-gogo">the Gentoo Overlays website</a>.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_git">2. Git</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="repositories">2.1. Repositories</h3>
<div class="paragraph"><p>At the time of this writing, there are several repositories.</p></div>
<div class="sect3">
<h4 id="repositories-gogo">2.1.1. Git.Overlays.Gentoo.org</h4>
<div class="paragraph"><p>Few people with commit rights.
Does not broadcast pushes to IRC.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
ReadOnly(git)
</dt>
<dd>
<p>
<tt>git://git.overlays.gentoo.org/proj/perl-overlay.git</tt>
</p>
</dd>
<dt class="hdlist1">
ReadOnly(http)
</dt>
<dd>
<p>
<tt>http://git.overlays.gentoo.org/gitroot/proj/perl-overlay.git</tt>
</p>
</dd>
<dt class="hdlist1">
ReadWrite
</dt>
<dd>
<p>
<tt>git+ssh://git@git.overlays.gentoo.org/proj/perl-overlay</tt>
</p>
</dd>
</dl></div>
</div>
<div class="sect3">
<h4 id="repositories-github">2.1.2. Github</h4>
<div class="paragraph"><p>Same number of commiters.
Supports people without direct access sending pull requests.
PUSHES to this repository create broadcasts in IRC.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
ReadOnly(git)
</dt>
<dd>
<p>
<tt>git://github.com/gentoo-perl/perl-experimental.git</tt>
</p>
</dd>
<dt class="hdlist1">
ReadOnly(http)
</dt>
<dd>
<p>
<tt>http://github.com/gentoo-perl/perl-experimental.git</tt>
</p>
</dd>
<dt class="hdlist1">
ReadWrite
</dt>
<dd>
<p>
<tt>git@github.com:gentoo-perl/perl-experimental.git</tt>
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect2">
<h3 id="_recommended_contribution_order">2.2. Recommended Contribution Order</h3>
<div class="paragraph"><p>Contributions are recommended to be performed in the following order:</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
Progress your patch sequence locally.
</p>
</li>
<li>
<p>
<strong>(optional)</strong> push your patch sequence to your personal public repository
</p>
</li>
<li>
<p>
Push your patch sequence to <a href="#repositories-github">Github</a>.
</p>
</li>
<li>
<p>
Push your patch sequence to <a href="#repositories-gogo">git.overlays.gentoo.org</a>.
</p>
</li>
</ol></div>
<div class="paragraph"><p>This order will hopefully reduce the amount of push collisions encountered,
which will make all our lives easier =).</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/tip.png" alt="Tip"/>
</td>
<td class="content">It is strongly suggested to watch <a href="#networks-irc"><tt>#gentoo-perl</tt></a> for pushed commit notices so
you can anticipate a collison happening <em>before</em> it occurs outside the safety
of your pc</td>
</tr></table>
</div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/tip.png" alt="Tip"/>
</td>
<td class="content">If <tt>git</tt> tells you there is an upstream non-fast forward merge, do make sure
you resolve it locally somehow, not just force it, unless you <em>know</em> what you
are doing.</td>
</tr></table>
</div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/tip.png" alt="Tip"/>
</td>
<td class="content">For optimal continuity, it is suggested you do all you can possible to
linearize commits. See <a href="linearize_commits.txt">Linearizing Commits</a></td>
</tr></table>
</div>
</div>
<div class="sect2">
<h3 id="linearizecommits">2.3. Linearize Commmits</h3>
<div class="paragraph"><p>Messy commit histories with lots of needless merge branches just get confusing
when trying to work backwards and work out what happened.</p></div>
<div class="paragraph"><p>To resolve this issue, it is strongly recommended to utilize <tt>git rebase</tt> to
simplify merge histories in a way as such it produces the illusion the merge
never happened, and was never needed, as all the commits simply happend after
all the other commits they were going to be merged into.</p></div>
<div class="paragraph"><p>But the subject of <tt>git rebase</tt> is far too complex to summarise in this one
document, at least for now, so you should use other online sources to learn
this.</p></div>
<div class="sect3">
<h4 id="rebase">2.3.1. Git Rebase related Articles</h4>
<div class="dlist"><dl>
<dt class="hdlist1">
Tate Johnson
</dt>
<dd>
<p>
<a href="http://tatey.com/2009/04/23/git-rebase-for-linear-history/">Git Rebase
For Linear History</a>
</p>
</dd>
<dt class="hdlist1">
ProGit.org
</dt>
<dd>
<p>
<a href="http://progit.org/book/ch3-6.html"> Rebase </a>
</p>
</dd>
<dt class="hdlist1">
John Wiegley
</dt>
<dd>
<p>
<a href="http://www.newartisans.com/2008/04/git-from-the-bottom-up.html">
Git from the bottom up</a>
</p>
</dd>
<dt class="hdlist1">
Tommi Virtanen
</dt>
<dd>
<p>
<a href="http://eagain.net/articles/git-for-computer-scientists/">
Git for Computer Scientists</a>
</p>
</dd>
<dt class="hdlist1">
nothingmuch/Yuval Kogman
</dt>
<dd>
<div class="ulist"><ul>
<li>
<p>
<a href="http://blog.woobling.org/2009/05/git-rebase-considered-awesome.html">
<tt>git rebase</tt> Considered Awesome</a>
</p>
</li>
<li>
<p>
<a href="http://blog.woobling.org/2009/08/git-rebase-for-impatient.html">
<tt>git rebase</tt> for the Impatient</a>
</p>
</li>
</ul></div>
</dd>
<dt class="hdlist1">
Dean Strelau
</dt>
<dd>
<p>
<a href="http://d.strelau.net/post/47338904/git-pull-rebase-by-default">
<tt>git pull --rebase</tt> by default</a>
</p>
</dd>
<dt class="hdlist1">
Kent Fredric
</dt>
<dd>
<p>
<a href="http://blog.fox.geek.nz/2010/08/git-rebase-part-1-why-you-should-use-it.html">Git
Rebase Part 1: Why you should use it, Theory.</a>
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect2">
<h3 id="workinabranch">2.4. Work In A Branch</h3>
<div class="paragraph"><p>Working in a branch instead of on <tt>master</tt> I have found to be a productive way
to get things done with minimal interference from other commiters.</p></div>
<div class="paragraph"><p>Working this way lets you track upstream changes locally, update your local
master, and work on multiple subjects simultaneously without any conflicts,
and without being forced to perform a merge/rebase as soon as changes occur
upstream.</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre> git checkout master
<span class="c"># create a new branch to work in.</span>
git checkout -b updates
<span class="c"># hack on updates.</span>
<span class="c"># commit changes to update branch</span>
git commit -m <span class="s2">"Some message"</span>
<span class="c"># return to master</span>
git checkout master
<span class="c"># update master from upstream</span>
git pull -u -v
<span class="c"># create another branch from master for a quick-fix</span>
git checkout -b quickfix
<span class="c"># hack on quick fix</span>
<span class="c"># commit change to quick fix branch</span>
git commit -m <span class="s2">"Emergency Commit set"</span>
<span class="c"># return to master</span>
git checkout master
<span class="c"># check for changes from upstream.</span>
git pull -u -v
<span class="c"># Damn, updates happened.</span>
git checkout quickfix
<span class="c"># rebase quickfix on top of master</span>
git rebase -i master
git checkout master
<span class="c"># check again for upstream changes</span>
git pull -u -v
<span class="c"># Yay, no upstream changes, time to publish the changes in quickfix</span>
<span class="c"># --ff-only is good to prevent anarchy</span>
git merge --ff-only quickfix
git push upstream master
git branch -d quickfix
<span class="c"># return to work on updates</span>
git checkout updates
<span class="c"># move updates to be after master before continuing to hack</span>
git rebase -i master
<span class="c"># more hacking on updates</span>
git checkout master
<span class="c"># check for upstream changes</span>
git pull -u -v
<span class="c"># Yay, no upstream changes!</span>
git merge --ff-only updates
git push upstream master
</pre></div></div></div>
</div>
<div class="sect2">
<h3 id="_disable_merge_pull">2.5. Disable Merge Pull</h3>
<div class="paragraph"><p>When you’re trying to keep things linear by rebasing, it can be frustrating
when the following happens:</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
You commit to master.
</p>
</li>
<li>
<p>
You push to upstream.
</p>
</li>
<li>
<p>
Upstream has been updated.
</p>
</li>
</ol></div>
<div class="paragraph"><p>In this scenario you have 3 choices.</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
<em>(not recommended)</em> : force push, clobbering upstreams changes
</p>
</li>
<li>
<p>
<em>(not recommended)</em> : merge pull
</p>
</li>
<li>
<p>
<em>(recommended)</em> : rebase pull ( <tt>git pull --rebase</tt> )
</p>
</li>
</ol></div>
<div class="paragraph"><p>Generally, you want option 3.</p></div>
<div class="paragraph"><p>However, if you’re anything like me, either a rebase or a merge occuring
during pull scares you, and you’d rather <em>choose</em> to trigger that behaviour,
and you would not want to accidentally merge.</p></div>
<div class="paragraph"><p>I do this by disabling non-fastforward merges.</p></div>
<div class="paragraph"><p>This means that instead of a magical merge, or an automatic rebase, it will
simply complain that a fast-forward cannot occur, and then stops, letting you
resolve the situation.</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre> <span class="k">[branch "master"]</span>
<span class="na">remote</span> <span class="o">=</span> <span class="s">origin</span>
<span class="na">merge</span> <span class="o">=</span> <span class="s">refs/heads/master</span>
<span class="na">mergeoptions</span> <span class="o">=</span> <span class="s">--ff-only</span>
</pre></div></div></div>
</div>
<div class="sect2">
<h3 id="_set_up_ssh_mulitplexing_for_speed">2.6. Set up SSH Mulitplexing for Speed</h3>
<div class="paragraph"><p>This is one of my most convenient tricks. The slowest parts of <tt>git pull</tt> and
<tt>git push</tt> are starting up the SSH connection. However, there is a way to
eliminate this problem simply by opening a persistent tunnel, which <tt>git pull</tt>
and <tt>git push</tt> automatically reuse.</p></div>
<div class="sect3">
<h4 id="_ssh_config">2.6.1. ~/.ssh/config</h4>
<div class="paragraph"><p>Enter the ControlMaster option for OpenSSH.</p></div>
<div class="quoteblock">
<div class="content">
<div class="paragraph"><p><strong>ControlMaster</strong></p></div>
<div class="paragraph"><p>Enables the sharing of multiple sessions over a single network connection.
When set to “yes”, ssh(1) will listen for connections on a control socket
specified using the ControlPath argument. Additional sessions can connect to
this socket using the same <strong>ControlPath</strong> with <strong>ControlMaster</strong> set to “no”
(the default).</p></div>
<div class="paragraph"><p>These sessions will try to reuse the master instance’s network connection
rather than initiating new ones, but will fall back to connecting normally if
the control socket does not exist, or is not listening.</p></div>
<div class="paragraph"><p>Setting this to “ask” will cause ssh to listen for control connections, but
require confirmation using the SSH_ASKPASS program before they are accepted
(see ssh-add(1) for details). If the <strong>ControlPath</strong> cannot be opened, ssh will
continue without connecting to a master instance.</p></div>
<div class="paragraph"><p>X11 and ssh-agent(1) forwarding is supported over these multiplexed
connections, however the display and agent forwarded will be the one belonging
to the master connection i.e. it is not possible to forward multiple displays
or agents.</p></div>
<div class="paragraph"><p>Two additional options allow for opportunistic multiplexing: try to use a
master connection but fall back to creating a new one if one does not already
exist. These options are: “auto” and “autoask”. The latter requires
confirmation like the “ask” option.</p></div>
</div>
<div class="attribution">
</div></div>
<div class="paragraph"><p>So I set up my ~/.ssh/config as follows.</p></div>
<div class="listingblock">
<div class="content"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
2
3
4
5
6</pre></div></td><td class="code"><div class="highlight"><pre><span class="c">#~/.ssh/config</span>
ControlMaster auto
ControlPath ~/.ssh/pool/%r@%h
ServerAliveCountMax 6
ServerAliveInterval 10
TCPKeepAlive yes
</pre></div>
</td></tr></table></div></div>
<div class="paragraph"><p>And we’re set!.</p></div>
</div>
<div class="sect3">
<h4 id="_first_a_few_benchmarks">2.6.2. First, a few benchmarks</h4>
<div class="paragraph"><p>First, lets see how fast it is without the magic:</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre>> <span class="nb">time </span><span class="k">for </span>i in <span class="k">$(</span> seq 0 10 <span class="k">)</span> ; <span class="k">do </span>git fetch github; <span class="k">done</span>
real 0m47.798s
user 0m0.226s
sys 0m0.236s
> <span class="nb">time </span><span class="k">for </span>i in <span class="k">$(</span> seq 0 10 <span class="k">)</span> ; <span class="k">do </span>git fetch origin; <span class="k">done</span>
real 0m48.444s
user 0m0.235s
sys 0m0.250s
</pre></div></div></div>
<div class="paragraph"><p>Averaging about 4.34s per fetch to Github, 4.40s to gentoo overlays.</p></div>
<div class="paragraph"><p>SLOOW.</p></div>
</div>
<div class="sect3">
<h4 id="_start_a_background_connection">2.6.3. Start a background connection</h4>
<div class="paragraph"><p>With ControlMaster, you set up a long-lived SSH connection.</p></div>
<div class="listingblock">
<div class="content"><div class="highlight"><pre>> ssh -fNn git@github.com
> ssh -fNn git@git.overlays.gentoo.org
</pre></div></div></div>
<div class="paragraph"><p>And we’re truely really to start cooking with petrol.</p></div>
</div>
<div class="sect3">
<h4 id="_post_configuration_benchmarks">2.6.4. Post Configuration Benchmarks</h4>
<div class="listingblock">
<div class="content"><div class="highlight"><pre>> <span class="nb">time </span><span class="k">for </span>i in <span class="k">$(</span> seq 0 10 <span class="k">)</span> ; <span class="k">do </span>git fetch github; <span class="k">done</span>
real 0m12.935s
user 0m0.093s
sys 0m0.193s
> <span class="nb">time </span><span class="k">for </span>i in <span class="k">$(</span> seq 0 10 <span class="k">)</span> ; <span class="k">do </span>git fetch origin; <span class="k">done</span>
real 0m11.597s
user 0m0.099s
sys 0m0.191s
</pre></div></div></div>
<div class="paragraph"><p>O_o. Averaging about 1.175s and 1.05s respectively.</p></div>
</div>
</div>
</div>
</div>
</div>
<div id="footnotes"><hr/></div>
<div id="footer">
<div id="footer-text">
Last updated 2010-09-29 14:37:13 NZDT
</div>
<div id="footer-badges">
<a href="http://validator.w3.org/check?uri=referer">
<img style="border:0;width:88px;height:31px" src="http://www.w3.org/Icons/valid-xhtml11-blue" alt="Valid XHTML 1.1" height="31" width="88"/>
</a>
<a href="http://jigsaw.w3.org/css-validator/">
<img style="border:0;width:88px;height:31px" src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS!"/>
</a>
<a href="http://www.mozilla.org/products/firefox/">
<img style="border:none; width:110px; height:32px;" src="http://www.spreadfirefox.com/community/images/affiliates/Buttons/110x32/safer.gif" alt="Get Firefox!"/>
</a>
</div>
</div>
</body>
</html>
|
GitWeb