From 49dfc1c73219f997cf05da2736b180c69d42f2ef Mon Sep 17 00:00:00 2001 From: Yoav Caspi Date: Sun, 6 Jan 2019 22:47:40 +0200 Subject: [PATCH 1/2] add warning for using setup.cfg --- doc/en/reference.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/en/reference.rst b/doc/en/reference.rst index 9305cbb9586..ac00f532201 100644 --- a/doc/en/reference.rst +++ b/doc/en/reference.rst @@ -889,6 +889,9 @@ 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. + 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:: From d12d69277673aa066488c3b6acf4c990a103f14f Mon Sep 17 00:00:00 2001 From: Yoav Caspi Date: Sun, 6 Jan 2019 22:56:54 +0200 Subject: [PATCH 2/2] update changelog --- changelog/3375.doc.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog/3375.doc.rst diff --git a/changelog/3375.doc.rst b/changelog/3375.doc.rst new file mode 100644 index 00000000000..8fa7e227228 --- /dev/null +++ b/changelog/3375.doc.rst @@ -0,0 +1 @@ +document that not using the canonical configfile may crash other tools