Fix typo in --worker-class documentation (#2030)

This commit is contained in:
Sebastien Williams-Wynn 2019-05-09 19:13:31 +01:00 committed by Berker Peksag
parent a542a07773
commit 678b326dc0
3 changed files with 20 additions and 25 deletions

View File

@ -363,6 +363,18 @@ statsd_host
.. versionadded:: 19.1 .. versionadded:: 19.1
.. _dogstatsd-tags:
dogstatsd_tags
~~~~~~~~~~~~~~
* ``--dogstatsd-tags DOGSTATSD_TAGS``
* ``(empty string)``
A comma-delimited list of datadog statsd (dogstatsd) tags to append to statsd metrics.
.. versionadded:: 20
.. _statsd-prefix: .. _statsd-prefix:
statsd_prefix statsd_prefix
@ -376,17 +388,6 @@ if not provided).
.. versionadded:: 19.2 .. versionadded:: 19.2
dogstatsd_tags
~~~~~~~~~~~~~~
* ``--dogstatsd-tags DOGSTATSD_TAGS``
* ``(empty string)``
Comma-delimited list of static dogstatsd (datadog statsd) tags sent with all statsd metrics
See: `Datadog Docs <https://docs.datadoghq.com/developers/dogstatsd/>`
.. versionadded:: 20
Process Naming Process Naming
-------------- --------------
@ -1213,31 +1214,25 @@ The type of workers to use.
The default class (``sync``) should handle most "normal" types of The default class (``sync``) should handle most "normal" types of
workloads. You'll want to read :doc:`design` for information on when workloads. You'll want to read :doc:`design` for information on when
you might want to choose one of the other worker classes. Required you might want to choose one of the other worker classes. Required
libraries may be installed using setuptools' ``extra_require`` feature. libraries may be installed using setuptools' ``extras_require`` feature.
A string referring to one of the following bundled classes: A string referring to one of the following bundled classes:
* ``sync`` * ``sync``
* ``eventlet`` - Requires eventlet >= 0.9.7 (or install it via * ``eventlet`` - Requires eventlet >= 0.24.1 (or install it via
``pip install gunicorn[eventlet]``) ``pip install gunicorn[eventlet]``)
* ``gevent`` - Requires gevent >= 0.13 (or install it via * ``gevent`` - Requires gevent >= 1.4 (or install it via
``pip install gunicorn[gevent]``) ``pip install gunicorn[gevent]``)
* ``tornado`` - Requires tornado >= 0.2 (or install it via * ``tornado`` - Requires tornado >= 0.2 (or install it via
``pip install gunicorn[tornado]``) ``pip install gunicorn[tornado]``)
* ``gthread`` - Python 2 requires the futures package to be installed * ``gthread`` - Python 2 requires the futures package to be installed
(or install it via ``pip install gunicorn[gthread]``) (or install it via ``pip install gunicorn[gthread]``)
* ``gaiohttp`` - Deprecated.
Optionally, you can provide your own worker by giving Gunicorn a Optionally, you can provide your own worker by giving Gunicorn a
Python path to a subclass of ``gunicorn.workers.base.Worker``. Python path to a subclass of ``gunicorn.workers.base.Worker``.
This alternative syntax will load the gevent class: This alternative syntax will load the gevent class:
``gunicorn.workers.ggevent.GeventWorker``. ``gunicorn.workers.ggevent.GeventWorker``.
.. deprecated:: 19.8
The ``gaiohttp`` worker is deprecated. Please use
``aiohttp.worker.GunicornWebWorker`` instead. See
:ref:`asyncio-workers` for more information on how to use it.
.. _threads: .. _threads:
threads threads
@ -1273,7 +1268,7 @@ worker_connections
The maximum number of simultaneous clients. The maximum number of simultaneous clients.
This setting only affects the Eventlet, Gevent and Gthread worker types. This setting only affects the Eventlet and Gevent worker types.
.. _max-requests: .. _max-requests:

View File

@ -625,7 +625,7 @@ class WorkerClass(Setting):
The default class (``sync``) should handle most "normal" types of The default class (``sync``) should handle most "normal" types of
workloads. You'll want to read :doc:`design` for information on when workloads. You'll want to read :doc:`design` for information on when
you might want to choose one of the other worker classes. Required you might want to choose one of the other worker classes. Required
libraries may be installed using setuptools' ``extra_require`` feature. libraries may be installed using setuptools' ``extras_require`` feature.
A string referring to one of the following bundled classes: A string referring to one of the following bundled classes:

View File

@ -73,7 +73,7 @@ install_requires = [
'setuptools>=3.0', 'setuptools>=3.0',
] ]
extra_require = { extras_require = {
'gevent': ['gevent>=0.13'], 'gevent': ['gevent>=0.13'],
'eventlet': ['eventlet>=0.9.7'], 'eventlet': ['eventlet>=0.9.7'],
'tornado': ['tornado>=0.2'], 'tornado': ['tornado>=0.2'],
@ -108,5 +108,5 @@ setup(
[paste.server_runner] [paste.server_runner]
main=gunicorn.app.pasterapp:serve main=gunicorn.app.pasterapp:serve
""", """,
extras_require=extra_require, extras_require=extras_require,
) )