doc/python10/install.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE sconsdoc [
   3     <!ENTITY % scons SYSTEM "../scons.mod">
   4     %scons;
   5 ]>
   6
   7 <section id="sect-install"
   8          xmlns="http://www.scons.org/dbxsd/v1.0"
   9          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  10          xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
  11 <title>Installation</title>
  12
  13 <!--
  14
  15   __COPYRIGHT__
  16
  17   Permission is hereby granted, free of charge, to any person obtaining
  18   a copy of this software and associated documentation files (the
  19   "Software"), to deal in the Software without restriction, including
  20   without limitation the rights to use, copy, modify, merge, publish,
  21   distribute, sublicense, and/or sell copies of the Software, and to
  22   permit persons to whom the Software is furnished to do so, subject to
  23   the following conditions:
  24
  25   The above copyright notice and this permission notice shall be included
  26   in all copies or substantial portions of the Software.
  27
  28   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  29   KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  30   WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  31   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  32   LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  33   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  34   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  35
  36 -->
  37
  38 <para>
  39
  40   Initial installation of a new utility provides the first, lasting
  41   impression of how well the software is likely to perform. From the
  42   start, &SCons; has made clean installation a priority.
  43
  44 </para>
  45
  46 <section>
  47   <title>Version Control</title>
  48
  49   <para>
  50
  51     Distributing an application like &SCons; that depends
  52     on a package normally found in a library poses a
  53     problem. If the &scons; script and the &SCons; Build Engine
  54     are installed separately, it could be easy
  55     to introduce a version mismatch between the Build Engine
  56     installed in
  57     <filename>/usr/lib/python*/site-packages</filename>
  58     and the &scons; script installed in
  59     <filename>/usr/bin</filename>.
  60     Such a mismatch
  61     could possible mean exceptions that prevent builds, or even worse,
  62     silently unreliable builds.
  63
  64   </para>
  65
  66   <para>
  67
  68     To reduce the possibility of a version mismatch,
  69     the &scons; script looks first for its
  70     imported modules in <filename>/usr/lib/scons-{version}/</filename>,
  71     then in <filename>/usr/lib/scons/</filename>,
  72     and then in the normal &PYTHONPATH; locations,
  73     including <filename>/usr/lib/python*/site-packages</filename>).
  74     Searching in a version-specific library directory first
  75     makes it convenient to install and use multiple
  76     side-by-side versions of &SCons;,
  77     which is sometimes important
  78     when verifying that a new version does not introduce any
  79     errors into the local build process.
  80     Searching next in an &SCons;-specific library directory
  81     makes it convenient for other software to find
  82     the &SCons; Build Engine without having to worry about
  83     installing separate copies for
  84     multiple versions of Python.
  85
  86   </para>
  87
  88 </section>
  89
  90 <section>
  91   <title>Packages</title>
  92
  93   <para>
  94
  95     &SCons; is currently distributed in the following packages:
  96
  97   </para>
  98
  99   <table>
 100   <title></title>
 101   <tgroup cols="2">
 102     <tbody>
 103
 104     <row valign="top">
 105       <entry>
 106         <literal>scons-</literal><emphasis>version</emphasis><literal>.tar.gz</literal>
 107       </entry>
 108       <entry><para>
 109
 110         The traditional <literal>.tar.gz</literal> file,
 111         installable by running <filename>setup.py</filename>.
 112
 113       </para></entry>
 114     </row>
 115
 116     <row valign="top">
 117       <entry>
 118         <literal>scons-</literal><emphasis>version</emphasis><literal>.noarch.rpm</literal>
 119       </entry>
 120       <entry><para>
 121
 122         An RPM file for typical installation.
 123
 124       </para></entry>
 125     </row>
 126
 127     <row valign="top">
 128       <entry>
 129         <literal>scons-</literal><emphasis>version</emphasis><literal>_all.deb</literal>
 130       </entry>
 131       <entry><para>
 132
 133         A Debian package.
 134
 135       </para></entry>
 136     </row>
 137
 138     <row valign="top">
 139       <entry>
 140         <literal>scons-</literal><emphasis>version</emphasis><literal>.win32.exe</literal>
 141       </entry>
 142       <entry><para>
 143
 144         A Windows installer.
 145
 146       </para></entry>
 147     </row>
 148
 149     <row valign="top">
 150       <entry>
 151         <literal>scons-</literal><emphasis>version</emphasis><literal>.src.rpm</literal>
 152       </entry>
 153       <entry><para>
 154
 155         A source RPM file.
 156
 157       </para></entry>
 158     </row>
 159
 160     <row valign="top">
 161       <entry>
 162         <literal>scons-src-</literal><emphasis>version</emphasis><literal>.tar.gz</literal>
 163       </entry>
 164       <entry><para>
 165
 166         A tarball of the &SCons; source tree,
 167         including the full set of regression tests.
 168
 169       </para></entry>
 170     </row>
 171
 172     </tbody>
 173   </tgroup>
 174   </table>
 175
 176   <para>
 177
 178     Like other software written in Python, &SCons; benefits greatly from
 179     the tremendous effort put into the <literal>distutils</literal> by
 180     Greg Ward and others. These take care of 90% of the work by making
 181     it almost trivial to generate the appropriate RPM files, Debian
 182     packages, and Windows installer.
 183
 184   </para>
 185
 186 </section>
 187
 188 <section>
 189   <title>Default Builder Objects</title>
 190
 191   <para>
 192
 193     As part of the installation process, &SCons; runs a set of scripts
 194     that look for popular compilers and other tools and set up
 195     appropriate default &Builder; objects for the tools found. These
 196     &Builder; objects are then used to initialize the default &consenv;
 197     values.
 198
 199   </para>
 200
 201 </section>
 202
 203 <section>
 204   <title>Default Scanner Objects</title>
 205
 206   <para>
 207
 208     Additionally, &SCons; comes with a stock set of &Scanner; objects
 209     for the various file types that it supports out of the box. Any
 210     unusal &Scanner; objects required for a specific tool will be
 211     detected at installation time and associated with the appropriate
 212     &Builder; object for the tool.
 213
 214   </para>
 215
 216 </section>
 217
 218 </section>