summaryrefslogtreecommitdiff
path: root/doc/user/environments.xml
blob: ede9bc3b55c2103b3ee10bdffdaf132d71e3f997 (plain)
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
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
<?xml version='1.0'?>
<!DOCTYPE sconsdoc [
    <!ENTITY % scons SYSTEM "../scons.mod">
    %scons;
    
    <!ENTITY % builders-mod SYSTEM "../generated/builders.mod">
    %builders-mod;
    <!ENTITY % functions-mod SYSTEM "../generated/functions.mod">
    %functions-mod;
    <!ENTITY % tools-mod SYSTEM "../generated/tools.mod">
    %tools-mod;
    <!ENTITY % variables-mod SYSTEM "../generated/variables.mod">
    %variables-mod;

]>

<chapter id="chap-environments"
         xmlns="http://www.scons.org/dbxsd/v1.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
<title>Environments</title>

<!--

     Copyright (c) 2001 - 2019 The SCons Foundation

     Permission is hereby granted, free of charge, to any person obtaining
     a copy of this software and associated documentation files (the
     "Software"), to deal in the Software without restriction, including
     without limitation the rights to use, copy, modify, merge, publish,
     distribute, sublicense, and/or sell copies of the Software, and to
     permit persons to whom the Software is furnished to do so, subject to
     the following conditions:

     The above copyright notice and this permission notice shall be included
     in all copies or substantial portions of the Software.

     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
     KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
     WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
     LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
     OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

-->

<!--

=head1 More on construction environments

As previously mentioned, a B<construction environment> is an object that
has a set of keyword/value pairs and a set of methods, and which is used
to tell Cons how target files should be built.  This section describes
how Cons uses and expands construction environment values to control its
build behavior.

=head2 Construction variable expansion

Construction variables from a construction environment are expanded
by preceding the keyword with a C<%> (percent sign):

     Construction variables:
	XYZZY => 'abracadabra',

     The string:  "The magic word is:  %XYZZY!"
     expands to:  "The magic word is:  abracadabra!"

A construction variable name may be surrounded by C<{> and C<}> (curly
braces), which are stripped as part of the expansion.  This can
sometimes be necessary to separate a variable expansion from trailing
alphanumeric characters:

     Construction variables:
	OPT    => 'value1',
	OPTION => 'value2',

     The string:  "%OPT %{OPT}ION %OPTION %{OPTION}"
     expands to:  "value1 value1ION value2 value2"

Construction variable expansion is recursive, that is, a string
containing C<%->expansions after substitution will be re-expanded until
no further substitutions can be made:

     Construction variables:
	STRING => 'The result is:  %FOO',
	FOO    => '%BAR',
	BAR    => 'final value',

     The string:  "The string says:  %STRING"
     expands to:  "The string says:  The result is:  final value"

If a construction variable is not defined in an environment, then the
null string is substituted:

     Construction variables:
	FOO => 'value1',
	BAR => 'value2',

     The string:  "%FOO <%NO_VARIABLE> %BAR"
     expands to:  "value1 <> value2"

A doubled C<%%> will be replaced by a single C<%>:

     The string:  "Here is a percent sign:  %%"
     expands to:  "Here is a percent sign: %"

=head2 Default construction variables

When you specify no arguments when creating a new construction
environment:

     $env = new cons();

Cons creates a reference to a new, default construction
environment. This contains a number of construction variables and some
methods. At the present writing, the default construction variables on a
UNIX system are:

     CC            => 'cc',
     CFLAGS        => '',
     CCCOM         => '%CC %CFLAGS %_IFLAGS -c %< -o %>',
     CXX           => '%CC',
     CXXFLAGS      => '%CFLAGS',
     CXXCOM        => '%CXX %CXXFLAGS %_IFLAGS -c %< -o %>',
     INCDIRPREFIX  => '-I',
     INCDIRSUFFIX  => '',
     LINK          => '%CXX',
     LINKCOM       => '%LINK %LDFLAGS -o %> %< %_LDIRS %LIBS',
     LINKMODULECOM => '%LD -r -o %> %<',
     LIBDIRPREFIX  => '-L',
     LIBDIRSUFFIX  => '',
     AR		=> 'ar',
     ARFLAGS	=> 'r',
     ARCOM		=> ['%AR %ARFLAGS %> %<', '%RANLIB %>'],
     RANLIB	=> 'ranlib',
     AS		=> 'as',
     ASFLAGS	=> '',
     ASCOM		=> '%AS %ASFLAGS %< -o %>',
     LD		=> 'ld',
     LDFLAGS	=> '',
     PREFLIB	=> 'lib',
     SUFLIB	=> '.a',
     SUFLIBS	=> '.so:.a',
     SUFOBJ	=> '.o',
     SIGNATURE     => [ '*' => 'build' ],
     ENV		=> { 'PATH' => '/bin:/usr/bin' },


And on a Windows system (Windows NT), the default construction variables
are (unless the default rule style is set using the B<DefaultRules>
method):

     CC		=> 'cl',
     CFLAGS	=> '/nologo',
     CCCOM		=> '%CC %CFLAGS %_IFLAGS /c %< /Fo%>',
     CXXCOM        => '%CXX %CXXFLAGS %_IFLAGS /c %< /Fo%>',
     INCDIRPREFIX  => '/I',
     INCDIRSUFFIX  => '',
     LINK          => 'link',
     LINKCOM       => '%LINK %LDFLAGS /out:%> %< %_LDIRS %LIBS',
     LINKMODULECOM => '%LD /r /o %> %<',
     LIBDIRPREFIX  => '/LIBPATH:',
     LIBDIRSUFFIX  => '',
     AR            => 'lib',
     ARFLAGS       => '/nologo ',
     ARCOM         => "%AR %ARFLAGS /out:%> %<",
     RANLIB        => '',
     LD            => 'link',
     LDFLAGS       => '/nologo ',
     PREFLIB       => '',
     SUFEXE	=> '.exe',
     SUFLIB	=> '.lib',
     SUFLIBS	=> '.dll:.lib',
     SUFOBJ	=> '.obj',
     SIGNATURE     => [ '*' => 'build' ],

These variables are used by the various methods associated with the
environment. In particular, any method that ultimately invokes an external
command will substitute these variables into the final command, as
appropriate. For example, the C<Objects> method takes a number of source
files and arranges to derive, if necessary, the corresponding object
files:

     Objects $env 'foo.c', 'bar.c';

