From 1e32d0c2c03a1f5aa7c0e4aacf6064502903a4bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Gmach?= Date: Fri, 9 Dec 2022 20:55:54 +0100 Subject: [PATCH] Document that `-v` adds debug info to `--showconfig` and `--help-ini`` (#2652) fixes https://github.com/tox-dev/tox/issues/2622 --- docs/changelog/2622.doc.rst | 2 ++ docs/faq.rst | 2 ++ 2 files changed, 4 insertions(+) create mode 100644 docs/changelog/2622.doc.rst diff --git a/docs/changelog/2622.doc.rst b/docs/changelog/2622.doc.rst new file mode 100644 index 000000000..6d5b9d601 --- /dev/null +++ b/docs/changelog/2622.doc.rst @@ -0,0 +1,2 @@ +Document that running ``--showconfig```or ``--help-ini`` with the ``-v`` flag will add interleaved debugging +information, whereas tox v3 added extra lines at the start - by :user:`jugmac00`. diff --git a/docs/faq.rst b/docs/faq.rst index e3bd41941..84abf84a6 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -93,6 +93,8 @@ tox 4 - CLI arguments changed - When you want to pass an option to a test command, e.g. to ``pytest``, now you must use ``--`` as a separator, this worked with version 3 also, but any unknown trailing arguments were automatically passed through, while now this is no longer the case. +- Running ``--showconfig```or ``--help-ini`` with the ``-v`` flag will add interleaved debugging information, whereas + tox 3 added additional lines at the start. If you want to generate valid ini files you must not use the ``-v`` flag. tox 4 - packaging changes +++++++++++++++++++++++++