]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
add docs regarding flags only working with setuptools/distribute, [ticket:2341]
authorMike Bayer <mike_mp@zzzcomputing.com>
Tue, 6 Dec 2011 19:28:54 +0000 (14:28 -0500)
committerMike Bayer <mike_mp@zzzcomputing.com>
Tue, 6 Dec 2011 19:28:54 +0000 (14:28 -0500)
doc/build/intro.rst

index 39f02b3dd36c66a20ec983471fa54ea12b551330..52180a91bbb41dae4ffa1d81d2e9061bbeb8b474 100644 (file)
@@ -99,6 +99,9 @@ SQLAlchemy supports installation using standard Python "distutils" or
   rides on top of ``setuptools`` or ``distribute``, replacing the usage
   of ``easy_install``.  It is often preferred for its simpler mode of usage.
 
+.. note:: It is strongly recommended that either ``setuptools`` or ``distribute`` be installed.
+   Python's built-in ``distutils`` lacks many widely used installation features.
+
 Install via easy_install or pip
 -------------------------------
 
@@ -138,6 +141,11 @@ pass the flag ``--without-cextensions`` to the ``setup.py`` script::
 
     python setup.py --without-cextensions install
 
+.. note:: The ``--without-cextensions`` flag is available **only** if ``setuptools``
+   or ``distribute`` is installed.  It is not available on a plain Python ``distutils``
+   installation.  The library will still install without the C extensions if they
+   cannot be built, however.
+
 Installing on Python 3
 ----------------------------------