Repository navigation
Expand file tree
/
Copy pathscons-time-man.html
More file actions
1302 lines (1297 loc) · 47.4 KB
/
Copy pathscons-time-man.html
File metadata and controls
1302 lines (1297 loc) · 47.4 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
<html>
<head>
<title>SCONS-TIME</title>
<link rel="stylesheet" type="text/css" href="scons.css"/>
<meta name="generator" content="text/html; charset=UTF-8" http-equiv="Content-Type"/>
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="refentry" title="SCONS-TIME">
<a name="sconstime1"/>
<div class="titlepage"/>
<div class="refnamediv">
<a name="name"/>
<h2>Name</h2>
<p>scons-time — generate and display SCons timing information</p>
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="synopsis"/>
<h2>Synopsis</h2>
<div class="cmdsynopsis">
<p><code class="command">scons-time</code> <em class="replaceable"><code>subcommand</code></em> [<em class="replaceable"><code>options</code></em>...] [<em class="replaceable"><code>arguments</code></em>...]</p>
</div>
</div>
<div class="refsect1" title="Generating Timing Information">
<a name="generating_timing_information"/>
<h2>Generating Timing Information</h2>
<p><span class="bold"><strong>scons-time run</strong></span>
[<code class="option">-hnqv</code>]
[<code class="option">-f </code><span class="emphasis"><em>FILE</em></span>]
[<code class="option">--number=</code><em class="replaceable"><code>NUMBER</code></em>]
[<code class="option">--outdir=</code><em class="replaceable"><code>OUTDIR</code></em>]
[<code class="option">-p </code><span class="emphasis"><em>STRING</em></span>]
[<code class="option">--python=</code><em class="replaceable"><code>PYTHON</code></em>]
[<code class="option">-s </code><span class="emphasis"><em>DIR</em></span>]
[<code class="option">--scons=</code><em class="replaceable"><code>SCONS</code></em>]
[<code class="option">--svn=</code><em class="replaceable"><code>URL</code></em>]
[<span class="emphasis"><em>ARGUMENTS</em></span>]</p>
<div class="refsect2" title="Extracting Function Timings">
<a name="extracting_function_timings"/>
<h3>Extracting Function Timings</h3>
<p><span class="bold"><strong>scons-time func</strong></span>
[<code class="option">-h</code>]
[<code class="option">--chdir=</code><em class="replaceable"><code>DIR</code></em>]
[<code class="option">-f </code><span class="emphasis"><em>FILE</em></span>]
[<code class="option">--fmt=</code><em class="replaceable"><code>FORMAT</code></em>]
[<code class="option">--func=</code><em class="replaceable"><code>NAME</code></em>]
[<code class="option">-p </code><span class="emphasis"><em>STRING</em></span>]
[<code class="option">-t </code><span class="emphasis"><em>NUMBER</em></span>]
[<code class="option">--title= TITLE</code>]
[<span class="emphasis"><em>ARGUMENTS</em></span>]</p>
</div>
<div class="refsect2" title="Extracting Memory Statistics">
<a name="extracting_memory_statistics"/>
<h3>Extracting Memory Statistics</h3>
<p><span class="bold"><strong>scons-time mem</strong></span>
[<code class="option">-h</code>]
[<code class="option">--chdir=</code><em class="replaceable"><code>DIR</code></em>]
[<code class="option">-f </code><span class="emphasis"><em>FILE</em></span>]
[<code class="option">--fmt=</code><em class="replaceable"><code>FORMAT</code></em>]
[<code class="option">-p </code><span class="emphasis"><em>STRING</em></span>]
[<code class="option">--stage=</code><em class="replaceable"><code>STAGE</code></em>]
[<code class="option">-t </code><span class="emphasis"><em>NUMBER</em></span>]
[<code class="option">--title=</code><em class="replaceable"><code>TITLE</code></em>]
[<span class="emphasis"><em>ARGUMENTS</em></span>]</p>
</div>
<div class="refsect2" title="Extracting Object Counts">
<a name="extracting_object_counts"/>
<h3>Extracting Object Counts</h3>
<p><span class="bold"><strong>scons-time obj</strong></span>
[<code class="option">-h</code>]
[<code class="option">--chdir=</code><em class="replaceable"><code>DIR</code></em>]
[<code class="option">-f </code><span class="emphasis"><em>FILE</em></span>]
[<code class="option">--fmt=</code><em class="replaceable"><code>FORMAT</code></em>]
[<code class="option">-p </code><span class="emphasis"><em>STRING</em></span>]
[<code class="option">--stage=</code><em class="replaceable"><code>STAGE</code></em>]
[<code class="option">-t </code><span class="emphasis"><em>NUMBER</em></span>]
[<code class="option">--title=</code><em class="replaceable"><code>TITLE</code></em>]
[<span class="emphasis"><em>ARGUMENTS</em></span>]</p>
</div>
<div class="refsect2" title="Extracting Execution Times">
<a name="extracting_execution_times"/>
<h3>Extracting Execution Times</h3>
<p><span class="bold"><strong>scons-time time</strong></span>
[<code class="option">-h</code>]
[<code class="option">--chdir=</code><em class="replaceable"><code>DIR</code></em>]
[<code class="option">-f </code><span class="emphasis"><em>FILE</em></span>]
[<code class="option">--fmt=</code><em class="replaceable"><code>FORMAT</code></em>]
[<code class="option">-p </code><span class="emphasis"><em>STRING</em></span>]
[<code class="option">-t </code><span class="emphasis"><em>NUMBER</em></span>]
[<code class="option">--title=</code><em class="replaceable"><code>TITLE</code></em>]
[<code class="option">--which=</code><em class="replaceable"><code>WHICH</code></em>]
[<span class="emphasis"><em>ARGUMENTS</em></span>]</p>
</div>
<div class="refsect2" title="Help Text">
<a name="help_text"/>
<h3>Help Text</h3>
<p><span class="bold"><strong>scons-time help</strong></span>
<span class="emphasis"><em>SUBCOMMAND</em></span>
[...]</p>
</div>
</div>
<div class="refsect1" title="DESCRIPTION">
<a name="description"/>
<h2>DESCRIPTION</h2>
<p>The
<span class="command"><strong>scons-time</strong></span>
command runs an SCons configuration
through a standard set of profiled timings
and can extract and graph information from the
resulting profiles and log files of those timings.
The action to be performed by the
<span class="command"><strong>scons-time</strong></span>
script is specified
by a subcommand, the first argument on the command line.
See the
<a class="link" href="#subcommands" title="SUBCOMMANDS">SUBCOMMANDS</a>
section below for information about the operation
of specific subcommands.</p>
<p>The basic way to use
<span class="command"><strong>scons-time</strong></span>
is to run the
<span class="bold"><strong>scons-time run</strong></span>
subcommand
(possibly multiple times)
to generate profile and log file output,
and then use one of the other
subcommands to display the results
captured in the profiles and log files
for a particular kind of information:
function timings
(the
<span class="bold"><strong>scons-time func</strong></span>
subcommand),
total memory used
(the
<span class="bold"><strong>scons-time mem</strong></span>
subcommand),
object counts
(the
<span class="bold"><strong>scons-time obj</strong></span>
subcommand)
and overall execution time
(the
<span class="bold"><strong>scons-time time</strong></span>
subcommand).
Options exist to place and find the
profiles and log files in separate directories,
to generate the output in a format suitable
for graphing with the
<span class="citerefentry"><span class="refentrytitle">gnuplot</span>(1)</span>
program,
and so on.</p>
<p>There are two basic ways the
<span class="bold"><strong>scons-time run</strong></span>
subcommand
is intended to be used
to gather timing statistics
for a configuration.
One is to use the
<code class="option">--svn=</code>
option to test a configuration against
a list of revisions from the SCons Subversion repository.
This will generate a profile and timing log file
for every revision listed with the
<code class="option">--number=</code>
option,
and can be used to look at the
impact of committed changes to the
SCons code base on a particular
configuration over time.</p>
<p>The other way is to profile incremental changes to a
local SCons code base during a development cycle--that is,
to look at the performance impact of changes
you're making in the local tree.
In this mode,
you run the
<span class="bold"><strong>scons-time run</strong></span>
subcommand
<span class="emphasis"><em>without</em></span>
the
<code class="option">--svn=</code>
option,
in which case it simply looks in the profile/log file output directory
(the current directory by default)
and automatically figures out the
<span class="emphasis"><em>next</em></span>
run number for the output profile and log file.
Used in this way,
the development cycle goes something like:
make a change to SCons;
run
<span class="bold"><strong>scons-time run</strong></span>
to profile it against a specific configuration;
make another change to SCons;
run
<span class="bold"><strong>scons-time run</strong></span>
again to profile it;
etc.</p>
</div>
<div class="refsect1" title="OPTIONS">
<a name="options"/>
<h2>OPTIONS</h2>
<p>The
<span class="command"><strong>scons-time</strong></span>
command only supports a few global options:</p>
<div class="variablelist">
<dl>
<dt>
<span class="term">-h, --help</span>
</dt>
<dd>
<p>Displays the global help text and exits,
identical to the
<span class="bold"><strong>scons-time help</strong></span>
subcommand.</p>
</dd>
<dt>
<span class="term">-V, --version</span>
</dt>
<dd>
<p>Displays the
<span class="command"><strong>scons-time</strong></span>
version and exits.</p>
</dd>
</dl>
</div>
<p>Most functionality is controlled by options
to the individual subcommands.
See the next section for information
about individual subcommand options.</p>
</div>
<div class="refsect1" title="SUBCOMMANDS">
<a name="subcommands"/>
<h2>SUBCOMMANDS</h2>
<p>The
<span class="command"><strong>scons-time</strong></span>
command supports the following
individual subcommands.</p>
<div class="refsect2" title="The func Subcommand">
<a name="the_func_subcommand"/>
<h3>The func Subcommand</h3>
<p><span class="bold"><strong>scons-time func</strong></span>
[<code class="option">-h</code>]
[<code class="option">--chdir=</code><em class="replaceable"><code>DIR</code></em>]
[<code class="option">-f </code><span class="emphasis"><em>FILE</em></span>]
[<code class="option">--fmt=</code><em class="replaceable"><code>FORMAT</code></em>]
[<code class="option">--func=</code><em class="replaceable"><code>NAME</code></em>]
[<code class="option">-p </code><span class="emphasis"><em>STRING</em></span>]
[<code class="option">-t </code><span class="emphasis"><em>NUMBER</em></span>]
[<code class="option">--title= TITLE</code>]
[<span class="emphasis"><em>ARGUMENTS</em></span>]</p>
<p>The
<span class="bold"><strong>scons-time func</strong></span>
subcommand displays timing information
for a specific Python function within SCons.
By default, it extracts information about the
<span class="bold"><strong>_main</strong></span>()
function,
which includes the Python profiler timing
for all of SCons.</p>
<p>The
<span class="bold"><strong>scons-time func</strong></span>
subcommand extracts function timing information
from all the specified file arguments,
which should be Python profiler output files.
(Normally, these would be
<span class="bold"><strong>*.prof</strong></span>
files generated by the
<span class="bold"><strong>scons-time run</strong></span>
subcommand,
but they can actually be generated
by any Python profiler invocation.)
All file name arguments will be
globbed for on-disk files.</p>
<p>If no arguments are specified,
then function timing information
will be extracted from all
<span class="bold"><strong>*.prof</strong></span>
files,
or the subset of them
with a prefix specified by the
<code class="option">-p</code>
option.</p>
<p>Options include:</p>
<div class="variablelist">
<dl>
<dt>
<span class="term">-C DIRECTORY, --chdir=DIRECTORY</span>
</dt>
<dd>
<p>Changes to the specified
<span class="emphasis"><em>DIRECTORY</em></span>
before looking for the specified files
(or files that match the specified patterns).</p>
</dd>
<dt>
<span class="term">-f FILE, --file=FILE</span>
</dt>
<dd>
<p>Reads configuration information from the specified
<span class="emphasis"><em>FILE</em></span>.</p>
</dd>
<dt>
<span class="term">-fmt=FORMAT, --format=FORMAT</span>
</dt>
<dd>
<p>Reports the output in the specified
<span class="emphasis"><em>FORMAT</em></span>.
The formats currently supported are
<span class="bold"><strong>ascii</strong></span>
(the default)
and
<span class="bold"><strong>gnuplot</strong></span>.</p>
</dd>
<dt>
<span class="term">--func=NAME</span>
</dt>
<dd>
<p>Extracts timings for the specified function
<span class="emphasis"><em>NAME</em></span>.
The default is to report cumulative timings for the
<span class="bold"><strong>_main</strong></span>()
function,
which contains the entire SCons run.</p>
</dd>
<dt>
<span class="term">-h, --help</span>
</dt>
<dd>
<p>Displays help text for the
<span class="bold"><strong>scons-time func</strong></span>
subcommand.</p>
</dd>
<dt>
<span class="term">-p STRING, --prefix=STRING</span>
</dt>
<dd>
<p>Specifies the prefix string for profiles
from which to extract function timing information.
This will be used to search for profiles
if no arguments are specified on the command line.</p>
</dd>
<dt>
<span class="term">-t NUMBER, --tail=NUMBER</span>
</dt>
<dd>
<p>Only extracts function timings from the last
<span class="emphasis"><em>NUMBER</em></span>
files.</p>
</dd>
</dl>
</div>
</div>
<div class="refsect2" title="The help Subcommand">
<a name="the_help_subcommand"/>
<h3>The help Subcommand</h3>
<p><span class="bold"><strong>scons-time help</strong></span>
<span class="emphasis"><em>SUBCOMMAND</em></span>
[...]
The
<span class="bold"><strong>help</strong></span>
subcommand prints help text for any
other subcommands listed as later arguments on the command line.</p>
</div>
<div class="refsect2" title="The mem Subcommand">
<a name="the_mem_subcommand"/>
<h3>The mem Subcommand</h3>
<p><span class="bold"><strong>scons-time mem</strong></span>
[<code class="option">-h</code>]
[<code class="option">--chdir=</code><em class="replaceable"><code>DIR</code></em>]
[<code class="option">-f </code><span class="emphasis"><em>FILE</em></span>]
[<code class="option">--fmt=</code><em class="replaceable"><code>FORMAT</code></em>]
[<code class="option">-p </code><span class="emphasis"><em>STRING</em></span>]
[<code class="option">--stage=</code><em class="replaceable"><code>STAGE</code></em>]
[<code class="option">-t </code><span class="emphasis"><em>NUMBER</em></span>]
[<code class="option">--title=</code><em class="replaceable"><code>TITLE</code></em>]
[<span class="emphasis"><em>ARGUMENTS</em></span>]</p>
<p>The
<span class="bold"><strong>scons-time mem</strong></span>
subcommand displays how much memory SCons uses.</p>
<p>The
<span class="bold"><strong>scons-time mem</strong></span>
subcommand extracts memory use information
from all the specified file arguments,
which should be files containing output from
running SCons with the
<code class="option">--debug=memory</code>
option.
(Normally, these would be
<span class="bold"><strong>*.log</strong></span>
files generated by the
<span class="bold"><strong>scons-time run</strong></span>
subcommand.)
All file name arguments will be
globbed for on-disk files.</p>
<p>If no arguments are specified,
then memory information
will be extracted from all
<span class="bold"><strong>*.log</strong></span>
files,
or the subset of them
with a prefix specified by the
<code class="option">-p</code>
option.</p>
<div class="variablelist">
<dl>
<dt>
<span class="term">-C DIR, --chdir=DIR</span>
</dt>
<dd>
<p>Changes to the specified
<span class="emphasis"><em>DIRECTORY</em></span>
before looking for the specified files
(or files that match the specified patterns).</p>
</dd>
<dt>
<span class="term">-f FILE, --file=FILE</span>
</dt>
<dd>
<p>Reads configuration information from the specified
<span class="emphasis"><em>FILE</em></span>.</p>
</dd>
<dt>
<span class="term">-fmt=FORMAT, --format=FORMAT</span>
</dt>
<dd>
<p>Reports the output in the specified
<span class="emphasis"><em>FORMAT</em></span>.
The formats currently supported are
<span class="bold"><strong>ascii</strong></span>
(the default)
and
<span class="bold"><strong>gnuplot</strong></span>.</p>
</dd>
<dt>
<span class="term">-h, --help</span>
</dt>
<dd>
<p>Displays help text for the
<span class="bold"><strong>scons-time mem</strong></span>
subcommand.</p>
</dd>
<dt>
<span class="term">-p STRING, --prefix=STRING</span>
</dt>
<dd>
<p>Specifies the prefix string for log files
from which to extract memory usage information.
This will be used to search for log files
if no arguments are specified on the command line.</p>
</dd>
<dt>
<span class="term">--stage=STAGE</span>
</dt>
<dd>
<p>Prints the memory used at the end of the specified
<span class="emphasis"><em>STAGE</em></span>:
<span class="bold"><strong>pre-read</strong></span>
(before the SConscript files are read),
<span class="bold"><strong>post-read ,</strong></span>
(after the SConscript files are read),
<span class="bold"><strong>pre-build</strong></span>
(before any targets are built)
or
<span class="bold"><strong>post-build</strong></span>
(after any targets are built).
If no
<code class="option">--stage</code>
option is specified,
the default behavior is
<span class="bold"><strong>post-build</strong></span>,
which reports the final amount of memory
used by SCons during each run.</p>
</dd>
<dt>
<span class="term">-t NUMBER, --tail=NUMBER</span>
</dt>
<dd>
<p>Only reports memory statistics from the last
<span class="emphasis"><em>NUMBER</em></span>
files.</p>
</dd>
</dl>
</div>
</div>
<div class="refsect2" title="The obj Subcommand">
<a name="the_obj_subcommand"/>
<h3>The obj Subcommand</h3>
<p><span class="bold"><strong>scons-time obj</strong></span>
[<code class="option">-h</code>]
[<code class="option">--chdir=</code><em class="replaceable"><code>DIR</code></em>]
[<code class="option">-f </code><span class="emphasis"><em>FILE</em></span>]
[<code class="option">--fmt=</code><em class="replaceable"><code>FORMAT</code></em>]
[<code class="option">-p </code><span class="emphasis"><em>STRING</em></span>]
[<code class="option">--stage=</code><em class="replaceable"><code>STAGE</code></em>]
[<code class="option">-t </code><span class="emphasis"><em>NUMBER</em></span>]
[<code class="option">--title=</code><em class="replaceable"><code>TITLE</code></em>]
[<span class="emphasis"><em>ARGUMENTS</em></span>]</p>
<p>The
<span class="bold"><strong>scons-time obj</strong></span>
subcommand displays how many objects of a specific named type
are created by SCons.</p>
<p>The
<span class="bold"><strong>scons-time obj</strong></span>
subcommand extracts object counts
from all the specified file arguments,
which should be files containing output from
running SCons with the
<code class="option">--debug=count</code>
option.
(Normally, these would be
<span class="bold"><strong>*.log</strong></span>
files generated by the
<span class="bold"><strong>scons-time run</strong></span>
subcommand.)
All file name arguments will be
globbed for on-disk files.</p>
<p>If no arguments are specified,
then object counts
will be extracted from all
<span class="bold"><strong>*.log</strong></span>
files,
or the subset of them
with a prefix specified by the
<code class="option">-p</code>
option.</p>
<div class="variablelist">
<dl>
<dt>
<span class="term">-C DIR, --chdir=DIR</span>
</dt>
<dd>
<p>Changes to the specified
<span class="emphasis"><em>DIRECTORY</em></span>
before looking for the specified files
(or files that match the specified patterns).</p>
</dd>
<dt>
<span class="term">-f FILE, --file=FILE</span>
</dt>
<dd>
<p>Reads configuration information from the specified
<span class="emphasis"><em>FILE</em></span>.</p>
</dd>
<dt>
<span class="term">-fmt=FORMAT, --format=FORMAT</span>
</dt>
<dd>
<p>Reports the output in the specified
<span class="emphasis"><em>FORMAT</em></span>.
The formats currently supported are
<span class="bold"><strong>ascii</strong></span>
(the default)
and
<span class="bold"><strong>gnuplot</strong></span>.</p>
</dd>
<dt>
<span class="term">-h, --help</span>
</dt>
<dd>
<p>Displays help text for the
<span class="bold"><strong>scons-time obj</strong></span>
subcommand.</p>
</dd>
<dt>
<span class="term">-p STRING, --prefix=STRING</span>
</dt>
<dd>
<p>Specifies the prefix string for log files
from which to extract object counts.
This will be used to search for log files
if no arguments are specified on the command line.</p>
</dd>
<dt>
<span class="term">--stage=STAGE</span>
</dt>
<dd>
<p>Prints the object count at the end of the specified
<span class="emphasis"><em>STAGE</em></span>:
<span class="bold"><strong>pre-read</strong></span>
(before the SConscript files are read),
<span class="bold"><strong>post-read ,</strong></span>
(after the SConscript files are read),
<span class="bold"><strong>pre-build</strong></span>
(before any targets are built)
or
<span class="bold"><strong>post-build</strong></span>
(after any targets are built).
If no
<code class="option">--stage</code>
option is specified,
the default behavior is
<span class="bold"><strong>post-build</strong></span>,
which reports the final object count during each run.</p>
</dd>
<dt>
<span class="term">-t NUMBER, --tail=NUMBER</span>
</dt>
<dd>
<p>Only reports object counts from the last
<span class="emphasis"><em>NUMBER</em></span>
files.</p>
</dd>
</dl>
</div>
</div>
<div class="refsect2" title="The run Subcommand">
<a name="the_run_subcommand"/>
<h3>The run Subcommand</h3>
<p><span class="bold"><strong>scons-time run</strong></span>
[<code class="option">-hnqv</code>]
[<code class="option">-f </code><span class="emphasis"><em>FILE</em></span>]
[<code class="option">--number=</code><em class="replaceable"><code>NUMBER</code></em>]
[<code class="option">--outdir=</code><em class="replaceable"><code>OUTDIR</code></em>]
[<code class="option">-p </code><span class="emphasis"><em>STRING</em></span>]
[<code class="option">--python=</code><em class="replaceable"><code>PYTHON</code></em>]
[<code class="option">-s </code><span class="emphasis"><em>DIR</em></span>]
[<code class="option">--scons=</code><em class="replaceable"><code>SCONS</code></em>]
[<code class="option">--svn=</code><em class="replaceable"><code>URL</code></em>]
[<span class="emphasis"><em>ARGUMENTS</em></span>]
The
<span class="bold"><strong>scons-time run</strong></span>
subcommand is the basic subcommand
for profiling a specific configuration
against a version of SCons.</p>
<p>The configuration to be tested
is specified as a list of files
or directories that will be unpacked or copied
into a temporary directory
in which SCons will be invoked.
The
<span class="bold"><strong>scons-time run</strong></span>
subcommand understands file suffixes like
<span class="markup">.tar</span>,
<span class="markup">.tar.gz</span>,
<span class="markup">.tgz</span>
and
<span class="markup">.zip</span>
and will unpack their contents into a temporary directory.
If more than one argument is specified,
each one will be unpacked or copied
into the temporary directory "on top of"
the previous archives or directories,
so the expectation is that multiple
specified archives share the same directory layout.</p>
<p>Once the file or directory arguments are unpacked or
copied to the temporary directory,
the
<span class="bold"><strong>scons-time run</strong></span>
subcommand runs the
requested version of SCons
against the configuration
three times:</p>
<div class="variablelist">
<dl>
<dt>
<span class="term">Startup</span>
</dt>
<dd>
<p>SCons is run with the
<code class="option">--help</code>
option so that just the SConscript files are read,
and then the default help text is printed.
This profiles just the perceived "overhead" of starting up SCons
and processing the SConscript files.</p>
</dd>
<dt>
<span class="term">Full build</span>
</dt>
<dd>
<p>SCons is run to build everything specified in the configuration.
Specific targets to be passed in on the command line
may be specified by the
<span class="bold"><strong>targets</strong></span>
keyword in a configuration file; see below for details.</p>
</dd>
<dt>
<span class="term">Rebuild</span>
</dt>
<dd>
<p>SCons is run again on the same just-built directory.
If the dependencies in the SCons configuration are correct,
this should be an up-to-date, "do nothing" rebuild.</p>
</dd>
</dl>
</div>
<p>Each invocation captures the output log file and a profile.</p>
<p>The
<span class="bold"><strong>scons-time run</strong></span>
subcommand supports the following options:</p>
<div class="variablelist">
<dl>
<dt>
<span class="term">-f FILE, --file=FILE</span>
</dt>
<dd>
<p>Reads configuration information from the specified
<span class="emphasis"><em>FILE</em></span>.
This often provides a more convenient way to specify and
collect parameters associated with a specific timing configuration
than specifying them on the command line.
See the
<a class="link" href="#configuration_file" title="CONFIGURATION FILE">CONFIGURATION FILE</a>
section below
for information about the configuration file parameters.</p>
</dd>
<dt>
<span class="term">-h, --help</span>
</dt>
<dd>
<p>Displays help text for the
<span class="bold"><strong>scons-time run</strong></span>
subcommand.</p>
</dd>
<dt>
<span class="term">-n, --no-exec</span>
</dt>
<dd>
<p>Do not execute commands,
just printing the command-line equivalents of what would be executed.
Note that the
<span class="command"><strong>scons-time</strong></span>
script actually executes its actions in Python,
where possible,
for portability.
The commands displayed are UNIX
<span class="emphasis"><em>equivalents</em></span>
of what it's doing.</p>
</dd>
<dt>
<span class="term">--number=NUMBER</span>
</dt>
<dd>
<p>Specifies the run number to be used in the names of
the log files and profile outputs generated by this run.</p>
</dd>
</dl>
</div>
<p>When used in conjunction with the
<code class="option">--svn=</code><em class="replaceable"><code>URL</code></em>
option,
<span class="emphasis"><em>NUMBER</em></span>
specifies one or more comma-separated Subversion revision numbers
that will be retrieved automatically from the Subversion
repository at the specified
<span class="emphasis"><em>URL</em></span>.
Ranges of delta or revision numbers
may be specified be separating two numbers
with a hyphen
(<span class="bold"><strong>-</strong></span>).</p>
<p>Example:</p>
<pre class="literallayout">
% scons-time run --svn=<a class="ulink" href="http://scons.tigris.org/svn/trunk" target="_top">http://scons.tigris.org/svn/trunk</a> --num=1247,1249-1252 .
</pre>
<div class="variablelist">
<dl>
<dt>
<span class="term">-p STRING, --prefix=STRING</span>
</dt>
<dd>
<p>Specifies the prefix string to be used for all of the log files
and profiles generated by this run.
The default is derived from the first
specified argument:
if the first argument is a directory,
the default prefix is the name of the directory;
if the first argument is an archive
(tar or zip file),
the default prefix is the base name of the archive,
that is, what remains after stripping the archive suffix
(<span class="markup">.tgz</span>, <span class="markup">.tar.gz</span> or <span class="markup">.zip</span>).</p>
</dd>
<dt>
<span class="term">--python=PYTHON</span>
</dt>
<dd>
<p>Specifies a path to the Python executable to be used
for the timing runs.
The default is to use the same Python executable that
is running the
<span class="command"><strong>scons-time</strong></span>
command itself.</p>
</dd>
<dt>
<span class="term">-q, --quiet</span>
</dt>
<dd>
<p>Suppresses display of the command lines being executed.</p>
</dd>
<dt>
<span class="term">-s DIR, --subdir=DIR</span>
</dt>
<dd>
<p>Specifies the name of directory or subdirectory
from which the commands should be executed.
The default is XXX</p>
</dd>
<dt>
<span class="term">--scons=SCONS</span>
</dt>
<dd>
<p>Specifies a path to the SCons script to be used
for the timing runs.
The default is XXX</p>
</dd>
<dt>
<span class="term">--svn=URL, --subversion=URL</span>
</dt>
<dd>
<p>Specifies the
<span class="emphasis"><em>URL</em></span>
of the Subversion repository from which the
version(s) of
<span class="bold"><strong>scons</strong></span>
being timed will be extracted.
When
<code class="option">--svn</code>
is specified, the
<code class="option">--number=</code><em class="replaceable"><code>NUMBER</code></em>
option specifies revision numbers
that will be tested.
Output from each invocation run will be placed in file
names that match the Subversion revision numbers.
If the
<code class="option">--number=</code>
option is not specified,
then the default behavior is to time the
<span class="bold"><strong>HEAD</strong></span>
of the specified
<span class="emphasis"><em>URL</em></span>.</p>
</dd>
<dt>
<span class="term">-v, --verbose</span>
</dt>
<dd>
<p>Displays the output from individual commands to the screen
(in addition to capturing the output in log files).</p>
</dd>
</dl>
</div>
</div>
<div class="refsect2" title="The time Subcommand">
<a name="the_time_subcommand"/>
<h3>The time Subcommand</h3>
<p><span class="bold"><strong>scons-time time</strong></span>
[<code class="option">-h</code>]
[<code class="option">--chdir=</code><em class="replaceable"><code>DIR</code></em>]
[<code class="option">-f </code><span class="emphasis"><em>FILE</em></span>]
[<code class="option">--fmt=</code><em class="replaceable"><code>FORMAT</code></em>]
[<code class="option">-p </code><span class="emphasis"><em>STRING</em></span>]
[<code class="option">-t </code><span class="emphasis"><em>NUMBER</em></span>]
[<code class="option">--title=</code><em class="replaceable"><code>TITLE</code></em>]
[<code class="option">--which=</code><em class="replaceable"><code>WHICH</code></em>]
[<span class="emphasis"><em>ARGUMENTS</em></span>]</p>
<p>The
<span class="bold"><strong>scons-time time</strong></span>
subcommand displays SCons execution times
as reported by the
<strong class="userinput"><code>scons --debug=time</code></strong>
option.</p>
<p>The
<span class="bold"><strong>scons-time time</strong></span>
subcommand extracts SCons timing
from all the specified file arguments,
which should be files containing output from
running SCons with the
<code class="option">--debug=time</code>
option.
(Normally, these would be
<span class="bold"><strong>*.log</strong></span>
files generated by the
<span class="bold"><strong>scons-time run</strong></span>
subcommand.)
All file name arguments will be
globbed for on-disk files.</p>
<p>If no arguments are specified,
then execution timings
will be extracted from all
<span class="bold"><strong>*.log</strong></span>
files,
or the subset of them
with a prefix specified by the
<code class="option">-p</code>
option.</p>
<div class="variablelist">
<dl>
<dt>
<span class="term">-C DIR, --chdir=DIR</span>
</dt>
<dd>
<p>Changes to the specified
<span class="emphasis"><em>DIRECTORY</em></span>
before looking for the specified files
(or files that match the specified patterns).</p>
</dd>
<dt>
<span class="term">-f FILE, --file=FILE</span>
</dt>
<dd>
<p>Reads configuration information from the specified
<span class="emphasis"><em>FILE</em></span>.</p>
</dd>
<dt>
<span class="term">-fmt=FORMAT, --format=FORMAT</span>
</dt>
<dd>
<p>Reports the output in the specified
<span class="emphasis"><em>FORMAT</em></span>.
The formats currently supported are
<span class="bold"><strong>ascii</strong></span>
(the default)
and
<span class="bold"><strong>gnuplot</strong></span>.</p>
</dd>
<dt>
<span class="term">-h, --help</span>
</dt>
<dd>
<p>Displays help text for the
<span class="bold"><strong>scons-time time</strong></span>
subcommand.</p>
</dd>
<dt>
<span class="term">-p STRING, --prefix=STRING</span>
</dt>
<dd>
<p>Specifies the prefix string for log files
from which to extract execution timings.
This will be used to search for log files
if no arguments are specified on the command line.</p>
</dd>
<dt>
<span class="term">-t NUMBER, --tail=NUMBER</span>
</dt>
<dd>
<p>Only reports object counts from the last
<span class="emphasis"><em>NUMBER</em></span>
files.</p>
</dd>
<dt>
<span class="term">--which=WHICH</span>
</dt>
<dd>
<p>Prints the execution time for the specified
<span class="emphasis"><em>WHICH</em></span>
value:
<span class="bold"><strong>total</strong></span>
(the total execution time),
<span class="bold"><strong>SConscripts</strong></span>
(total execution time for the SConscript files themselves),
<span class="bold"><strong>SCons</strong></span>
(execution time in SCons code itself)
or
<span class="bold"><strong>commands</strong></span>
(execution time of the commands and other actions
used to build targets).
If no
<code class="option">--which</code>
option is specified,
the default behavior is
<span class="bold"><strong>total</strong></span>,
which reports the total execution time for each run.</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="refsect1" title="CONFIGURATION FILE">
<a name="configuration_file"/>
<h2>CONFIGURATION FILE</h2>
<p>Various
<span class="command"><strong>scons-time</strong></span>
subcommands can read information from a specified
configuration file when passed the
<code class="option">-f</code>
or
<code class="option">--file</code>
options.
The configuration file is actually executed as a Python script.
Setting Python variables in the configuration file
controls the behavior of the
<span class="command"><strong>scons-time</strong></span>
script more conveniently than having to specify
command-line options or arguments for every run,
and provides a handy way to "shrink-wrap"
the necessary information for producing (and reporting)
consistent timing runs for a given configuration.</p>
<div class="variablelist">
<dl>
<dt>
<span class="term">
<span class="bold">
<strong>archive_list</strong>
</span>
</span>
</dt>
<dd>
<p>A list of archives (files or directories)
that will be copied to the temporary directory
in which SCons will be invoked.
<span class="markup">.tar</span>,