-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsend-patch.html
More file actions
executable file
·1158 lines (1017 loc) · 57.8 KB
/
send-patch.html
File metadata and controls
executable file
·1158 lines (1017 loc) · 57.8 KB
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
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Submit patches</title>
<meta name="generator" content="Org-mode" />
<meta name="author" content="Fabrice Niessen" />
<link rel="stylesheet" type="text/css" href="http://svn/mc/xxx/org-style/trunk/styles/bigblow/css/htmlize.css"/>
<link rel="stylesheet" type="text/css" href="http://svn/mc/xxx/org-style/trunk/styles/bigblow/css/bigblow.css"/>
<link rel="stylesheet" type="text/css" href="http://svn/mc/xxx/org-style/trunk/styles/bigblow/css/hideshow.css"/>
<script type="text/javascript" src="http://svn/mc/xxx/org-style/trunk/styles/bigblow/js/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="http://svn/mc/xxx/org-style/trunk/styles/bigblow/js/jquery-ui-1.10.2.min.js"></script>
<script type="text/javascript" src="http://svn/mc/xxx/org-style/trunk/styles/bigblow/js/jquery.localscroll-min.js"></script>
<script type="text/javascript" src="http://svn/mc/xxx/org-style/trunk/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js"></script>
<script type="text/javascript" src="http://svn/mc/xxx/org-style/trunk/styles/bigblow/js/jquery.zclip.min.js"></script>
<script type="text/javascript" src="http://svn/mc/xxx/org-style/trunk/styles/bigblow/js/bigblow.js"></script>
<script type="text/javascript" src="http://svn/mc/xxx/org-style/trunk/styles/bigblow/js/hideshow.js"></script>
</head>
<body>
<div id="content">
<h1 class="title">Submit patches</h1>
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#orgheadline7">1. Commit guidelines</a>
<ul>
<li><a href="#orgheadline1">1.1. Changes</a></li>
<li><a href="#orgheadline2">1.2. Commit messages</a></li>
<li><a href="#orgheadline3">1.3. Release notes</a></li>
<li><a href="#orgheadline6">1.4. Example</a>
<ul>
<li><a href="#orgheadline4">1.4.1. Commit message</a></li>
<li><a href="#orgheadline5">1.4.2. ChangeLog</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#orgheadline41">2. Code</a>
<ul>
<li><a href="#orgheadline35">2.1. Send patch</a>
<ul>
<li><a href="#orgheadline8">2.1.1. Version number</a></li>
<li><a href="#orgheadline9">2.1.2. Usage</a></li>
<li><a href="#orgheadline14">2.1.3. Configuration</a></li>
<li><a href="#orgheadline18">2.1.4. Helper functions</a></li>
<li><a href="#orgheadline19">2.1.5. Init</a></li>
<li><a href="#orgheadline20">2.1.6. Check current directory</a></li>
<li><a href="#orgheadline21">2.1.7. Get URL of project</a></li>
<li><a href="#orgheadline22">2.1.8. Override settings</a></li>
<li><a href="#orgheadline23">2.1.9. Display changed files</a></li>
<li><a href="#orgheadline24">2.1.10. Display ignored files</a></li>
<li><a href="#orgheadline25">2.1.11. Ask for short log message</a></li>
<li><a href="#orgheadline26">2.1.12. Generate name for patch files</a></li>
<li><a href="#orgheadline27">2.1.13. Make patch file</a></li>
<li><a href="#orgheadline28">2.1.14. Edit log message</a></li>
<li><a href="#orgheadline29">2.1.15. Convert email contents into UTF-8</a></li>
<li><a href="#orgheadline30">2.1.16. Deduce log message for commit</a></li>
<li><a href="#orgheadline31">2.1.17. Deduce subject line for email</a></li>
<li><a href="#orgheadline32">2.1.18. Auto-commit changes</a></li>
<li><a href="#orgheadline33">2.1.19. Auto-send email</a></li>
<li><a href="#orgheadline34">2.1.20. Auto-delete temporary files</a></li>
</ul>
</li>
<li><a href="#orgheadline36">2.2. Display list of files</a></li>
<li><a href="#orgheadline37">2.3. Display changes</a></li>
<li><a href="#orgheadline38">2.4. Ignore files from the command line</a></li>
<li><a href="#orgheadline39">2.5. Unaccent</a></li>
<li><a href="#orgheadline40">2.6. Install environment</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-orgheadline7" class="outline-2">
<h2 id="orgheadline7"><span class="section-number-2">1</span> Commit guidelines</h2>
<div class="outline-text-2" id="text-1">
<p>
This list hopes to help all of us to improve our commits.
</p>
</div>
<div id="outline-container-orgheadline1" class="outline-3">
<h3 id="orgheadline1"><span class="section-number-3">1.1</span> Changes</h3>
<div class="outline-text-3" id="text-1-1">
<ul class="org-ul">
<li>Make commits of logical units.</li>
<li>Check for unnecessary whitespace before committing.</li>
<li>Do not check in commented out code or unneeded files.</li>
<li>Make sure that you have tests for the bug you are fixing.</li>
<li>Make sure that the test suite passes after your commit.</li>
<li>Do not attach your patch, but submit it “inline” in the mail body, <i>unless
you cannot teach your mailer to leave the formatting of the patch alone</i>.</li>
</ul>
</div>
</div>
<div id="outline-container-orgheadline2" class="outline-3">
<h3 id="orgheadline2"><span class="section-number-3">1.2</span> Commit messages</h3>
<div class="outline-text-3" id="text-1-2">
<p>
<a href="http://chris.beams.io/posts/git-commit/">How to Write a Git Commit Message</a>
</p>
<ul class="org-ul">
<li>The first line of the commit message (“<b>subject line</b>”) should be a <b>short
description</b> (50 characters is the <i>soft</i> limit). It should be <b>capitalized</b> and
it should <b>not end with a period</b>.</li>
<li>The body should provide a meaningful commit message, which:
<ul class="org-ul">
<li>uses the active voice in the <b>imperative present tense</b>: “fix bug”, not “fixed
bug” or “fixes bug” – we prefer to describe “what the patch does” rather
than “what the patch did”.</li>
<li>includes motivation for the change (“why”), and contrasts its implementation
with previous behavior.</li>
</ul></li>
</ul>
<p>
Keep in mind that commit messages are often read <b>without</b> seeing the diffs, and
without the possibility to see which other files you committed just before
that particular commit!
</p>
<p>
If the ChangeLog is a one-liner, you can use it as the commit summary.
</p>
<p>
Note for Emacs – It is suggested to write the ChangeLog first and then use <code>C-c
C-a</code> from the <code>*VC-Log*</code> buffer.
</p>
</div>
</div>
<div id="outline-container-orgheadline3" class="outline-3">
<h3 id="orgheadline3"><span class="section-number-3">1.3</span> Release notes</h3>
<div class="outline-text-3" id="text-1-3">
<p>
We have introduced the possibility to insert release notes in log messages. In
order to make them stand out, all such notes must be enclosed in
a <code>#+begin_releasenotes</code> .. <code>#end_releasenotes</code> block.
</p>
</div>
</div>
<div id="outline-container-orgheadline6" class="outline-3">
<h3 id="orgheadline6"><span class="section-number-3">1.4</span> Example</h3>
<div class="outline-text-3" id="text-1-4">
</div><div id="outline-container-orgheadline4" class="outline-4">
<h4 id="orgheadline4"><span class="section-number-4">1.4.1</span> Commit message</h4>
<div class="outline-text-4" id="text-1-4-1">
<p>
By settling on an “official commit log format”:
</p>
<pre class="example">
TITLE
PARAGRAPH-1
PARAGRAPH-2
* FILE (FUNC): DESCRIPTION-OF-CHANGE.
</pre>
<p>
Example:
</p>
<pre class="example">
Summarize changes in around 50 characters or less
More detailed explanatory text, if necessary, to present a bird-eye view that is
hard to grasp by looking at the diffs. Wrap it to about 72 characters or so.
In some contexts, the first line is treated as the subject of an email and the
rest of the text as the body. The blank line separating the summary from the
body is critical; some tools can get confused if you run the two together.
Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequenses of this
change? Here's the place to explain them.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Typically a hyphen is used for the bullet, with blank lines in between, but
conventions vary here
- Use a hanging indent
If you use an issue tracker, put references to them at the bottom, like this:
Resolves: #123
See also: #456, #789
</pre>
</div>
</div>
<div id="outline-container-orgheadline5" class="outline-4">
<h4 id="orgheadline5"><span class="section-number-4">1.4.2</span> ChangeLog</h4>
<div class="outline-text-4" id="text-1-4-2">
<p>
ChangeLog files could be generated from the commit messages:
</p>
<pre class="example">
YYYY-MM-DD AUTHOR <EMAIL>
TITLE
* FILE (FUNC): DESCRIPTION-OF-CHANGE.
</pre>
<p>
(modulo some bol TABs).
</p>
<p>
Though, ChangeLog and commit logs may be orthogonal:
</p>
<ul class="org-ul">
<li>A commit log describes <i>why</i> (and <i>how</i>) code was changed.</li>
<li>A ChangeLog helps you understand <i>where</i> and <i>what</i> code changed.</li>
</ul>
</div>
</div>
</div>
</div>
<div id="outline-container-orgheadline41" class="outline-2">
<h2 id="orgheadline41"><span class="section-number-2">2</span> Code</h2>
<div class="outline-text-2" id="text-2">
</div><div id="outline-container-orgheadline35" class="outline-3">
<h3 id="orgheadline35"><span class="section-number-3">2.1</span> Send patch</h3>
<div class="outline-text-3" id="text-2-1">
<p>
This script sends patches:
</p>
<ul class="org-ul">
<li>to the SVN repository (that is, <i>commits</i> them)</li>
<li>to mailing lists (that is, <i>emails</i> them)</li>
</ul>
</div>
<div id="outline-container-orgheadline8" class="outline-4">
<h4 id="orgheadline8"><span class="section-number-4">2.1.1</span> Version number</h4>
<div class="outline-text-4" id="text-2-1-1">
<div class="org-src-container">
<pre class="src src-emacs-lisp" id="orgsrcblock1">(format-time-string <span class="org-string">"%Y%m%d.%H%M"</span>)
</pre>
</div>
<div class="org-src-container">
<pre class="src src-shell"> cat << EOF
<span class="org-sh-heredoc">This is $(basename $0), version: 20150625.0955.</span>
<span class="org-sh-heredoc">EOF</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orgheadline9" class="outline-4">
<h4 id="orgheadline9"><span class="section-number-4">2.1.2</span> Usage</h4>
<div class="outline-text-4" id="text-2-1-2">
<div class="org-src-container">
<pre class="src src-shell"><span class="org-function-name">Usage</span> ()
{
cat << EOF 1>&2
<span class="org-sh-heredoc">Usage: $(basename $0) [OPTION]... [FILE]...</span>
<span class="org-sh-heredoc">Submit patches per email.</span>
<span class="org-sh-heredoc"> -h, --help display this help and exit</span>
<span class="org-sh-heredoc">Report $(basename $0) bugs to fni@xxx.com</span>
<span class="org-sh-heredoc">Commit guidelines: <a href="http://svn/mc/xxx/sendpatch/trunk/send-patch.html"><http://svn/mc/xxx/sendpatch/trunk/send-patch.html></a></span>
<span class="org-sh-heredoc">EOF</span>
<span class="org-keyword">exit</span> 2
}
<span class="org-keyword">while </span><span class="org-builtin">true</span>; <span class="org-keyword">do</span>
<span class="org-keyword">case</span> <span class="org-string">"$1"</span><span class="org-keyword"> in</span>
-h | --help) Usage ;;
* ) <span class="org-keyword">break</span> ;;
<span class="org-keyword">esac</span>
<span class="org-keyword">done</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">now do something with $@</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orgheadline14" class="outline-4">
<h4 id="orgheadline14"><span class="section-number-4">2.1.3</span> Configuration</h4>
<div class="outline-text-4" id="text-2-1-3">
</div><ol class="org-ol"><li><a id="orgheadline10"></a>Per project options<br /><div class="outline-text-5" id="text-2-1-3-1">
<div class="org-src-container">
<pre class="src src-shell"><span class="org-variable-name">mailto</span>=<span class="org-string">"mc-reviews@xxx.com"</span>
<span class="org-variable-name">prefix</span>=<span class="org-string">"[PATCH]"</span>
<span class="org-variable-name">excludefileregexp</span>=<span class="org-string">""</span>
</pre>
</div>
</div></li>
<li><a id="orgheadline11"></a>Per user options<br /><div class="outline-text-5" id="text-2-1-3-2">
<div class="org-src-container">
<pre class="src src-shell"><span class="org-variable-name">patchfileprefix</span>=<span class="org-string">""</span>
<span class="org-variable-name">commitmsgfileprefix</span>=<span class="org-string">""</span>
<span class="org-variable-name">emailfileprefix</span>=<span class="org-string">""</span>
<span class="org-variable-name">asksubject</span>=<span class="org-string">"yes"</span>
<span class="org-variable-name">autocommit</span>=<span class="org-string">"ask"</span>
<span class="org-variable-name">autosendemail</span>=<span class="org-string">"ask"</span>
<span class="org-variable-name">autodeletetmpfiles</span>=<span class="org-string">"ask"</span>
<span class="org-variable-name">emailcommand</span>=<span class="org-string">'blat "$email" -to "$mailto" -subject "$prefix $subject" -server "mail" -f "John Doe <a href="mailto:johndoe%40example.com"><johndoe@example.com></a>" -charset UTF-8'</span>
</pre>
</div>
</div></li>
<li><a id="orgheadline12"></a>Example<br /><div class="outline-text-5" id="text-2-1-3-3">
<p>
A commonly configured option could be:
</p>
<div class="org-src-container">
<pre class="src src-shell"><span class="org-variable-name">excludefileregexp</span>=<span class="org-string">"(\\\.html|\\\.xml)"</span>
</pre>
</div>
<div class="warning">
<p>
Note the use of <b>3 backslashes</b>!
</p>
</div>
<p>
Other command-line email agents:
</p>
<div class="org-src-container">
<pre class="src src-shell"><span class="org-variable-name">emailcommand</span>=<span class="org-string">'sendemail -s mail -o tls=no -o message-charset=UTF-8 -f "John Doe <a href="mailto:johndoe%40example.com"><johndoe@example.com></a>" -t $mailto -u "$prefix $subject" -o message-file=$email'</span>
</pre>
</div>
</div></li>
<li><a id="orgheadline13"></a>Files<br /><div class="outline-text-5" id="text-2-1-3-4">
<p>
All the <i>default</i> settings can be overridden in:
</p>
<ol class="org-ol">
<li><code>~/.sendpatchrc</code> (global user config),</li>
<li><code>sendpatch.common</code> (project config) in the root directory of a working copy, or</li>
<li><code>sendpatch.params</code> (user config for the project) in the root directory of
a working copy,</li>
</ol>
<p>
in that order.
</p>
<p>
Remember that those configuration files must be encoded with <b>Unix line
endings</b>!
</p>
</div></li></ol>
</div>
<div id="outline-container-orgheadline18" class="outline-4">
<h4 id="orgheadline18"><span class="section-number-4">2.1.4</span> Helper functions</h4>
<div class="outline-text-4" id="text-2-1-4">
<p>
The exit status follows the conventions for programs such as <code>grep</code>, <code>cmp</code>, and
<code>diff</code>:
</p>
<div class="org-src-container">
<pre class="src src-shell"><span class="org-function-name">die</span> () {
printf <span class="org-string">"$(basename $0): $@\n"</span> > /dev/stderr
<span class="org-keyword">exit</span> 2 <span class="org-comment-delimiter"># </span><span class="org-comment">an error occurred</span>
}
</pre>
</div>
<div class="org-src-container">
<pre class="src src-shell"><span class="org-function-name">cecho</span> () {
<span class="org-variable-name">black</span>=<span class="org-string">"\e[30m"</span>
<span class="org-variable-name">red</span>=<span class="org-string">"\e[31m"</span>
<span class="org-variable-name">green</span>=<span class="org-string">"\e[32m"</span>
<span class="org-variable-name">yellow</span>=<span class="org-string">"\e[33m"</span>
<span class="org-variable-name">blue</span>=<span class="org-string">"\e[34m"</span>
<span class="org-variable-name">magenta</span>=<span class="org-string">"\e[35m"</span>
<span class="org-variable-name">cyan</span>=<span class="org-string">"\e[36m"</span>
<span class="org-variable-name">white</span>=<span class="org-string">"\e[37m"</span>
<span class="org-variable-name">BLACK</span>=<span class="org-string">"\e[1;30m"</span>
<span class="org-variable-name">RED</span>=<span class="org-string">"\e[1;31m"</span>
<span class="org-variable-name">GREEN</span>=<span class="org-string">"\e[1;32m"</span>
<span class="org-variable-name">YELLOW</span>=<span class="org-string">"\e[1;33m"</span>
<span class="org-variable-name">BLUE</span>=<span class="org-string">"\e[1;34m"</span>
<span class="org-variable-name">MAGENTA</span>=<span class="org-string">"\e[1;35m"</span>
<span class="org-variable-name">CYAN</span>=<span class="org-string">"\e[1;36m"</span>
<span class="org-variable-name">WHITE</span>=<span class="org-string">"\e[1;37m"</span>
<span class="org-variable-name">reset</span>=<span class="org-string">"\e[0m"</span>
<span class="org-variable-name">color</span>=${<span class="org-variable-name">YELLOW</span>}
printf <span class="org-string">"$color$1$reset\n"</span>
}
</pre>
</div>
</div>
<ol class="org-ol"><li><a id="orgheadline15"></a>VCS in use<br /><div class="outline-text-5" id="text-2-1-4-1">
<div class="org-src-container">
<pre class="src src-shell"><span class="org-function-name">vcs_info</span> () {
<span class="org-builtin">local</span> <span class="org-variable-name">default</span>=<span class="org-string">"tfs"</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">recursively search for `.svn' directory</span>
<span class="org-keyword">while</span> [[ <span class="org-negation-char">!</span> ( -d .svn ) && ( <span class="org-string">"$(pwd)"</span> != <span class="org-string">"/"</span> ) ]]; <span class="org-keyword">do</span>
<span class="org-builtin">cd</span> ..
<span class="org-keyword">done</span>
<span class="org-keyword">if</span> [[ -d .svn ]]; <span class="org-keyword">then</span>
printf <span class="org-string">"svn\n"</span>
<span class="org-keyword">else</span> <span class="org-comment-delimiter"># </span><span class="org-comment">not found</span>
printf <span class="org-string">"$default\n"</span>
<span class="org-keyword">fi</span>
}
</pre>
</div>
</div></li>
<li><a id="orgheadline16"></a>TFS<br /><div class="outline-text-5" id="text-2-1-4-2">
<div class="org-src-container">
<pre class="src src-shell"><span class="org-function-name">fixtfsbinaryfiles</span> () {
sed -r <span class="org-string">"s/^(.*): files differ$/Index: \1\n===================================================================\nCannot display: file marked as a binary type.\n===================================================================/"</span>
}
</pre>
</div>
</div></li>
<li><a id="orgheadline17"></a>Yes/No prompt function<br /><div class="outline-text-5" id="text-2-1-4-3">
<div class="org-src-container">
<pre class="src src-shell"><span class="org-function-name">ask</span> () {
<span class="org-keyword">while </span><span class="org-builtin">true</span>; <span class="org-keyword">do</span>
<span class="org-keyword">if</span> [ <span class="org-string">"${2:-}"</span> = <span class="org-string">"Y"</span> ]; <span class="org-keyword">then</span>
<span class="org-variable-name">prompt</span>=<span class="org-string">"Y/n"</span>
<span class="org-variable-name">default</span>=Y
<span class="org-keyword">elif</span> [ <span class="org-string">"${2:-}"</span> = <span class="org-string">"N"</span> ]; <span class="org-keyword">then</span>
<span class="org-variable-name">prompt</span>=<span class="org-string">"y/N"</span>
<span class="org-variable-name">default</span>=N
<span class="org-keyword">else</span>
<span class="org-variable-name">prompt</span>=<span class="org-string">"y/n"</span>
<span class="org-variable-name">default</span>=
<span class="org-keyword">fi</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">ask the question (without the need to press RET)</span>
printf <span class="org-string">"$1 ($prompt): "</span>
<span class="org-builtin">read</span> -n 1 -r REPLY
printf <span class="org-string">"\n"</span> <span class="org-comment-delimiter"># </span><span class="org-comment">just a final linefeed</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">default?</span>
<span class="org-keyword">if</span> [ -z <span class="org-string">"$REPLY"</span> ]; <span class="org-keyword">then</span>
<span class="org-variable-name">REPLY</span>=$<span class="org-variable-name">default</span>
<span class="org-keyword">fi</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">check if the reply is valid</span>
<span class="org-keyword">case</span> <span class="org-string">"$REPLY"</span><span class="org-keyword"> in</span>
y*|Y*) <span class="org-keyword">return</span> 0 ;;
n*|N*) <span class="org-keyword">return</span> 1 ;;
<span class="org-keyword">esac</span>
<span class="org-keyword">done</span>
}
</pre>
</div>
<p>
See <a href="https://gist.github.com/1965569">usage samples</a> for defaults (when the user presses <code>RET</code> without giving an
answer).
</p>
<p>
See <a href="http://stackoverflow.com/questions/1885525/how-do-i-prompt-a-user-for-confirmation-in-bash-script">How do I prompt a user for confirmation in bash script?</a> for the regexp
match operator “=~”.
</p>
</div></li></ol>
</div>
<div id="outline-container-orgheadline19" class="outline-4">
<h4 id="orgheadline19"><span class="section-number-4">2.1.5</span> Init</h4>
<div class="outline-text-4" id="text-2-1-5">
<div class="org-src-container">
<pre class="src src-shell"><span class="org-variable-name">tmpfile</span>=<span class="org-string">"/tmp/$(basename $0).$$"</span>
<span class="org-keyword">trap</span> <span class="org-string">"rm -f $tmpfile"</span> EXIT SIGHUP SIGINT SIGQUIT SIGTERM
<span class="org-variable-name">userconfig</span>=~/.sendpatchrc
<span class="org-variable-name">projectconfig</span>=sendpatch.common
<span class="org-variable-name">userprojectconfig</span>=sendpatch.params
<span class="org-builtin">export</span> <span class="org-variable-name">vcs</span>=$(vcs_info)
printf <span class="org-string">"VC backend: $vcs\n"</span>
<span class="org-keyword">case</span> $<span class="org-variable-name">vcs</span><span class="org-keyword"> in</span>
svn)
<span class="org-variable-name">VCS_STATUS</span>=<span class="org-string">"svn status --ignore-externals"</span>
;;
tfs)
<span class="org-variable-name">VCS_STATUS</span>=<span class="org-string">"tf status"</span>
;;
*)
die <span class="org-string">"VCS backend is not supported"</span>
;;
<span class="org-keyword">esac</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orgheadline20" class="outline-4">
<h4 id="orgheadline20"><span class="section-number-4">2.1.6</span> Check current directory</h4>
<div class="outline-text-4" id="text-2-1-6">
<p>
Note that, for TFS, we impose to find a <code>sendpatch.common</code> file in order to
conclude that we’re at the root directory of a working copy, or not.
</p>
<div class="org-src-container">
<pre class="src src-shell"><span class="org-keyword">case</span> $<span class="org-variable-name">vcs</span><span class="org-keyword"> in</span>
svn)
[[ -d .svn ]] <span class="org-sh-escaped-newline">\</span>
|| die <span class="org-string">"\`$(pwd)' is not the root directory of a working copy"</span>
;;
tfs)
[[ -f $<span class="org-variable-name">projectconfig</span> ]] <span class="org-sh-escaped-newline">\</span>
|| die <span class="org-string">"\`$(pwd)' is not the root directory of a working copy"</span>
;;
<span class="org-keyword">esac</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orgheadline21" class="outline-4">
<h4 id="orgheadline21"><span class="section-number-4">2.1.7</span> Get URL of project</h4>
<div class="outline-text-4" id="text-2-1-7">
<div class="org-src-container">
<pre class="src src-shell"><span class="org-keyword">case</span> $<span class="org-variable-name">vcs</span><span class="org-keyword"> in</span>
svn)
<span class="org-variable-name">url</span>=$(svn info | grep -E <span class="org-string">"^URL"</span>)/
;;
tfs)
<span class="org-comment-delimiter"># </span><span class="org-comment">get collection and project</span>
tf workfold > $<span class="org-variable-name">tmpfile</span>
<span class="org-variable-name">url</span>=$(cat $<span class="org-variable-name">tmpfile</span> | grep -E <span class="org-string">"^(Collection| \\$/)"</span> | sed <span class="org-string">"/^ \\$/{s/:.*//}"</span>)
;;
<span class="org-keyword">esac</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orgheadline22" class="outline-4">
<h4 id="orgheadline22"><span class="section-number-4">2.1.8</span> Override settings</h4>
<div class="outline-text-4" id="text-2-1-8">
<div class="org-src-container">
<pre class="src src-shell">[[ -f $<span class="org-variable-name">userconfig</span> ]] && . $<span class="org-variable-name">userconfig</span>
[[ -f $<span class="org-variable-name">projectconfig</span> ]] && . $<span class="org-variable-name">projectconfig</span>
[[ -f $<span class="org-variable-name">userprojectconfig</span> ]] && . $<span class="org-variable-name">userprojectconfig</span>
</pre>
</div>
<p>
Default sender of the email is John Doe. If not configured otherwise, bail out:
</p>
<div class="org-src-container">
<pre class="src src-shell">printf <span class="org-string">"$emailcommand"</span> | grep <span class="org-string">"John Doe"</span> <span class="org-sh-escaped-newline">\</span>
&& die <span class="org-string">"Please fix the sender address in the email command"</span>
</pre>
</div>
<p>
Default editor is <code>$EDITOR</code>. If not found, set Emacs:
</p>
<div class="org-src-container">
<pre class="src src-shell">: ${<span class="org-variable-name">EDITOR</span>:=<span class="org-string">"emacsclient"</span>}
<span class="org-builtin">which</span> <span class="org-string">"${EDITOR%% *}"</span> > /dev/null 2>&1 || die <span class="org-string">"editor not found"</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orgheadline23" class="outline-4">
<h4 id="orgheadline23"><span class="section-number-4">2.1.9</span> Display changed files</h4>
<div class="outline-text-4" id="text-2-1-9">
<p>
Shows what files have been modified in your working copy, what files have been
changed in the repository since your last update, and which files, if any,
conflict with your modifications. The <code>-u</code> option is what forces the command to
access the repository for this check.
</p>
<div class="org-src-container">
<pre class="src src-shell">cecho <span class="org-string">"\nChanged files (to be committed now):"</span>
<span class="org-keyword">case</span> $<span class="org-variable-name">vcs</span><span class="org-keyword"> in</span>
svn)
${<span class="org-variable-name">VCS_STATUS</span>} -u $<span class="org-variable-name">@</span> | grep -E -v <span class="org-string">"^\? "</span> | tee $<span class="org-variable-name">tmpfile</span>
cat $<span class="org-variable-name">tmpfile</span> | cut -c 1-9 | grep -E <span class="org-string">"^M \*"</span> <span class="org-sh-escaped-newline">\</span>
&& die <span class="org-string">"a newer revision exists on the server"</span>
cat $<span class="org-variable-name">tmpfile</span> | cut -c 1-9 | grep -E <span class="org-string">"^C"</span> && die <span class="org-string">"conflicted item modification"</span>
;;
tfs)
<span class="org-builtin">export</span> <span class="org-variable-name">rootdirwin</span>=$(cygpath -w -l <span class="org-string">"$(pwd)"</span>)
<span class="org-comment-delimiter"># </span><span class="org-comment">printf "Root directory (in Windows format) : $rootdirwin\n"</span>
${<span class="org-variable-name">VCS_STATUS</span>} $<span class="org-variable-name">@</span> > $<span class="org-variable-name">tmpfile</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">No idea why, but we can't directly pipe the output of `tf status'</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">command</span>
cat $<span class="org-variable-name">tmpfile</span> | grep -F -i <span class="org-string">"$rootdirwin"</span> | tee $<span class="org-variable-name">tmpfile</span>.out
mv $<span class="org-variable-name">tmpfile</span>.out $<span class="org-variable-name">tmpfile</span>
;;
<span class="org-keyword">esac</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orgheadline24" class="outline-4">
<h4 id="orgheadline24"><span class="section-number-4">2.1.10</span> Display ignored files</h4>
<div class="outline-text-4" id="text-2-1-10">
<div class="org-src-container">
<pre class="src src-shell"><span class="org-keyword">case</span> $<span class="org-variable-name">vcs</span><span class="org-keyword"> in</span>
svn)
cecho <span class="org-string">"\nUntracked files:"</span>
${<span class="org-variable-name">VCS_STATUS</span>} $<span class="org-variable-name">@</span> | grep -E <span class="org-string">"^\? "</span> | grep -v <span class="org-string">" 0.*-"</span>
;;
tfs)
;;
<span class="org-keyword">esac</span>
</pre>
</div>
<p>
Stop if no changes are to be committed. Though, that may mean that you should
<code>add</code> some of the files currently ignored; hence, it’s good to make this check
after having sent some information to the user…
</p>
<div class="org-src-container">
<pre class="src src-shell">[[ $(cat $<span class="org-variable-name">tmpfile</span> | wc -l) -gt 0 ]] <span class="org-sh-escaped-newline">\</span>
|| die <span class="org-string">"no changes to send to the repository"</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orgheadline25" class="outline-4">
<h4 id="orgheadline25"><span class="section-number-4">2.1.11</span> Ask for short log message</h4>
<div class="outline-text-4" id="text-2-1-11">
<div class="org-src-container">
<pre class="src src-shell"><span class="org-keyword">if</span> [[ <span class="org-string">"$asksubject"</span> != <span class="org-string">"no"</span> ]]; <span class="org-keyword">then</span>
printf <span class="org-string">"\nSubject (short log): "</span>
<span class="org-builtin">read</span> subject
<span class="org-keyword">fi</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orgheadline26" class="outline-4">
<h4 id="orgheadline26"><span class="section-number-4">2.1.12</span> Generate name for patch files</h4>
<div class="outline-text-4" id="text-2-1-12">
<div class="org-src-container">
<pre class="src src-shell"><span class="org-variable-name">oldcounter</span>=$(ls ${<span class="org-variable-name">patchfileprefix</span>}0???-*.patch 2> /dev/null | sort --reverse <span class="org-sh-escaped-newline">\</span>
| head -n 1 | sed <span class="org-string">"s/^${patchfileprefix}00*//"</span> | cut -d <span class="org-string">"-"</span> -f 1)
<span class="org-variable-name">newcounterpadded</span>=$(printf <span class="org-string">"%04d"</span> <span class="org-string">"$(( oldcounter + 1 ))"</span>)
<span class="org-variable-name">filename</span>=<span class="org-string">"$newcounterpadded-$(printf "$subject\n" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9]/-/g')"</span>
<span class="org-variable-name">patch</span>=${<span class="org-variable-name">patchfileprefix</span>}${<span class="org-variable-name">filename</span>}.patch
<span class="org-variable-name">commitmsg</span>=${<span class="org-variable-name">commitmsgfileprefix</span>}${<span class="org-variable-name">filename</span>}.log
<span class="org-variable-name">email</span>=${<span class="org-variable-name">emailfileprefix</span>}${<span class="org-variable-name">filename</span>}.txt
</pre>
</div>
</div>
</div>
<div id="outline-container-orgheadline27" class="outline-4">
<h4 id="orgheadline27"><span class="section-number-4">2.1.13</span> Make patch file</h4>
<div class="outline-text-4" id="text-2-1-13">
<p>
The patch file generated only reports <code>file.bin: files differ</code>. The fix for
getting such names included in the log (list of modified files) is to replace
that one-sentence with a traditional <code>Index:</code> marker.
</p>
<div class="org-src-container">
<pre class="src src-shell">makediff $<span class="org-variable-name">@</span> > $<span class="org-variable-name">patch</span>.tmp
<span class="org-variable-name">retval</span>=$<span class="org-variable-name">?</span>
<span class="org-keyword">if</span> [ $<span class="org-variable-name">retval</span> -eq 0 ]; <span class="org-keyword">then</span>
cat $<span class="org-variable-name">patch</span>.tmp | fixtfsbinaryfiles > $<span class="org-variable-name">patch</span>
rm $<span class="org-variable-name">patch</span>.tmp
<span class="org-keyword">else</span>
rm $<span class="org-variable-name">patch</span>.tmp
<span class="org-keyword">exit</span> 2
<span class="org-keyword">fi</span>
</pre>
</div>
<p>
<code>excludefileregexp</code> allows one to exclude useless or unreadable diffs from the
email contents. That does not have any impact on the commit process itself…
</p>
<div class="org-src-container">
<pre class="src src-shell"><span class="org-keyword">if</span> [[ -n <span class="org-string">"$excludefileregexp"</span> ]]; <span class="org-keyword">then</span>
cat $<span class="org-variable-name">patch</span> |<span class="org-sh-escaped-newline">\</span>
awk -v <span class="org-variable-name">pattern</span>=<span class="org-string">"^Index: .*$excludefileregexp"</span> <span class="org-sh-escaped-newline">\</span>
<span class="org-string">'BEGIN {deleteline = 0;}</span>
<span class="org-string"> $0 ~ pattern {deleteline = 1; next;}</span>
<span class="org-string"> // && deleteline == 0 {print $0;}</span>
<span class="org-string"> /^Index: / && deleteline == 1 {print $0; deleteline = 0;}'</span> <span class="org-sh-escaped-newline">\</span>
> $<span class="org-variable-name">patch</span>.excluded 2> /dev/null
<span class="org-keyword">else</span>
cp $<span class="org-variable-name">patch</span> $<span class="org-variable-name">patch</span>.excluded
<span class="org-keyword">fi</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orgheadline28" class="outline-4">
<h4 id="orgheadline28"><span class="section-number-4">2.1.14</span> Edit log message</h4>
<div class="outline-text-4" id="text-2-1-14">
<div class="org-src-container">
<pre class="src src-shell"><span class="org-comment-delimiter"># </span><span class="org-comment">ask for commit message</span>
cat <<EOF > $<span class="org-variable-name">email</span>
<span class="org-sh-heredoc"># Hey, Emacs! This is a -*- Diff -*- file</span>
<span class="org-sh-heredoc"># Please enter the commit message for your changes. Lines starting with '#'</span>
<span class="org-sh-heredoc"># will be ignored...</span>
<span class="org-sh-heredoc"># The FIRST LINE of the commit message should be a short description and should</span>
<span class="org-sh-heredoc"># skip the full stop. It will become the subject of the email.</span>
<span class="org-sh-heredoc">EOF</span>
<span class="org-keyword">case</span> $<span class="org-variable-name">vcs</span><span class="org-keyword"> in</span>
svn)
<span class="org-variable-name">makelogparams</span>=<span class="org-string">"$*"</span>
;;
tfs)
<span class="org-variable-name">makelogparams</span>=<span class="org-string">"-f $patch"</span>
;;
<span class="org-keyword">esac</span>
{ printf <span class="org-string">"$subject\n"</span>; makelog $<span class="org-variable-name">makelogparams</span> | sort | uniq; printf <span class="org-string">"\n---\n"</span>; printf <span class="org-string">"$url\n\n"</span>; <span class="org-sh-escaped-newline">\</span>
cat $<span class="org-variable-name">patch</span>.excluded; } >> $<span class="org-variable-name">email</span>
mv $<span class="org-variable-name">patch</span>.excluded $<span class="org-variable-name">patch</span>
printf <span class="org-string">"\nEdit commit log message and email to send to '$mailto'...\n"</span>
$<span class="org-variable-name">EDITOR</span> $<span class="org-variable-name">email</span>
test $<span class="org-variable-name">?</span> -eq 0 || die <span class="org-string">"edit failed"</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">remove comments from editable part</span>
sed <span class="org-string">'0,/^---$/{/^#[^+].*$/d;}'</span> < $<span class="org-variable-name">email</span> > $<span class="org-variable-name">email</span>.nocomment; mv $<span class="org-variable-name">email</span>.nocomment $<span class="org-variable-name">email</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orgheadline29" class="outline-4">
<h4 id="orgheadline29"><span class="section-number-4">2.1.15</span> Convert email contents into UTF-8</h4>
<div class="outline-text-4" id="text-2-1-15">
<div class="org-src-container">
<pre class="src src-shell"><span class="org-comment-delimiter"># </span><span class="org-comment">convert email into UTF-8</span>
<span class="org-keyword">case</span> <span class="org-string">"$(file --brief $email 2> /dev/null | sed 's/unified diff output, //')"</span><span class="org-keyword"> in</span>
UTF-8*)
;;
ASCII*)
;;
ISO-8859*)
printf <span class="org-string">"Character encoding of diff output: ISO-8859... Converting it to UTF-8...\n"</span>
cat $<span class="org-variable-name">email</span> | iconv -c -f ISO-8859-1 -t UTF-8 > $<span class="org-variable-name">tmpfile</span>
mv $<span class="org-variable-name">tmpfile</span> $<span class="org-variable-name">email</span>
;;
*)
printf <span class="org-string">"Potential problems found in email file $email: $(file --brief $email)\n"</span>
ask <span class="org-string">"Continue?"</span> || die <span class="org-string">"exiting..."</span>
;;
<span class="org-keyword">esac</span>
printf <span class="org-string">"Email: $email\n"</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orgheadline30" class="outline-4">
<h4 id="orgheadline30"><span class="section-number-4">2.1.16</span> Deduce log message for commit</h4>
<div class="outline-text-4" id="text-2-1-16">
<div class="org-src-container">
<pre class="src src-shell">sed <span class="org-string">'/^---$/,$d'</span> < $<span class="org-variable-name">email</span> > $<span class="org-variable-name">commitmsg</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orgheadline31" class="outline-4">
<h4 id="orgheadline31"><span class="section-number-4">2.1.17</span> Deduce subject line for email</h4>
<div class="outline-text-4" id="text-2-1-17">
<div class="org-src-container">
<pre class="src src-shell"><span class="org-comment-delimiter"># </span><span class="org-comment">get new subject for email (first line of log message)</span>
head -n 1 $<span class="org-variable-name">email</span> > $<span class="org-variable-name">tmpfile</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">replace accented letters by their unaccented equivalent</span>
<span class="org-keyword">case</span> <span class="org-string">"$(file --brief $tmpfile 2> /dev/null)"</span><span class="org-keyword"> in</span>
UTF-8*)
<span class="org-variable-name">subject</span>=<span class="org-string">"$(cat $tmpfile | iconv -c -f UTF-8 -t ISO-8859-1 | unaccent)"</span>
;;
ISO-8859*|ASCII*)
<span class="org-variable-name">subject</span>=<span class="org-string">"$(cat $tmpfile | unaccent)"</span>
;;
*)
die <span class="org-string">"unknown character encoding: $(file --brief $tmpfile). Did you put the subject as first line?"</span>
;;
<span class="org-keyword">esac</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orgheadline32" class="outline-4">
<h4 id="orgheadline32"><span class="section-number-4">2.1.18</span> Auto-commit changes</h4>
<div class="outline-text-4" id="text-2-1-18">
<div class="org-src-container">
<pre class="src src-shell">printf <span class="org-string">"\n"</span>
<span class="org-keyword">if</span> [[ <span class="org-string">"$autocommit"</span> = <span class="org-string">"ask"</span> ]]; <span class="org-keyword">then</span>
ask <span class="org-string">"Commit?"</span> && <span class="org-variable-name">askcommit</span>=<span class="org-string">"yes"</span> || <span class="org-variable-name">askcommit</span>=<span class="org-string">"no"</span>
<span class="org-keyword">fi</span>
<span class="org-keyword">if</span> [[ <span class="org-string">"$autocommit"</span> = <span class="org-string">"yes"</span> || <span class="org-string">"$askcommit"</span> = <span class="org-string">"yes"</span> ]]; <span class="org-keyword">then</span>
printf <span class="org-string">"Committing...\n"</span>
<span class="org-keyword">case</span> $<span class="org-variable-name">vcs</span><span class="org-keyword"> in</span>
svn)
svn commit --file $<span class="org-variable-name">commitmsg</span> $<span class="org-variable-name">@</span>
;;
tfs)
tf checkin /comment:@$<span class="org-variable-name">commitmsg</span> /noprompt $<span class="org-variable-name">@</span>
;;
<span class="org-keyword">esac</span>
<span class="org-variable-name">rc</span>=$<span class="org-variable-name">?</span>
<span class="org-keyword">else</span>
printf <span class="org-string">"Nothing gets committed...\n"</span>
<span class="org-variable-name">rc</span>=0
<span class="org-keyword">fi</span>
test $<span class="org-variable-name">rc</span> -eq 0 || die <span class="org-string">"commit failed"</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orgheadline33" class="outline-4">
<h4 id="orgheadline33"><span class="section-number-4">2.1.19</span> Auto-send email</h4>
<div class="outline-text-4" id="text-2-1-19">
<div class="org-src-container">
<pre class="src src-shell">printf <span class="org-string">"\n"</span>
<span class="org-keyword">if</span> [[ <span class="org-string">"$autosendemail"</span> = <span class="org-string">"ask"</span> ]]; <span class="org-keyword">then</span>
printf <span class="org-string">"Environment for sending email:\n"</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">print the email command</span>
printf <span class="org-string">"$emailcommand\n"</span>
[[ -f $<span class="org-variable-name">userconfig</span> ]] && grep <span class="org-string">"excludefileregexp"</span> $<span class="org-variable-name">userconfig</span>
[[ -f $<span class="org-variable-name">projectconfig</span> ]] && grep <span class="org-string">"excludefileregexp"</span> $<span class="org-variable-name">projectconfig</span>
[[ -f $<span class="org-variable-name">userprojectconfig</span> ]] && grep <span class="org-string">"excludefileregexp"</span> $<span class="org-variable-name">userprojectconfig</span>
ask <span class="org-string">"Send email?"</span> && <span class="org-variable-name">asksendemail</span>=<span class="org-string">"yes"</span> || <span class="org-variable-name">asksendemail</span>=<span class="org-string">"no"</span>
<span class="org-keyword">fi</span>
<span class="org-keyword">if</span> [[ <span class="org-string">"$autosendemail"</span> = <span class="org-string">"yes"</span> || <span class="org-string">"$asksendemail"</span> = <span class="org-string">"yes"</span> ]]; <span class="org-keyword">then</span>
printf <span class="org-string">"Sending email...\n"</span>
<span class="org-builtin">eval</span> <span class="org-string">"$emailcommand"</span>
<span class="org-variable-name">rc</span>=$<span class="org-variable-name">?</span>
<span class="org-keyword">else</span>
printf <span class="org-string">"Nothing gets sent...\n"</span>
<span class="org-variable-name">rc</span>=0
<span class="org-keyword">fi</span>
test $<span class="org-variable-name">rc</span> -eq 0 || die <span class="org-string">"send email failed"</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-orgheadline34" class="outline-4">
<h4 id="orgheadline34"><span class="section-number-4">2.1.20</span> Auto-delete temporary files</h4>
<div class="outline-text-4" id="text-2-1-20">
<div class="org-src-container">
<pre class="src src-shell">printf <span class="org-string">"\n"</span>
<span class="org-keyword">if</span> [[ <span class="org-string">"$autodeletetmpfiles"</span> = <span class="org-string">"ask"</span> ]]; <span class="org-keyword">then</span>
ask <span class="org-string">"Delete temp files?"</span> && <span class="org-variable-name">askdeletetmpfiles</span>=<span class="org-string">"yes"</span> || <span class="org-variable-name">askdeletetmpfiles</span>=<span class="org-string">"no"</span>
<span class="org-keyword">fi</span>
<span class="org-keyword">if</span> [[ <span class="org-string">"$autodeletetmpfiles"</span> = <span class="org-string">"yes"</span> || <span class="org-string">"$askdeletetmpfiles"</span> = <span class="org-string">"yes"</span> ]]; <span class="org-keyword">then</span>
printf <span class="org-string">"Deleting temp files...\n"</span>
rm $<span class="org-variable-name">patch</span> $<span class="org-variable-name">commitmsg</span> $<span class="org-variable-name">email</span>
<span class="org-variable-name">rc</span>=$<span class="org-variable-name">?</span>
<span class="org-keyword">else</span>
printf <span class="org-string">"Nothing gets deleted...\n"</span>
<span class="org-variable-name">rc</span>=0
<span class="org-keyword">fi</span>
test $<span class="org-variable-name">rc</span> -eq 0 || die <span class="org-string">"delete temp files failed"</span>
<span class="org-comment-delimiter">## </span><span class="org-comment">sendpatch ends here</span>
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-orgheadline36" class="outline-3">
<h3 id="orgheadline36"><span class="section-number-3">2.2</span> Display list of files</h3>
<div class="outline-text-3" id="text-2-2">
<p>
Display a list of files to be committed, for the commit log message.
</p>
<div class="org-src-container">
<pre class="src src-shell"><span class="org-comment-delimiter"># </span><span class="org-comment">Usage: makelog [-f diff-file] [svn diff options]</span>
<span class="org-comment-delimiter">#</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">Make a log message for a change, including the header, and the relative</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">pathnames of the changed files. Output goes to stdout.</span>
<span class="org-comment-delimiter">#</span>
<span class="org-comment-delimiter"># </span><span class="org-comment">If a you have a pre-existing diff file, use `-f diff-file' to use this file.</span>
printf <span class="org-string">"\n"</span>
{ <span class="org-keyword">if</span> [ <span class="org-string">"$1"</span> = <span class="org-string">"-f"</span> ]
<span class="org-keyword">then</span>
cat $<span class="org-variable-name">2</span>
<span class="org-keyword">else</span>
svn diff -x -w --no-diff-deleted --show-copies-as-adds $<span class="org-variable-name">*</span> 2>&1
<span class="org-keyword">fi</span>; } | sed <span class="org-string">'/^Index:/!d'</span> | sed <span class="org-string">'s/^Index: /\t* /'</span> | sed <span class="org-string">'s/$/:/'</span>
</pre>
</div>
<p>
With the option <code>--show-copies-as-adds</code>, copied (and moved) files are listed.
</p>
<p>
Using <code>sed '/^Index:/!d'</code> (instead of <code>egrep "^Index:"</code>) allows to filter the lines
we’re interested in, even if the file contains binary characters (such as
non-breakable spaces). On the other hand, <code>grep</code> would simply declare that
“Binary file matches”.
</p>
</div>
</div>