This will arrange to produce, if necessary, F<foo.o> and F<bar.o>. The
command invoked is simply C<%CCCOM>, which expands, through substitution,
to the appropriate external command required to build each object. The
substitution rules will be discussed in detail in the next section.

The construction variables are also used for other purposes. For example,
C<CPPPATH> is used to specify a colon-separated path of include
directories. These are intended to be passed to the C preprocessor and are
also used by the C-file scanning machinery to determine the dependencies
involved in a C Compilation.

Variables beginning with underscore are created by various methods,
and should normally be considered ``internal'' variables. For example,
when a method is called which calls for the creation of an object from
a C source, the variable C<_IFLAGS> is created: this corresponds to the
C<-I> switches required by the C compiler to represent the directories
specified by C<CPPPATH>.

Note that, for any particular environment, the value of a variable is set
once, and then never reset (to change a variable, you must create a new
environment. Methods are provided for copying existing environments for this
purpose). Some internal variables, such as C<_IFLAGS> are created on demand,
but once set, they remain fixed for the life of the environment.

The C<CFLAGS>, C<LDFLAGS>, and C<ARFLAGS> variables all supply a place
for passing options to the compiler, loader, and archiver, respectively.

The C<INCDIRPREFIX> and C<INCDIRSUFFIX> variables specify option
strings to be appended to the beginning and end, respectively, of each
include directory so that the compiler knows where to find F<.h> files.
Similarly, the C<LIBDIRPREFIX> and C<LIBDIRSUFFIX> variables specify the
option string to be appended to the beginning of and end, respectively,
of each directory that the linker should search for libraries.

Another variable, C<ENV>, is used to determine the system environment during
the execution of an external command. By default, the only environment
variable that is set is C<PATH>, which is the execution path for a UNIX
command. For the utmost reproducibility, you should really arrange to set
your own execution path, in your top-level F<Construct> file (or perhaps by
importing an appropriate construction package with the Perl C<use>
command). The default variables are intended to get you off the ground.

=head2 Expanding variables in construction commands

Within a construction command, construction variables will be expanded
according to the rules described above.  In addition to normal variable
expansion from the construction environment, construction commands also
expand the following pseudo-variables to insert the specific input and
output files in the command line that will be executed:

=over 10

=item %>

The target file name.  In a multi-target command, this expands to the
first target mentioned.)

=item %0

Same as C<%E<gt>>.

=item %1, %2, ..., %9

These refer to the first through ninth input file, respectively.

=item %E<lt>

The full set of input file names. If any of these have been used
anywhere else in the current command line (via C<%1>, C<%2>, etc.), then
those will be deleted from the list provided by C<%E<lt>>. Consider the
following command found in a F<Conscript> file in the F<test> directory:

     Command $env 'tgt', qw(foo bar baz), qq(
	echo %< -i %1 > %>
	echo %< -i %2 >> %>
	echo %< -i %3 >> %>
     );

If F<tgt> needed to be updated, then this would result in the execution of
the following commands, assuming that no remapping has been established for
the F<test> directory:

     echo test/bar test/baz -i test/foo > test/tgt
     echo test/foo test/baz -i test/bar >> test/tgt
     echo test/foo test/bar -i test/baz >> test/tgt

=back

Any of the above pseudo-variables may be followed immediately by one of
the following suffixes to select a portion of the expanded path name:

     :a    the absolute path to the file name
     :b    the directory plus the file name stripped of any suffix
     :d    the directory
     :f    the file name
     :s    the file name suffix
     :F    the file name stripped of any suffix
     :S    the absolute path path to a Linked source file

Continuing with the above example, C<%E<lt>:f> would expand to C<foo bar baz>,
and C<%E<gt>:d> would expand to C<test>.

There are additional C<%> elements which affect the command line(s):

=over 10

=item %[ %]

It is possible to programmatically rewrite part of the command by
enclosing part of it between C<%[> and C<%]>.  This will call the
construction variable named as the first word enclosed in the brackets
as a Perl code reference; the results of this call will be used to
replace the contents of the brackets in the command line.  For example,
given an existing input file named F<tgt.in>:

     @keywords = qw(foo bar baz);
     $env = new cons(X_COMMA => sub { join(",", @_) });
     Command $env 'tgt', 'tgt.in', qq(
	echo '# Keywords: %[X_COMMA @keywords %]' > %>
	cat %< >> %>
     );

This will execute:

     echo '# Keywords: foo,bar,baz' > tgt
     cat tgt.in >> tgt

=item %( %)

Cons includes the text of the command line in the MD5 signature for a
build, so that targets get rebuilt if you change the command line (to
add or remove an option, for example).  Command-line text in between
C<%(> and C<%)>, however, will be ignored for MD5 signature calculation.

Internally, Cons uses C<%(> and C<%)> around include and library
directory options (C<-I> and C<-L> on UNIX systems, C</I> and
C</LIBPATH> on Windows NT) to avoid rebuilds just because the directory
list changes.  Rebuilds occur only if the changed directory list causes
any included I<files> to change, and a changed include file is detected
by the MD5 signature calculation on the actual file contents.

=back

XXX DESCRIBE THE Literal() FUNCTION, TOO XXX

=head2 Expanding construction variables in file names

Cons expands construction variables in the source and target file names
passed to the various construction methods according to the expansion
rules described above:

     $env = new cons(
	DESTDIR	=>	'programs',
	SRCDIR	=>	'src',
     );
     Program $env '%DESTDIR/hello', '%SRCDIR/hello.c';

This allows for flexible configuration, through the construction
environment, of directory names, suffixes, etc.

