Skip to content

Commit 1e32d0c

Browse files
authored
Document that -v adds debug info to --showconfig and --help-ini` (#2652)
fixes #2622
1 parent 3636006 commit 1e32d0c

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

docs/changelog/2622.doc.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Document that running ``--showconfig```or ``--help-ini`` with the ``-v`` flag will add interleaved debugging
2+
information, whereas tox v3 added extra lines at the start - by :user:`jugmac00`.

docs/faq.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ tox 4 - CLI arguments changed
9393
- When you want to pass an option to a test command, e.g. to ``pytest``, now you must use ``--`` as a separator, this
9494
worked with version 3 also, but any unknown trailing arguments were automatically passed through, while now this is
9595
no longer the case.
96+
- Running ``--showconfig```or ``--help-ini`` with the ``-v`` flag will add interleaved debugging information, whereas
97+
tox 3 added additional lines at the start. If you want to generate valid ini files you must not use the ``-v`` flag.
9698

9799
tox 4 - packaging changes
98100
+++++++++++++++++++++++++

0 commit comments

Comments
 (0)