Skip to content

Commit

Permalink
Disabled speedups by default.
Browse files Browse the repository at this point in the history
--HG--
branch : trunk
  • Loading branch information
mitsuhiko committed Sep 13, 2009
1 parent 77af572 commit 9ebc457
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 15 deletions.
1 change: 0 additions & 1 deletion .hgtags
Expand Up @@ -2,4 +2,3 @@
344f2e5078d202663a08b50cf3a5f44da2a2cb54 2.0
bac88fe8bc0e50b321a04eea038ed4542c43a62f 2.1
ac0fc30f7b5ffca59769c5d9ed78f50596868af8 2.1.1
351fcae4774bf280000cc4cf941ba5d3ce7d2839 2.2
25 changes: 13 additions & 12 deletions docs/intro.rst
Expand Up @@ -38,13 +38,14 @@ C-compiler is available and you are using Python 2.4 the `ctypes`_ module
should be installed.

If you don't have a working C compiler and you are trying to install the source
release you will get a compiler error. This however can be circumvented by
passing the ``--without-speedups`` command line argument to the setup script::
release with the speedups you will get a compiler error. This however can be
circumvented by passing the ``--without-speedups`` command line argument to the
setup script::

$ python setup.py install --without-speedups
$ python setup.py install --with-speedups

For more details about that have a look at the :ref:`disable-speedups`
section below.
(As of Jinja 2.2, the speedups are disabled by default and can be enabled
with ``--with-speedups``. See :ref:`enable-speedups`)

.. _ctypes: http://python.net/crew/theller/ctypes/

Expand Down Expand Up @@ -109,23 +110,23 @@ Or the new `pip`_ command::
.. _pip: http://pypi.python.org/pypi/pip
.. _mercurial: http://www.selenic.com/mercurial/

.. _disable-speedups:
.. _enable-speedups:

Disable the speedups Module
Enaable the speedups Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~

By default Jinja2 will try to compile the speedups module. This of course
By default Jinja2 will not compile the speedups module. Enabling this
will fail if you don't have the Python headers or a working compiler. This
is often the case if you are installing Jinja2 from a windows machine.

You can disable the speedups extension when installing using the
``--without-speedups`` flag::
You can enable the speedups extension when installing using the
``--with-speedups`` flag::

sudo python setup.py install --without-speedups
sudo python setup.py install --with-speedups

You can also pass this parameter to `pip`::

$ pip install --install-option='--without-speedups' Jinja2
$ pip install --install-option='--with-speedups' Jinja2


Basic API Usage
Expand Down
3 changes: 1 addition & 2 deletions setup.py
Expand Up @@ -71,10 +71,9 @@
'Topic :: Text Processing :: Markup :: HTML'
],
packages=['jinja2'],
data_files=data_files,
features={
'speedups': Feature("optional C speed-enhancements",
standard=True,
standard=False,
ext_modules=[
Extension('jinja2._speedups', ['jinja2/_speedups.c'])
]
Expand Down

0 comments on commit 9ebc457

Please sign in to comment.