From 2467831913885d718f9eed33733456b3074eec06 Mon Sep 17 00:00:00 2001 From: Yoav Caspi Date: Wed, 9 Jan 2019 23:52:08 +0200 Subject: [PATCH] rephrase warning section to explain better the issue. --- doc/en/reference.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/doc/en/reference.rst b/doc/en/reference.rst index ac00f532201..92e298a88e8 100644 --- a/doc/en/reference.rst +++ b/doc/en/reference.rst @@ -889,8 +889,11 @@ Here is a list of builtin configuration options that may be written in a ``pytes file, usually located at the root of your repository. All options must be under a ``[pytest]`` section (``[tool:pytest]`` for ``setup.cfg`` files). -.. warning:: usage of configuration file different than the canonical, i.e. ``pytest.ini`` - can break other tools configurations. +.. warning:: + Usage of ``setup.cfg`` is not recommended unless for very simple use cases. ``.cfg`` + files use a different parser than ``pytest.ini`` and ``tox.ini`` which might cause hard to track + down problems. + When possible, it is recommended to use the latter files to hold your pytest configuration. Configuration file options may be overwritten in the command-line by using ``-o/--override``, which can also be passed multiple times. The expected format is ``name=value``. For example::