-->

  <para>

  An <literal>environment</literal>
  is a collection of values that
  can affect how a program executes.
  &SCons; distinguishes between three
  different types of environments
  that can affect the behavior of &SCons; itself
  (subject to the configuration in the &SConscript; files),
  as well as the compilers and other tools it executes:

  </para>

  <variablelist>

    <varlistentry>
    <term>External Environment</term>

    <listitem>
    <para>

    The <literal>external environment</literal>
    is the set of variables in the user's environment
    at the time the user runs &SCons;.
    These variables are available within the &SConscript; files
    through the Python <literal>os.environ</literal> dictionary.
    See <xref linkend="sect-external-environments"></xref>, below.

    </para>
    </listitem>
    </varlistentry>

    <varlistentry>
    <term>&ConsEnv;</term>

    <listitem>
    <para>

    A &consenv;
    is a distinct object created within
    a &SConscript; file and
    which contains values that
    affect how &SCons; decides
    what action to use to build a target,
    and even to define which targets
    should be built from which sources.
    One of the most powerful features of &SCons;
    is the ability to create multiple &consenvs;,
    including the ability to clone a new, customized
    &consenv; from an existing &consenv;.
    See <xref linkend="sect-construction-environments"></xref>, below.

    </para>
    </listitem>
    </varlistentry>

    <varlistentry>
    <term>Execution Environment</term>

    <listitem>
    <para>

    An <literal>execution environment</literal>
    is the values that &SCons; sets
    when executing an external
    command (such as a compiler or linker)
    to build one or more targets.
    Note that this is not the same as
    the <literal>external environment</literal>
    (see above).
    See <xref linkend="sect-execution-environments"></xref>, below.

    </para>
    </listitem>
    </varlistentry>

  </variablelist>

  <para>

  Unlike &Make;,  &SCons; does not automatically
  copy or import values between different environments
  (with the exception of explicit clones of &consenvs;,
  which inherit values from their parent).
  This is a deliberate design choice
  to make sure that builds are,
  by default, repeatable regardless of
  the values in the user's external environment.
  This avoids a whole class of problems with builds
  where a developer's local build works
  because a custom variable setting
  causes a different compiler or build option to be used,
  but the checked-in change breaks the official build
  because it uses different environment variable settings.

  </para>

  <para>

  Note that the &SConscript; writer can
  easily arrange for variables to be
  copied or imported between environments,
  and this is often very useful
  (or even downright necessary)
  to make it easy for developers
  to customize the build in appropriate ways.
  The point is <emphasis>not</emphasis>
  that copying variables between different environments
  is evil and must always be avoided.
  Instead, it should be up to the
  implementer of the build system
  to make conscious choices
  about how and when to import
  a variable from one environment to another,
  making informed decisions about
  striking the right balance
  between making the build
  repeatable on the one hand
  and convenient to use on the other.

  </para>

  <section id="sect-external-environments">
  <title>Using Values From the External Environment</title>

  <para>

  The <literal>external environment</literal>
  variable settings that
  the user has in force
  when executing &SCons;
  are available through the normal Python
  <envar>os.environ</envar>
  dictionary.
  This means that you must add an
  <literal>import os</literal> statement
  to any &SConscript; file
  in which you want to use
  values from the user's external environment.

  </para>

   <scons_example name="environments_ex1">
     <file name="SConstruct" printme="1">
import os
     </file>
     <file name="foo.c">
