openstack/deb-python-eventlet
Code Issues Proposed changes

Doc tweaks.

Browse Source
This commit is contained in:
Ryan Williams
2010-07-30 19:20:18 -07:00
parent 18e84216d4
commit 3c8dc49421
3 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/environment.rst
View File

@@ -1,3 +1,5 @@
.. _env_vars:
Environment Variables
======================

4
doc/hubs.rst
View File

@@ -14,9 +14,9 @@ Eventlet has multiple hub implementations, and when you start using it, it tries
**selects**
Lowest-common-denominator, available everywhere.
**pyevent**
This is a libevent-based backend and is thus the fastest. It's disabled by default, because it does not support native threads, but you can enable it yourself if your use case doesn't require them.
This is a libevent-based backend and is thus the fastest. It's disabled by default, because it does not support native threads, but you can enable it yourself if your use case doesn't require them. (You have to install pyevent, too.)
If the selected hub is not idea for the application, another can be selected.
If the selected hub is not idea for the application, another can be selected. You can make the selection either with the environment variable :ref:`EVENTLET_HUB <env_vars>`, or with use_hub.
.. function:: eventlet.hubs.use_hub(hub=None)

4
doc/threading.rst
View File

@@ -9,7 +9,7 @@ You can only communicate cross-thread using the "real" thread primitives and pip
The vast majority of the times you'll want to use threads are to wrap some operation that is not "green", such as a C library that uses its own OS calls to do socket operations. The :mod:`~eventlet.tpool` module is provided to make these uses simpler.
The pyevent hub is not compatible with threads.
The optional :ref:`pyevent hub <understanding_hubs>` is not compatible with threads.
Tpool - Simple thread pool
---------------------------
@@ -27,4 +27,4 @@ The simplest thing to do with :mod:`~eventlet.tpool` is to :func:`~eventlet.tpoo
By default there are 20 threads in the pool, but you can configure this by setting the environment variable ``EVENTLET_THREADPOOL_SIZE`` to the desired pool size before importing tpool.
.. automodule:: eventlet.tpool
:members:
:members: