[7.4.x] #11091: documentation should use hypthonated properties (#11750)

github-actions[bot] · web-flow · commit b1f3387d4257 · 2023-12-31T11:50:38.000+02:00
diff --git a/AUTHORS b/AUTHORS
@@ -324,6 +324,7 @@ Ronny Pfannschmidt
 Ross Lawley
 Ruaridh Williamson
 Russel Winder
+Ryan Puddephatt
 Ryan Wooden
 Saiprasad Kale
 Samuel Colvin
diff --git a/changelog/11091.doc.rst b/changelog/11091.doc.rst
@@ -0,0 +1 @@
+Updated documentation to refer to hyphenated options: replaced ``--junitxml`` with ``--junit-xml`` and ``--collectonly`` with ``--collect-only``.
diff --git a/changelog/README.rst b/changelog/README.rst
@@ -14,7 +14,7 @@ Each file should be named like ``<ISSUE>.<TYPE>.rst``, where
 ``<ISSUE>`` is an issue number, and ``<TYPE>`` is one of:
 
 * ``feature``: new user facing features, like new command-line options and new behavior.
-* ``improvement``: improvement of existing functionality, usually without requiring user intervention (for example, new fields being written in ``--junitxml``, improved colors in terminal, etc).
+* ``improvement``: improvement of existing functionality, usually without requiring user intervention (for example, new fields being written in ``--junit-xml``, improved colors in terminal, etc).
 * ``bugfix``: fixes a bug.
 * ``doc``: documentation improvement, like rewording an entire session or adding missing docs.
 * ``deprecation``: feature deprecation.
diff --git a/doc/en/deprecations.rst b/doc/en/deprecations.rst
@@ -596,7 +596,7 @@ By using ``legacy`` you will keep using the legacy/xunit1 format when upgrading
 pytest 6.0, where the default format will be ``xunit2``.
 
 In order to let users know about the transition, pytest will issue a warning in case
-the ``--junitxml`` option is given in the command line but ``junit_family`` is not explicitly
+the ``--junit-xml`` option is given in the command line but ``junit_family`` is not explicitly
 configured in ``pytest.ini``.
 
 Services known to support the ``xunit2`` format:
diff --git a/doc/en/example/markers.rst b/doc/en/example/markers.rst
@@ -136,7 +136,7 @@ Or select multiple nodes:
 
     Node IDs for failing tests are displayed in the test summary info
     when running pytest with the ``-rf`` option.  You can also
-    construct Node IDs from the output of ``pytest --collectonly``.
+    construct Node IDs from the output of ``pytest --collect-only``.
 
 Using ``-k expr`` to select tests based on their name
 -------------------------------------------------------
diff --git a/doc/en/example/simple.rst b/doc/en/example/simple.rst
@@ -1088,4 +1088,4 @@ application with standard ``pytest`` command-line options:
 
 .. code-block:: bash
 
-    ./app_main --pytest --verbose --tb=long --junitxml=results.xml test-suite/
+    ./app_main --pytest --verbose --tb=long --junit=xml=results.xml test-suite/
diff --git a/doc/en/how-to/output.rst b/doc/en/how-to/output.rst
@@ -478,7 +478,7 @@ integration servers, use this invocation:
 
 .. code-block:: bash
 
-    pytest --junitxml=path
+    pytest --junit-xml=path
 
 to create an XML file at ``path``.
 
diff --git a/src/_pytest/junitxml.py b/src/_pytest/junitxml.py
@@ -369,7 +369,7 @@ def test_foo(record_testsuite_property):
     __tracebackhide__ = True
 
     def record_func(name: str, value: object) -> None:
-        """No-op function in case --junitxml was not passed in the command-line."""
+        """No-op function in case --junit-xml was not passed in the command-line."""
         __tracebackhide__ = True
         _check_record_param_type("name", name)
 
diff --git a/src/_pytest/pytester.py b/src/_pytest/pytester.py
@@ -1074,7 +1074,7 @@ def inline_runsource(self, source: str, *cmdlineargs) -> HookRecorder:
         return self.inline_run(*values)
 
     def inline_genitems(self, *args) -> Tuple[List[Item], HookRecorder]:
-        """Run ``pytest.main(['--collectonly'])`` in-process.
+        """Run ``pytest.main(['--collect-only'])`` in-process.
 
         Runs the :py:func:`pytest.main` function to run all of pytest inside
         the test process itself like :py:meth:`inline_run`, but returns a
diff --git a/testing/python/metafunc.py b/testing/python/metafunc.py
@@ -1493,7 +1493,7 @@ def test_foo(x):
                 pass
         """
         )
-        result = pytester.runpytest("--collectonly")
+        result = pytester.runpytest("--collect-only")
         result.stdout.fnmatch_lines(
             [
                 "collected 0 items / 1 error",

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Updated documentation to refer to hyphenated options: replaced ``--junitxml`` with ``--junit-xml`` and ``--collectonly`` with ``--collect-only``.
Original file line number	Diff line number	Diff line change
@@ -1088,4 +1088,4 @@ application with standard ``pytest`` command-line options:
`1088`	`1088`
`1089`	`1089`	`.. code-block:: bash`
`1090`	`1090`
`1091`		`- ./app_main --pytest --verbose --tb=long --junitxml=results.xml test-suite/`
	`1091`	`+ ./app_main --pytest --verbose --tb=long --junit=xml=results.xml test-suite/`
Original file line number	Diff line number	Diff line change
`@@ -1493,7 +1493,7 @@ def test_foo(x):`
`1493`	`1493`	`pass`
`1494`	`1494`	`"""`
`1495`	`1495`	`)`
`1496`		`- result = pytester.runpytest("--collectonly")`
	`1496`	`+ result = pytester.runpytest("--collect-only")`
`1497`	`1497`	`result.stdout.fnmatch_lines(`
`1498`	`1498`	`[`
`1499`	`1499`	`"collected 0 items / 1 error",`