int main() { }
     </file>
   </scons_example>

  <para>

  More usefully, you can use the
  <envar>os.environ</envar>
  dictionary in your &SConscript;
  files to initialize &consenvs;
  with values from the user's external environment.
  See the next section,
  <xref linkend="sect-construction-environments"></xref>,
  for information on how to do this.

  </para>

  </section>

  <section id="sect-construction-environments">
  <title>Construction Environments</title>

    <para>

      It is rare that all of the software in a large,
      complicated system needs to be built the same way.
      For example, different source files may need different options
      enabled on the command line,
      or different executable programs need to be linked
      with different libraries.
      &SCons; accommodates these different build
      requirements by allowing you to create and
      configure multiple &consenvs;
      that control how the software is built.
      A &consenv; is an object
      that has a number of associated
      &consvars;, each with a name and a value.
      (A construction environment also has an attached
      set of &Builder; methods,
      about which we'll learn more later.)

    </para>

    <section>
    <title>Creating a &ConsEnv;:  the &Environment; Function</title>

      <para>

        A &consenv; is created by the &Environment; method:

      </para>

       <sconstruct>
env = Environment()
       </sconstruct>

      <para>

        By default, &SCons; initializes every
        new construction environment
        with a set of &consvars;
        based on the tools that it finds on your system,
        plus the default set of builder methods
        necessary for using those tools.
        The construction variables
        are initialized with values describing
        the C compiler,
        the Fortran compiler,
        the linker,
        etc.,
        as well as the command lines to invoke them.

      </para>

      <para>

        When you initialize a construction environment
        you can set the values of the
        environment's &consvars;
        to control how a program is built.
        For example:

      </para>

       <scons_example name="environments_ex1">
         <file name="SConstruct" printme="1">
 env = Environment(CC = 'gcc',
                   CCFLAGS = '-O2')

 env.Program('foo.c')
         </file>
         <file name="foo.c">
int main() { }
         </file>
       </scons_example>

      <para>

        The construction environment in this example
        is still initialized with the same default
        construction variable values,
        except that the user has explicitly specified use of the
        GNU C compiler &gcc;,
        and further specifies that the <literal>-O2</literal>
        (optimization level two)
        flag should be used when compiling the object file.
        In other words, the explicit initializations of
        &cv-link-CC; and &cv-link-CCFLAGS;
        override the default values in the newly-created
        construction environment.
        So a run from this example would look like:

      </para>

      <scons_output example="environments_ex1" suffix="1">
         <scons_output_command>scons -Q</scons_output_command>
      </scons_output>

    </section>

    <section>
    <title>Fetching Values From a &ConsEnv;</title>

      <para>

      You can fetch individual construction variables
      using the normal syntax
      for accessing individual named items in a Python dictionary:

      </para>

      <scons_example name="environments_ex6">
        <file name="SConstruct" printme="1">
env = Environment()
print("CC is: %s"%env['CC'])
        </file>
      </scons_example>

      <para>

      This example &SConstruct; file doesn't build anything,
      but because it's actually a Python script,
      it will print the value of &cv-link-CC; for us:

      </para>

      <scons_output example="environments_ex6" suffix="1">
         <scons_output_command>scons -Q</scons_output_command>
      </scons_output>

      <para>

      A construction environment, however,
      is actually an object with associated methods, etc.
      If you want to have direct access to only the
      dictionary of construction variables,
      you can fetch this using the &Dictionary; method:

      </para>

      <scons_example name="environments_ex6b">
         <file name="SConstruct" printme="1">
env = Environment(FOO = 'foo', BAR = 'bar')
dict = env.Dictionary()
for key in ['OBJSUFFIX', 'LIBSUFFIX', 'PROGSUFFIX']:
    print("key = %s, value = %s" % (key, dict[key]))
         </file>
      </scons_example>

      <para>

      This &SConstruct; file
      will print the specified dictionary items for us on POSIX
      systems as follows:

      </para>

      <scons_output example="environments_ex6b" os="posix" suffix="1">
         <scons_output_command>scons -Q</scons_output_command>
      </scons_output>

      <para>

      And on Windows:

      </para>

      <scons_output example="environments_ex6b" os="win32" suffix="2">
         <scons_output_command>scons -Q</scons_output_command>
      </scons_output>

      <para>

      If you want to loop and print the values of
      all of the construction variables in a construction environment,
      the Python code to do that in sorted order might look something like:

      </para>

      <sconstruct>
env = Environment()
for item in sorted(env.Dictionary().items()):
    print("construction variable = '%s', value = '%s'" % item)
      </sconstruct>

    </section>

    <section>
    <title>Expanding Values From a &ConsEnv;:  the &subst; Method</title>

      <para>

      Another way to get information from
      a construction environment
      is to use the &subst; method
      on a string containing <literal>$</literal> expansions
      of construction variable names.
      As a simple example,
      the example from the previous
      section that used
      <literal>env['CC']</literal>
      to fetch the value of &cv-link-CC;
      could also be written as:

      </para>

      <sconstruct>
env = Environment()
print("CC is: %s"%env.subst('$CC'))
      </sconstruct>

      <para>

      One advantage of using
      &subst; to expand strings is
      that construction variables
      in the result get re-expanded until
      there are no expansions left in the string.
      So a simple fetch of a value like
      &cv-link-CCCOM;:

      </para>

      <sconstruct>
env = Environment(CCFLAGS = '-DFOO')
print("CCCOM is: %s"%env['CCCOM'])
      </sconstruct>

      <para>

      Will print the unexpanded value of &cv-CCCOM;,
      showing us the construction
      variables that still need to be expanded:

      </para>

      <screen>
% <userinput>scons -Q</userinput>
CCCOM is: $CC $CCFLAGS $CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS -c -o $TARGET $SOURCES
scons: `.' is up to date.
      </screen>

      <para>

      Calling the &subst; method on <varname>$CCOM</varname>,
      however:

      </para>

      <sconstruct>
env = Environment(CCFLAGS = '-DFOO')
print("CCCOM is: %s"%env.subst('$CCCOM'))
      </sconstruct>

      <para>

      Will recursively expand all of
      the construction variables prefixed
      with <literal>$</literal> (dollar signs),
      showing us the final output:

      </para>

      <screen>
% <userinput>scons -Q</userinput>
CCCOM is: gcc -DFOO -c -o
scons: `.' is up to date.
      </screen>

      <para>

      Note that because we're not expanding this
      in the context of building something
      there are no target or source files
      for &cv-link-TARGET; and &cv-link-SOURCES; to expand.

      </para>

    </section>

    <section>
    <title>Handling Problems With Value Expansion</title>

      <para>

      If a problem occurs when expanding a construction variable,
      by default it is expanded to <literal>''</literal>
      (a null string), and will not cause scons to fail. 
      </para>

       <scons_example name="environments_missing1">
         <file name="SConstruct" printme="1">
env = Environment()
print("value is: %s"%env.subst( '->$MISSING&lt;-' ))
        </file>
      </scons_example>

       <scons_output example="environments_missing1" suffix="1">
          <scons_output_command>scons -Q</scons_output_command>
       </scons_output>

      <para>
      This default behaviour can be changed using the &AllowSubstExceptions;
      function.
      When a problem occurs with a variable expansion it generates
      an exception, and the &AllowSubstExceptions; function controls
      which of these exceptions are actually fatal and which are
      allowed to occur safely.   By default, &NameError; and &IndexError;
      are the two exceptions that are allowed to occur: so instead of
      causing scons to fail, these are caught, the variable expanded to
      <literal>''</literal>
      and scons execution continues.
      To require that all construction variable names exist, and that
      indexes out of range are not allowed, call &AllowSubstExceptions;
      with no extra arguments.
      </para>

       <scons_example name="environments_missing2">
         <file name="SConstruct" printme="1">
AllowSubstExceptions()
env = Environment()
print("value is: %s"%env.subst( '->$MISSING&lt;-' ))
        </file>
      </scons_example>

       <scons_output example="environments_missing2" suffix="1">
          <scons_output_command>scons -Q</scons_output_command>
       </scons_output>

      <para>
      This can also be used to allow other exceptions that might occur,
      most usefully with the <literal>${...}</literal> construction
      variable syntax.  For example, this would allow zero-division to
      occur in a variable expansion in addition to the default exceptions
      allowed
      </para>

       <scons_example name="environments_missing3">
         <file name="SConstruct" printme="1">
AllowSubstExceptions(IndexError, NameError, ZeroDivisionError)
env = Environment()
print("value is: %s"%env.subst( '->${1 / 0}&lt;-' ))
        </file>
      </scons_example>

       <scons_output example="environments_missing3" suffix="1">
          <scons_output_command>scons -Q</scons_output_command>
       </scons_output>

      <para>
      If &AllowSubstExceptions; is called multiple times, each call
      completely overwrites the previous list of allowed exceptions.
      </para>

    </section>

    <section>
    <title>Controlling the Default &ConsEnv;:  the &DefaultEnvironment; Function</title>

      <para>

      All of the &Builder; functions that we've introduced so far,
      like &Program; and &Library;,
      actually use a default &consenv;
      that contains settings
      for the various compilers
      and other tools that
      &SCons; configures by default,
      or otherwise knows about
      and has discovered on your system.
      The goal of the default construction environment
      is to make many configurations to "just work"
      to build software using
      readily available tools
      with a minimum of configuration changes.

      </para>

      <para>

      You can, however, control the settings
      in the default construction environment
      by using the &DefaultEnvironment; function
      to initialize various settings:

      </para>

      <sconstruct>
DefaultEnvironment(CC = '/usr/local/bin/gcc')
      </sconstruct>

      <para>

      When configured as above,
      all calls to the &Program;
      or &Object; Builder
      will build object files with the
      <filename>/usr/local/bin/gcc</filename>
      compiler.

      </para>

      <para>

      Note that the &DefaultEnvironment; function
      returns the initialized
      default construction environment object,
      which can then be manipulated like any
      other construction environment.
      So the following
      would be equivalent to the
      previous example,
      setting the &cv-CC;
      variable to <filename>/usr/local/bin/gcc</filename>
      but as a separate step after
      the default construction environment has been initialized:

      </para>

      <sconstruct>
env = DefaultEnvironment()
env['CC'] = '/usr/local/bin/gcc'
      </sconstruct>

      <para>

      One very common use of the &DefaultEnvironment; function
      is to speed up &SCons; initialization.
      As part of trying to make most default
      configurations "just work,"
      &SCons; will actually
      search the local system for installed
      compilers and other utilities.
      This search can take time,
      especially on systems with
      slow or networked file systems.
      If you know which compiler(s) and/or
      other utilities you want to configure,
      you can control the search
      that &SCons; performs
      by specifying some specific
      tool modules with which to
      initialize the default construction environment:

      </para>

      <sconstruct>
env = DefaultEnvironment(tools = ['gcc', 'gnulink'],
                         CC = '/usr/local/bin/gcc')
      </sconstruct>

      <para>

      So the above example would tell &SCons;
      to explicitly configure the default environment
      to use its normal GNU Compiler and GNU Linker settings
      (without having to search for them,
      or any other utilities for that matter),
      and specifically to use the compiler found at
      <filename>/usr/local/bin/gcc</filename>.

      </para>

    </section>

    <section>
    <title>Multiple &ConsEnvs;</title>

      <para>

      The real advantage of construction environments
      is that you can create as many different construction
      environments as you need,
      each tailored to a different way to build
      some piece of software or other file.
      If, for example, we need to build
      one program with the <literal>-O2</literal> flag
      and another with the <literal>-g</literal> (debug) flag,
      we would do this like so:

      </para>

      <scons_example name="environments_ex2">
        <file name="SConstruct" printme="1">
opt = Environment(CCFLAGS = '-O2')
dbg = Environment(CCFLAGS = '-g')

opt.Program('foo', 'foo.c')

dbg.Program('bar', 'bar.c')
        </file>
        <file name="foo.c">
int main() { }
        </file>
        <file name="bar.c">
int main() { }
        </file>
      </scons_example>

      <scons_output example="environments_ex2" suffix="1">
         <scons_output_command>scons -Q</scons_output_command>
      </scons_output>

      <para>

      We can even use multiple construction environments to build
      multiple versions of a single program.
      If you do this by simply trying to use the
      &b-link-Program; builder with both environments, though,
      like this:

      </para>

      <scons_example name="environments_ex3">
        <file name="SConstruct" printme="1">
opt = Environment(CCFLAGS = '-O2')
dbg = Environment(CCFLAGS = '-g')

opt.Program('foo', 'foo.c')

dbg.Program('foo', 'foo.c')
        </file>
        <file name="foo.c">
int main() { }
        </file>
      </scons_example>

      <para>

      Then &SCons; generates the following error:

      </para>

      <scons_output example="environments_ex3" suffix="1">
         <scons_output_command>scons -Q</scons_output_command>
      </scons_output>

      <para>

      This is because the two &b-Program; calls have
      each implicitly told &SCons; to generate an object file named
      <filename>foo.o</filename>,
      one with a &cv-link-CCFLAGS; value of
      <literal>-O2</literal>
      and one with a &cv-link-CCFLAGS; value of
      <literal>-g</literal>.
      &SCons; can't just decide that one of them
      should take precedence over the other,
      so it generates the error.
      To avoid this problem,
      we must explicitly specify
      that each environment compile
      <filename>foo.c</filename>
      to a separately-named object file
      using the &b-link-Object; builder, like so:

      </para>

      <scons_example name="environments_ex4">
        <file name="SConstruct" printme="1">
opt = Environment(CCFLAGS = '-O2')
dbg = Environment(CCFLAGS = '-g')

o = opt.Object('foo-opt', 'foo.c')
opt.Program(o)

d = dbg.Object('foo-dbg', 'foo.c')
dbg.Program(d)
        </file>
        <file name="foo.c">
int main() { }
        </file>
      </scons_example>

      <para>

      Notice that each call to the &b-Object; builder
      returns a value,
      an internal &SCons; object that
      represents the object file that will be built.
      We then use that object
      as input to the &b-Program; builder.
      This avoids having to specify explicitly
      the object file name in multiple places,
      and makes for a compact, readable
      &SConstruct; file.
      Our &SCons; output then looks like:

      </para>

      <scons_output example="environments_ex4" suffix="1">
         <scons_output_command>scons -Q</scons_output_command>
      </scons_output>

    </section>

    <section>
    <title>Making Copies of &ConsEnvs;:  the &Clone; Method</title>

      <para>

      Sometimes you want more than one construction environment
      to share the same values for one or more variables.
      Rather than always having to repeat all of the common
      variables when you create each construction environment,
      you can use the &Clone; method
      to create a copy of a construction environment.

      </para>

      <para>

      Like the &Environment; call that creates a construction environment,
      the &Clone; method takes &consvar; assignments,
      which will override the values in the copied construction environment.
      For example, suppose we want to use &gcc;
      to create three versions of a program,
      one optimized, one debug, and one with neither.
      We could do this by creating a "base" construction environment
      that sets &cv-link-CC; to &gcc;,
      and then creating two copies,
      one which sets &cv-link-CCFLAGS; for optimization
      and the other which sets &cv-CCFLAGS; for debugging:

      </para>

      <scons_example name="environments_ex5">
        <file name="SConstruct" printme="1">
env = Environment(CC = 'gcc')
opt = env.Clone(CCFLAGS = '-O2')
dbg = env.Clone(CCFLAGS = '-g')

env.Program('foo', 'foo.c')

o = opt.Object('foo-opt', 'foo.c')
opt.Program(o)

d = dbg.Object('foo-dbg', 'foo.c')
dbg.Program(d)
        </file>
        <file name="foo.c">
int main() { }
        </file>
      </scons_example>

      <para>

      Then our output would look like:

      </para>

      <scons_output example="environments_ex5" suffix="1">
         <scons_output_command>scons -Q</scons_output_command>
      </scons_output>

    </section>

    <section>
    <title>Replacing Values:  the &Replace; Method</title>

      <para>

      You can replace existing construction variable values
      using the &Replace; method:

      </para>

      <scons_example name="environments_Replace1">
        <file name="SConstruct" printme="1">
env = Environment(CCFLAGS = '-DDEFINE1')
env.Replace(CCFLAGS = '-DDEFINE2')
env.Program('foo.c')
        </file>
        <file name="foo.c">
int main() { }
        </file>
      </scons_example>

      <para>

      The replacing value
      (<literal>-DDEFINE2</literal> in the above example)
      completely replaces the value in the
      construction environment:

      </para>

      <scons_output example="environments_Replace1" suffix="1">
         <scons_output_command>scons -Q</scons_output_command>
      </scons_output>

      <para>

      You can safely call &Replace;
      for construction variables that
      don't exist in the construction environment:

      </para>

      <scons_example name="environments_Replace-nonexistent">
        <file name="SConstruct" printme="1">
env = Environment()
env.Replace(NEW_VARIABLE = 'xyzzy')
print("NEW_VARIABLE = %s"%env['NEW_VARIABLE'])
        </file>
      </scons_example>

      <para>

      In this case,
      the construction variable simply
      gets added to the construction environment:

      </para>

      <scons_output example="environments_Replace-nonexistent" suffix="1">
         <scons_output_command>scons -Q</scons_output_command>
      </scons_output>

      <para>

      Because the variables
      aren't expanded until the construction environment
      is actually used to build the targets,
      and because &SCons; function and method calls
      are order-independent,
      the last replacement "wins"
      and is used to build all targets,
      regardless of the order in which
      the calls to Replace() are
      interspersed with calls to
      builder methods:

      </para>

      <scons_example name="environments_Replace2">
        <file name="SConstruct" printme="1">
env = Environment(CCFLAGS = '-DDEFINE1')
print("CCFLAGS = %s"%env['CCFLAGS'])
env.Program('foo.c')

env.Replace(CCFLAGS = '-DDEFINE2')
print("CCFLAGS = %s"%env['CCFLAGS'])
env.Program('bar.c')
        </file>
        <file name="foo.c">
int main() { }
        </file>
        <file name="bar.c">
int main() { }
        </file>
      </scons_example>

      <para>

      The timing of when the replacement
      actually occurs relative
      to when the targets get built
      becomes apparent
      if we run &scons; without the <literal>-Q</literal>
      option:

      </para>

      <scons_output example="environments_Replace2" suffix="1">
         <scons_output_command>scons</scons_output_command>
      </scons_output>

      <para>

      Because the replacement occurs while
      the &SConscript; files are being read,
      the &cv-link-CCFLAGS;
      variable has already been set to
      <literal>-DDEFINE2</literal>
      by the time the &foo_o; target is built,
      even though the call to the &Replace;
      method does not occur until later in
      the &SConscript; file.

      </para>

    </section>

    <section>
    <title>Setting Values Only If They're Not Already Defined:  the &SetDefault; Method</title>

      <para>

      Sometimes it's useful to be able to specify
      that a construction variable should be
      set to a value only if the construction environment
      does not already have that variable defined
      You can do this with the &SetDefault; method,
      which behaves similarly to the <function>set_default</function>
      method of Python dictionary objects:

      </para>

      <sconstruct>
env.SetDefault(SPECIAL_FLAG = '-extra-option')
      </sconstruct>

      <para>

      This is especially useful
      when writing your own <literal>Tool</literal> modules
      to apply variables to construction environments.
      <!--
      See <xref linkend="chap-tool-modules"></xref>
      for more information about writing
      Tool modules.
      -->

      </para>

    </section>

    <section>
    <title>Appending to the End of Values:  the &Append; Method</title>

      <para>

      You can append a value to
      an existing construction variable
      using the &Append; method:

      </para>

      <scons_example name="environments_ex8">
        <file name="SConstruct" printme="1">
env = Environment(CCFLAGS = ['-DMY_VALUE'])
env.Append(CCFLAGS = ['-DLAST'])
env.Program('foo.c')
        </file>
        <file name="foo.c">
int main() { }
        </file>
      </scons_example>

      <para>

      &SCons; then supplies both the <literal>-DMY_VALUE</literal> and
      <literal>-DLAST</literal> flags when compiling the object file:

      </para>

      <scons_output example="environments_ex8" suffix="1">
         <scons_output_command>scons -Q</scons_output_command>
      </scons_output>

      <para>

      If the construction variable doesn't already exist,
      the &Append; method will create it:

      </para>

      <scons_example name="environments_Append-nonexistent">
        <file name="SConstruct" printme="1">
env = Environment()
env.Append(NEW_VARIABLE = 'added')
print("NEW_VARIABLE = %s"%env['NEW_VARIABLE'])
        </file>
      </scons_example>

      <para>

      Which yields:

      </para>

      <scons_output example="environments_Append-nonexistent" suffix="1">
         <scons_output_command>scons -Q</scons_output_command>
      </scons_output>

      <para>

      Note that the &Append; function tries to be "smart"
      about how the new value is appended to the old value.
      If both are strings, the previous and new strings
      are simply concatenated.
      Similarly, if both are lists,
      the lists are concatenated.
      If, however, one is a string and the other is a list,
      the string is added as a new element to the list.

      </para>

    </section>

    <section>
    <title>Appending Unique Values:  the &AppendUnique; Method</title>

      <para>

      Some times it's useful to add a new value
      only if the existing construction variable
      doesn't already contain the value.
      This can be done using the &AppendUnique; method:

      </para>

      <sconstruct>
env.AppendUnique(CCFLAGS=['-g'])
      </sconstruct>

      <para>

      In the above example,
      the <literal>-g</literal> would be added
      only if the &cv-CCFLAGS; variable
      does not already contain a <literal>-g</literal> value.

      </para>

    </section>

    <section>
    <title>Appending to the Beginning of Values:  the &Prepend; Method</title>

      <para>

      You can append a value to the beginning of
      an existing construction variable
      using the &Prepend; method:

      </para>

      <scons_example name="environments_ex9">
        <file name="SConstruct" printme="1">
env = Environment(CCFLAGS = ['-DMY_VALUE'])
env.Prepend(CCFLAGS = ['-DFIRST'])
env.Program('foo.c')
        </file>
        <file name="foo.c">
int main() { }
        </file>
      </scons_example>

      <para>

      &SCons; then supplies both the <literal>-DFIRST</literal> and
      <literal>-DMY_VALUE</literal> flags when compiling the object file:

      </para>

      <scons_output example="environments_ex9" suffix="1">
         <scons_output_command>scons -Q</scons_output_command>
      </scons_output>

      <para>

      If the construction variable doesn't already exist,
      the &Prepend; method will create it:

      </para>

      <scons_example name="environments_Prepend-nonexistent">
        <file name="SConstruct" printme="1">
env = Environment()
env.Prepend(NEW_VARIABLE = 'added')
print("NEW_VARIABLE = %s"%env['NEW_VARIABLE'])
        </file>
      </scons_example>

      <para>

      Which yields:

      </para>

      <scons_output example="environments_Prepend-nonexistent" suffix="1">
         <scons_output_command>scons -Q</scons_output_command>
      </scons_output>

      <para>

      Like the &Append; function,
      the &Prepend; function tries to be "smart"
      about how the new value is appended to the old value.
      If both are strings, the previous and new strings
      are simply concatenated.
      Similarly, if both are lists,
      the lists are concatenated.
      If, however, one is a string and the other is a list,
      the string is added as a new element to the list.

      </para>

    </section>

    <section>
    <title>Prepending Unique Values:  the &PrependUnique; Method</title>

      <para>

      Some times it's useful to add a new value
      to the beginning of a construction variable
      only if the existing value
      doesn't already contain the to-be-added value.
      This can be done using the &PrependUnique; method:

      </para>

      <sconstruct>
env.PrependUnique(CCFLAGS=['-g'])
      </sconstruct>

      <para>

      In the above example,
      the <literal>-g</literal> would be added
      only if the &cv-CCFLAGS; variable
      does not already contain a <literal>-g</literal> value.

      </para>

    </section>

  </section>

  <section id="sect-execution-environments">
  <title>Controlling the Execution Environment for Issued Commands</title>

    <para>

      When &SCons; builds a target file,
      it does not execute the commands with
      the same external environment
      that you used to execute &SCons;.
      Instead, it uses the dictionary
      stored in the &cv-link-ENV; construction variable
      as the external environment
      for executing commands.

    </para>

    <para>

      The most important ramification of this behavior
      is that the &PATH; environment variable,
      which controls where the operating system
      will look for commands and utilities,
      is not the same as in the external environment
      from which you called &SCons;.
      This means that &SCons; will not, by default,
      necessarily find all of the tools
      that you can execute from the command line.

    </para>

    <para>

      The default value of the &PATH; environment variable
      on a POSIX system
      is <literal>/usr/local/bin:/bin:/usr/bin</literal>.
      The default value of the &PATH; environment variable
      on a Windows system comes from the Windows registry
      value for the command interpreter.
      If you want to execute any commands--compilers, linkers, etc.--that
      are not in these default locations,
      you need to set the &PATH; value
      in the &cv-ENV; dictionary
      in your construction environment.

    </para>

    <para>

      The simplest way to do this is to initialize explicitly
      the value when you create the construction environment;
      this is one way to do that:

    </para>

    <sconstruct>
path = ['/usr/local/bin', '/bin', '/usr/bin']
env = Environment(ENV = {'PATH' : path})
    </sconstruct>

    <para>

    Assign a dictionary to the &cv-ENV;
    construction variable in this way
    completely resets the external environment
    so that the only variable that will be
    set when external commands are executed
    will be the &PATH; value.
    If you want to use the rest of
    the values in &cv-ENV; and only
    set the value of &PATH;,
    the most straightforward way is probably:

    </para>

    <sconstruct>
env['ENV']['PATH'] = ['/usr/local/bin', '/bin', '/usr/bin']
    </sconstruct>

    <para>

    Note that &SCons; does allow you to define
    the directories in the &PATH; in a string,
    separated by the pathname-separator character
    for your system (':' on POSIX systems, ';' on Windows):

    </para>

    <sconstruct>
env['ENV']['PATH'] = '/usr/local/bin:/bin:/usr/bin'
    </sconstruct>

    <para>

    But doing so makes your &SConscript; file less portable,
    (although in this case that may not be a huge concern
    since the directories you list are likely system-specific, anyway).

    </para>

    <!--

    <scons_example name="environments_ex1">
      <file name="SConstruct" printme="1">
env = Environment()
env.Command('foo', [], '__ROOT__/usr/bin/printenv.py')
      </file>
      <file name="__ROOT__/usr/bin/printenv.py" chmod="0755">
#!/usr/bin/env python
import os
import sys
if len(sys.argv) &gt; 1:
    keys = sys.argv[1:]
else:
    keys = sorted(os.environ.keys())
for key in keys:
    print("    " + key + "=" + os.environ[key])
      </file>
    </scons_example>

    <para>

    </para>

    <scons_output example="environments_ex1" suffix="2">
      <scons_output_command>scons -Q</scons_output_command>
    </scons_output>

    -->

    <section>
    <title>Propagating &PATH; From the External Environment</title>

      <para>

      You may want to propagate the external &PATH;
      to the execution environment for commands.
      You do this by initializing the &PATH;
      variable with the &PATH; value from
      the <literal>os.environ</literal>
      dictionary,
      which is Python's way of letting you
      get at the external environment:

      </para>

      <sconstruct>
import os
env = Environment(ENV = {'PATH' : os.environ['PATH']})
      </sconstruct>

      <para>

      Alternatively, you may find it easier
      to just propagate the entire external
      environment to the execution environment
      for commands.
      This is simpler to code than explicity
      selecting the &PATH; value:

      </para>

      <sconstruct>
import os
env = Environment(ENV = os.environ)
      </sconstruct>

      <para>

      Either of these will guarantee that
      &SCons; will be able to execute
      any command that you can execute from the command line.
      The drawback is that the build can behave
      differently if it's run by people with
      different &PATH; values in their environment--for example,
      if both the <literal>/bin</literal> and
      <literal>/usr/local/bin</literal> directories
      have different &cc; commands,
      then which one will be used to compile programs
      will depend on which directory is listed
      first in the user's &PATH; variable.

      </para>

    </section>

    <section>
    <title>Adding to <varname>PATH</varname> Values in the Execution Environment</title>

      <para>

      One of the most common requirements
      for manipulating a variable in the execution environment
      is to add one or more custom directories to a search
      like the <envar>$PATH</envar> variable on Linux or POSIX systems,
      or the <envar>%PATH%</envar> variable on Windows,
      so that a locally-installed compiler or other utility
      can be found when &SCons; tries to execute it to update a target.
      &SCons; provides &PrependENVPath; and &AppendENVPath; functions
      to make adding things to execution variables convenient.
      You call these functions by specifying the variable
      to which you want the value added,
      and then value itself.
      So to add some <filename>/usr/local</filename> directories
      to the <envar>$PATH</envar> and <envar>$LIB</envar> variables,
      you might:

      </para>

      <sconstruct>
env = Environment(ENV = os.environ)
env.PrependENVPath('PATH', '/usr/local/bin')
env.AppendENVPath('LIB', '/usr/local/lib')
      </sconstruct>

      <para>

      Note that the added values are strings,
      and if you want to add multiple directories to
      a variable like <envar>$PATH</envar>,
      you must include the path separate character
      (<literal>:</literal> on Linux or POSIX,
      <literal>;</literal> on Windows)
      in the string.

      </para>

    </section>

  </section>


  <section id="sect-environment-toolpath">
  <title>Using the toolpath for external Tools</title>

    <section>
    <title>The default tool search path</title>

      <para>
      Normally when using a tool from the construction environment,
      several different search locations are checked by default.
      This includes the <literal>Scons/Tools/</literal> directory
      inbuilt to scons and the directory <literal>site_scons/site_tools</literal>
      relative to the root SConstruct file.
      </para>

      <sconstruct>
# Builtin tool or tool located within site_tools
env = Environment(tools = ['SomeTool'])
env.SomeTool(targets, sources)

# The search locations would include by default
SCons/Tool/SomeTool.py
SCons/Tool/SomeTool/__init__.py
./site_scons/site_tools/SomeTool.py
./site_scons/site_tools/SomeTool/__init__.py
      </sconstruct>

    </section>

	<section>
    <title>Providing an external directory to toolpath</title>

      <para>
      In some cases you may want to specify a different location to search for tools.
      The Environment constructor contains an option for this called toolpath
      This can be used to add additional search directories.
      </para>

      <sconstruct>
# Tool located within the toolpath directory option
env = Environment(tools = ['SomeTool'], toolpath = ['/opt/SomeToolPath', '/opt/SomeToolPath2'])
env.SomeTool(targets, sources)

# The search locations in this example would include:
/opt/SomeToolPath/SomeTool.py
/opt/SomeToolPath/SomeTool/__init__.py
/opt/SomeToolPath2/SomeTool.py
/opt/SomeToolPath2/SomeTool/__init__.py
SCons/Tool/SomeTool.py
SCons/Tool/SomeTool/__init__.py
./site_scons/site_tools/SomeTool.py
./site_scons/site_tools/SomeTool/__init__.py
      </sconstruct>

    </section>

	<section>
    <title>Nested Tools within a toolpath</title>

      <para>
      &SCons; 3.0 now supports the ability for a Builder to be located
	  within a sub-directory / sub-package of the toolpath.
	  This is similar to namespacing within python.
	  With nested or namespaced tools we can use the dot notation
	  to specify a sub-directory that the tool is located under.
      </para>

      <sconstruct>
# namespaced target
env = Environment(tools = ['SubDir1.SubDir2.SomeTool'], toolpath = ['/opt/SomeToolPath'])
env.SomeTool(targets, sources)

# With this example the search locations would include
/opt/SomeToolPath/SubDir1/SubDir2/SomeTool.py
/opt/SomeToolPath/SubDir1/SubDir2/SomeTool/__init__.py
SCons/Tool/SubDir1/SubDir2/SomeTool.py
SCons/Tool/SubDir1/SubDir2/SomeTool/__init__.py
./site_scons/site_tools/SubDir1/SubDir2/SomeTool.py
./site_scons/site_tools/SubDir1/SubDir2/SomeTool/__init__.py
      </sconstruct>

      <para>
      For python2 It's important to note when creating tools within sub-directories,
      there needs to be a __init__.py file within each directory.
      This file can just be empty.
      This is the same constraint used by python when loading modules
      from within sub-directories (packages).
      For python3 this appears to be no longer a requirement.
      </para>
    </section>

	<section>
    <title>Using sys.path within the toolpath</title>

      <para>
      If we want to access tools externally to scons on the sys.path
      (one example would be tools installed via the pip package manager)
      One way to do this is to use sys.path with the toolpath.

      One thing to watch out for with this approach is that sys.path
      can sometimes contains paths to .egg files instead of directories.
      So we need to filter those out with this approach.
      </para>

      <sconstruct>
# namespaced target using sys.path within toolpath

searchpaths = []
for item in sys.path:
    if os.path.isdir(item): searchpaths.append(item)

env = Environment(tools = ['someinstalledpackage.SomeTool'], toolpath = searchpaths)
env.SomeTool(targets, sources)
      </sconstruct>

      <para>
      By using sys.path with the toolpath argument
      and by using the nested syntax we can have scons search
      packages installed via pip for Tools.
      </para>

<sconstruct>
# For Windows based on the python version and install directory, this may be something like
C:\Python35\Lib\site-packages\someinstalledpackage\SomeTool.py
C:\Python35\Lib\site-packages\someinstalledpackage\SomeTool\__init__.py

# For Linux this could be something like:
/usr/lib/python3/dist-packages/someinstalledpackage/SomeTool.py
/usr/lib/python3/dist-packages/someinstalledpackage/SomeTool/__init__.py
</sconstruct>

    </section>

	<section>
    <title>Using the &PyPackageDir; function to add to the toolpath</title>

      <para>
      In some cases you may want to use a tool
      located within a installed external pip package.
      This is possible by the use of sys.path with the toolpath.
      However in that situation you need to provide a prefix to the toolname
      to indicate where it is located within sys.path
      </para>

      <sconstruct>
searchpaths = []
for item in sys.path:
    if os.path.isdir(item): searchpaths.append(item)
env = Environment(tools = ['tools_example.subdir1.subdir2.SomeTool'], toolpath = searchpaths)
env.SomeTool(targets, sources)
      </sconstruct>

      <para>
      To avoid the use of a prefix within the name of the tool or filtering sys.path for directories,
      we can use the <function>PyPackageDir(modulename)</function> function to locate the directory of the python package.
      <function>PyPackageDir</function> returns a Dir object which represents the path of the directory
      for the python package / module specified as a parameter.
      </para>

      <sconstruct>
# namespaced target using sys.path
env = Environment(tools = ['SomeTool'], toolpath = [PyPackageDir('tools_example.subdir1.subdir2')])
env.SomeTool(targets, sources)
      </sconstruct>

    </section>

  </section>

</chapter>