Changeset 640 for trunk

Show
Ignore:
Timestamp:
02/07/08 04:59:49 (10 months ago)
Author:
artem
Message:

updated scons to 0.97.0d20071212

Location:
trunk/scons
Files:
173 added
2 removed
2 modified

Legend:

Unmodified
Added
Removed
  • trunk/scons/scons-LICENSE

    r499 r640  
     1        Copyright and license for SCons - a software construction tool 
     2 
     3        This copyright and license do not apply to any other software 
     4        with which this software may have been included. 
     5 
    16Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007 The SCons Foundation 
    27 
  • trunk/scons/scons-README

    r499 r640  
    11# Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007 The SCons Foundation 
    2 # src/README.txt 0.97.D001 2007/05/17 11:35:19 knight 
    3  
    42 
    53                 SCons - a software construction tool 
    64 
    7                          Version 0.97 
    8  
    9  
    10 This is a beta release of SCons, a tool for building software (and other 
    11 files).  SCons is implemented in Python, and its "configuration files" 
    12 are actually Python scripts, allowing you to use the full power of a 
    13 real scripting language to solve build problems.  You do not, however, 
    14 need to know Python to use SCons effectively. 
    15  
    16 See the RELEASE.txt file for notes about this specific release, 
    17 including known problems.  See the CHANGES.txt file for a list of 
    18 changes since the previous release. 
    19  
     5This is the scons-README file for a version of SCons packaged for local 
     6execution--that is, execution out of a specific local directory, without 
     7having to install SCons as a system-wide utility. 
     8 
     9You are likely reading this file in one of the following two situations: 
     10 
     11    1)  You have unpacked an scons-local-{version} package and are 
     12        examining the contents. 
     13 
     14        In this case, you are presumably interested in using this 
     15        package to include a local copy of SCons with some other 
     16        software that you package, so that you can use SCons to build 
     17        your software without forcing all of your users to have it fully 
     18        installed.  Instructions for this can be found below. 
     19 
     20        If you are not looking to use SCons in this way, then please 
     21        use either the scons-{version} package to install SCons on your 
     22        system, or the scons-src-{version} package if you want the full 
     23        source to SCons, including its packaging code and underlying 
     24        tests and testing infrastructure. 
     25 
     26    2)  This file was included in some other software package so that 
     27        the package could be built using SCons. 
     28 
     29        In this case, follow the instructions provided with the 
     30        rest of the software package for how to use SCons to build 
     31        and/or install the software.  The file containing build and 
     32        installation instructions will typically be named README or 
     33        INSTALL. 
    2034 
    2135LATEST VERSION 
    2236============== 
    2337 
    24 Before going further, you can check that this package you have is 
    25 the latest version by checking the SCons download page at: 
     38Before going further, you can check for the latest version of the 
     39scons-local package, or any SCons package, at the SCons download page: 
    2640 
    2741        http://www.scons.org/download.html 
     
    3246 
    3347Running SCons requires Python version 1.5.2 or later.  There should be 
    34 no other dependencies or requirements to run SCons.  (There is, however, 
    35 an additional requirement to *install* SCons from this particular 
    36 package; see the next section.) 
    37  
    38 By default, SCons knows how to search for available programming tools 
    39 on various systems--see the SCons man page for details.  You may, 
    40 of course, override the default SCons choices made by appropriate 
     48no other dependencies or requirements to run SCons. 
     49 
     50The default SCons configuration assumes use of the Microsoft Visual C++ 
     51compiler suite on WIN32 systems, and assumes a C compiler named 'cc', 
     52a C++ compiler named 'c++', and a Fortran compiler named 'g77' (such 
     53as found in the GNU C compiler suite) on any other type of system. 
     54You may, of course, override these default values by appropriate 
    4155configuration of Environment construction variables. 
    42  
    43  
    44 INSTALLATION REQUIREMENTS 
    45 ========================= 
    46  
    47 Installing SCons from this package requires the Python distutils 
    48 package.  The distutils package was not shipped as a standard part of 
    49 Python until Python version 1.6, so if your system is running Python 
    50 1.5.2, you may not have distutils installed.  If you are running 
    51 Python version 1.6 or later, you should be fine. 
    52  
    53 NOTE TO RED HAT USERS:  Red Hat shipped Python 1.5.2 as the default all 
    54 the way up to Red Hat Linux 7.3, so you probably do *not* have distutils 
    55 installed, unless you have already done so manually or are running Red 
    56 Hat 8.0 or later. 
    57  
    58 In this case, your options are: 
    59  
    60     --  (Recommended.)  Install from a pre-packaged SCons package that 
    61         does not require distutils: 
    62  
    63             Red Hat Linux       scons-0.97-1.noarch.rpm 
    64  
    65             Debian GNU/Linux    scons_0.97-1_all.deb 
    66                                 (or use apt-get) 
    67  
    68             Windows             scons-0.97.win32.exe 
    69  
    70     --  (Optional.)  Download the latest distutils package from the 
    71         following URL: 
    72  
    73             http://www.python.org/sigs/distutils-sig/download.html 
    74  
    75         Install the distutils according to the instructions on the page. 
    76         You can then proceed to the next section to install SCons from 
    77         this package. 
    7856 
    7957 
     
    8159============ 
    8260 
    83 Assuming your system satisfies the installation requirements in the 
    84 previous section, install SCons from this package simply by running the 
    85 provided Python-standard setup script as follows: 
    86  
    87         # python setup.py install 
    88  
    89 By default, the above command will do the following: 
    90  
    91     --  Install the version-numbered "scons-0.97" and "sconsign-0.97" 
    92         scripts in the default system script directory (/usr/bin or 
    93         C:\Python*\Scripts, for example).  This can be disabled by 
    94         specifying the "--no-version-script" option on the command 
    95         line. 
    96  
    97     --  Install scripts named "scons" and "sconsign" scripts in the 
    98         default system script directory (/usr/bin or C:\Python*\Scripts, 
    99         for example).  This can be disabled by specifying the 
    100         "--no-scons-script" option on the command line, which is useful 
    101         if you want to install and experiment with a new version before 
    102         making it the default on your system. 
    103  
    104         On UNIX or Linux systems, you can have the "scons" and "sconsign" 
    105         scripts be hard links or symbolic links to the "scons-0.97" and 
    106         "sconsign-0.97" scripts by specifying the "--hardlink-scons" 
    107         or "--symlink-scons" options on the command line. 
    108  
    109     --  Install "scons-0.97.bat" and "scons.bat" wrapper scripts in the 
    110         Python prefix directory on Windows (C:\Python*, for example). 
    111         This can be disabled by specifying the "--no-install-bat" option 
    112         on the command line. 
    113  
    114         On UNIX or Linux systems, the "--install-bat" option may be 
    115         specified to have "scons-0.97.bat" and "scons.bat" files 
    116         installed in the default system script directory, which is useful 
    117         if you want to install SCons in a shared file system directory 
    118         that can be used to execute SCons from both UNIX/Linux and 
    119         Windows systems. 
    120  
    121     --  Install the SCons build engine (a Python module) in an 
    122         appropriate version-numbered SCons library directory 
    123         (/usr/lib/scons-0.97 or C:\Python*\scons-0.97, for example). 
    124         See below for more options related to installing the build 
    125         engine library. 
    126  
    127     --  Install the troff-format man pages in an appropriate directory 
    128         on UNIX or Linux systems (/usr/share/man/man1 or /usr/man/man1, 
    129         for example).  This can be disabled by specifying the 
    130         "--no-install-man" option on the command line.  The man pages 
    131         can be installed on Windows systems by specifying the 
    132         "--install-man" option on the command line. 
    133  
    134 Note that, by default, SCons does not install its build engine library 
    135 in the standard Python library directories.  If you want to be able to 
    136 use the SCons library modules (the build engine) in other Python 
    137 scripts, specify the "--standard-lib" option on the command line, as 
    138 follows: 
    139  
    140         # python setup.py install --standard-lib 
    141  
    142 This will install the build engine in the standard Python library 
    143 directory (/usr/lib/python*/site-packages or 
    144 C:\Python*\Lib\site-packages). 
    145  
    146 Alternatively, you can have SCons install its build engine library in a 
    147 hard-coded standalone library directory, instead of the default 
    148 version-numbered directory, by specifying the "--standalone-lib" option 
    149 on the command line, as follows: 
    150  
    151         # python setup.py install --standalone-lib 
    152  
    153 This is usually not recommended, however. 
    154  
    155 Note that, to install SCons in any of the above system directories, 
    156 you should have system installation privileges (that is, "root" or 
    157 "Administrator") when running the setup.py script.  If you don't have 
    158 system installation privileges, you can use the --prefix option to 
    159 specify an alternate installation location, such as your home directory: 
    160  
    161         $ python setup.py install --prefix=$HOME 
    162  
    163 This will install SCons in the appropriate locations relative to 
    164 $HOME--that is, the scons script itself $HOME/bin and the associated 
    165 library in $HOME/lib/scons, for example. 
     61Installation of this package should be as simple as unpacking the 
     62archive (either .tar.gz or .zip) in any directory (top-level or a 
     63subdirectory) within the software package with which you want to ship 
     64SCons. 
     65 
     66Once you have installed this package, you should write an SConstruct 
     67file at the top level of your source tree to build your software as you 
     68see fit. 
     69 
     70Then modify the build/install instructions for your package to instruct 
     71your users to execute SCons as follows (if you installed this package in 
     72your top-level directory): 
     73 
     74        $ python scons.py 
     75 
     76Or (if, for example, you installed this package in a subdirectory named 
     77"scons"): 
     78 
     79        $ python scons/scons.py 
     80 
     81That should be all you have to do.  (If it isn't that simple, please let 
     82us know!) 
     83 
     84 
     85CONTENTS OF THIS PACKAGE 
     86======================== 
     87 
     88This scons-local package consists of the following: 
     89 
     90scons-LICENSE 
     91        A copy of the copyright and terms under which SCons is 
     92        distributed (the Open Source Initiative-approved MIT license). 
     93 
     94        A disclaimer has been added to the beginning to make clear that 
     95        this license applies only to SCons, and not to any separate 
     96        software you've written with which you're planning to package 
     97        SCons. 
     98 
     99scons-README 
     100        What you're looking at right now. 
     101 
     102scons-local-{version}/ 
     103        The SCons build engine.  This is structured as a Python 
     104        library. 
     105 
     106scons.py 
     107        The SCons script itself.  The script sets up the Python 
     108        sys.path variable to use the build engine found in the 
     109        scons-local-{version}/ directory in preference to any other 
     110        SCons build engine installed on your system. 
    166111 
    167112 
     
    169114============= 
    170115 
    171 See the RELEASE.txt file for notes about this specific release, 
    172 including known problems.  See the CHANGES.txt file for a list of 
    173 changes since the previous release. 
    174  
    175 The scons.1 man page is included in this package, and contains a section 
    176 of small examples for getting started using SCons. 
     116Because this package is intended to be included with other software by 
     117experienced users, we have not included any SCons documentation in this 
     118package (other than this scons-README file you're reading right now). 
     119 
     120If, however, you need documentation about SCons, then consult any of the 
     121following from the corresponding scons-{version} or scons-src-{version} 
     122package: 
     123 
     124        The RELEASE.txt file (src/RELEASE.txt file in the 
     125        scons-src-{version} package), which contains notes about this 
     126        specific release, including known problems. 
     127 
     128        The CHANGES.txt file (src/CHANGES.txt file in the 
     129        scons-src-{version} package), which contains a list of changes 
     130        since the previous release. 
     131 
     132        The scons.1 man page (doc/man/scons.1 in the scons-src-{version} 
     133        package), which contains a section of small examples for getting 
     134        started using SCons. 
    177135 
    178136Additional documentation for SCons is available at: 
     
    185143 
    186144SCons is distributed under the MIT license, a full copy of which is 
    187 available in the LICENSE.txt file. The MIT license is an approved Open 
    188 Source license, which means: 
     145available in the scons-LICENSE file in this package. The MIT license is 
     146an approved Open Source license, which means: 
    189147 
    190148        This software is OSI Certified Open Source Software.  OSI 
     
    200158============== 
    201159 
    202 Please report bugs by following the detailed instructions on our Bug 
    203 Submission page: 
    204  
    205         http://scons.tigris.org/bug-submission.html 
    206  
    207 You can also send mail to the SCons developers' mailing list: 
    208  
    209         dev@scons.tigris.org 
    210  
    211 But even if you send email to the mailing list please make sure that you 
    212 ALSO submit a bug report to the project page bug tracker, because bug 
    213 reports in email often get overlooked in the general flood of messages. 
     160You can report bugs either by following the "Tracker - Bugs" link 
     161on the SCons project page: 
     162 
     163        http://sourceforge.net/projects/scons/ 
     164 
     165or by sending mail to the SCons developers mailing list: 
     166 
     167        scons-devel@lists.sourceforge.net 
    214168 
    215169 
     
    217171============= 
    218172 
    219 An active mailing list for users of SCons is available.  You may send 
    220 questions or comments to the list at: 
    221  
    222         users@scons.tigris.org 
    223  
    224 You may subscribe to the mailing list by sending email to: 
    225  
    226         users-subscribe@scons.tigris.org 
    227  
    228 There is also a low-volume mailing list available for announcements 
    229 about SCons.  Subscribe by sending email to: 
    230  
    231         announce-subscribe@scons.tigris.org 
    232  
    233 There are other mailing lists available for SCons developers, for 
    234 notification of SCons code changes, and for notification of updated 
    235 bug reports and project documents.  Please see our mailing lists page 
    236 for details. 
    237  
    238  
    239 DONATIONS 
    240 ========= 
    241  
    242 If you find SCons helpful, please consider making a donation (of cash, 
    243 software, or hardware) to support continued work on the project. 
    244 Information is available at: 
    245  
    246         http://www.scons.org/donate.html 
     173A mailing list for users of SCons is available.  You may send questions 
     174or comments to the list at: 
     175 
     176        scons-users@lists.sourceforge.net 
     177 
     178You may subscribe to the scons-users mailing list at: 
     179 
     180        http://lists.sourceforge.net/lists/listinfo/scons-users 
    247181 
    248182 
     
    266200        Charles Crain 
    267201        Steve Leblanc 
    268         Greg Noel 
    269         Gary Oberbrunner 
    270202        Anthony Roach 
    271         Greg Spencer 
    272         Christoph Wiedemann 
    273  
     203        Terrel Shumway 
     204