From 6caa7083db16907960067de8565f27ce455c43d0 Mon Sep 17 00:00:00 2001 From: Bruno Oliveira Date: Mon, 28 Sep 2015 18:23:08 -0300 Subject: [PATCH] Moved more detailed options on how to disable a plugin to plugins.rst --- doc/en/cache.rst | 15 ++++++--------- doc/en/plugins.rst | 18 ++++++++++++++++-- 2 files changed, 22 insertions(+), 11 deletions(-) diff --git a/doc/en/cache.rst b/doc/en/cache.rst index bf923cc6f..027376219 100644 --- a/doc/en/cache.rst +++ b/doc/en/cache.rst @@ -10,15 +10,6 @@ cache: working with cross-testrun state is compatible regarding command line options and API usage except that you can only store/receive data between test runs that is json-serializable. - If for any reason you want to disable this plugin, you can do so by - adding ``-p no:cacheprovider`` to the command-line, or more permanently - to your ``pytest.ini`` file: - - .. code-block:: ini - - [pytest] - addopts = -p no:cacheprovider - Usage --------- @@ -36,6 +27,12 @@ all cross-session cache contents ahead of a test run. Other plugins may access the `config.cache`_ object to set/get **json encodable** values between ``py.test`` invocations. +.. note:: + + This plugin is enabled by default, but can be disabled if needed: see + :ref:`cmdunregister` (the internal name for this plugin is + ``cacheprovider``). + Rerunning only failures or failures first ----------------------------------------------- diff --git a/doc/en/plugins.rst b/doc/en/plugins.rst index 48160dafa..51271c077 100644 --- a/doc/en/plugins.rst +++ b/doc/en/plugins.rst @@ -108,8 +108,21 @@ You can prevent plugins from loading or unregister them:: py.test -p no:NAME This means that any subsequent try to activate/load the named -plugin will it already existing. See :ref:`findpluginname` for -how to obtain the name of a plugin. +plugin will not work. + +If you want to unconditionally disable a plugin for a project, you can add +this option to your ``pytest.ini`` file: + +.. code-block:: ini + + [pytest] + addopts = -p no:NAME + +Alternatively to disable it only in certain environments (for example in a +CI server), you can set ``PYTEST_ADDOPTS`` environment variable to +``-p no:name``. + +See :ref:`findpluginname` for how to obtain the name of a plugin. .. _`builtin plugins`: @@ -123,6 +136,7 @@ in the `pytest repository `_. .. autosummary:: _pytest.assertion + _pytest.cacheprovider _pytest.capture _pytest.config _pytest.doctest