Improve user guidance regarding --resultlog deprecation

Fix pytest-dev#2739
nicoddemus · Aug 31, 2017 · 3288c9a · 3288c9a · thebjorn · Sep 1, 2017
1 parent 539523c
commit 3288c9a
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 2 deletions.
diff --git a/_pytest/deprecated.py b/_pytest/deprecated.py
@@ -26,7 +26,10 @@ class RemovedInPytest4Warning(DeprecationWarning):
 
 GETFUNCARGVALUE = "use of getfuncargvalue is deprecated, use getfixturevalue"
 
-RESULT_LOG = '--result-log is deprecated and scheduled for removal in pytest 4.0'
+RESULT_LOG = (
+    '--result-log is deprecated and scheduled for removal in pytest 4.0.\n'
+    'See https://docs.pytest.org/en/latest/usage.html#creating-resultlog-format-files for more information.'
+)
 
 MARK_INFO_ATTRIBUTE = RemovedInPytest4Warning(
     "MarkInfo objects are deprecated as they contain the merged marks"

diff --git a/changelog/2739.trivial b/changelog/2739.trivial
@@ -0,0 +1 @@
+Improve user guidance regarding ``--resultlog`` deprecation.
diff --git a/doc/en/usage.rst b/doc/en/usage.rst
@@ -311,6 +311,13 @@ Creating resultlog format files
 
     This option is rarely used and is scheduled for removal in 4.0.
 
+    An alternative for users which still need similar functionality is to use the
+    `pytest-tap <https://pypi.python.org/pypi/pytest-tap>`_ plugin which provides
+    a stream of test data.
+
+    If you have any concerns, please don't hesitate to
+    `open an issue <https://github.com/pytest-dev/pytest/issues>`_.
+
 To create plain-text machine-readable result files you can issue::
 
     pytest --resultlog=path

diff --git a/testing/deprecated_test.py b/testing/deprecated_test.py
@@ -78,4 +78,7 @@ def test():
             pass
     ''')
     result = testdir.runpytest('--result-log=%s' % testdir.tmpdir.join('result.log'))
-    result.stdout.fnmatch_lines(['*--result-log is deprecated and scheduled for removal in pytest 4.0*'])
+    result.stdout.fnmatch_lines([
+        '*--result-log is deprecated and scheduled for removal in pytest 4.0*',
+        '*See https://docs.pytest.org/*/usage.html#creating-resultlog-format-files for more information*',
+    ])
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Improve user guidance regarding ``--resultlog`` deprecation.
	def pytest_addoption(parser):
	group = parser.getgroup("terminal reporting", "resultlog plugin options")
	group.addoption('--resultlog', '--result-log', action="store",
	metavar="path", default=None,
	help="DEPRECATED path for machine-readable result log.")