From 2ab8d12fe3ebed9716786408798da7e25789b8af Mon Sep 17 00:00:00 2001 From: Dmitri Pribysh Date: Fri, 12 May 2017 04:54:15 +0300 Subject: [PATCH] Update changelog and add usage info --- CHANGELOG.rst | 3 ++- doc/en/usage.rst | 9 +++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index d408ff551..bdacbed89 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,7 +5,7 @@ New Features ------------ -* junitxml: Add `--junit-suite-name` option to specify root `` name for JUnit XML reports +* fix `#533`_: Added ``junit_suite_name`` ini option to specify root `` name for JUnit XML reports * Added an ini option ``doctest_encoding`` to specify which encoding to use for doctest files. Thanks `@wheerd`_ for the PR (`#2101`_). @@ -105,6 +105,7 @@ Bug Fixes .. _@ojii: https://github.com/ojii +.. _#533: https://github.com/pytest-dev/pytest/issues/533 .. _#1407: https://github.com/pytest-dev/pytest/issues/1407 .. _#1512: https://github.com/pytest-dev/pytest/issues/1512 .. _#1821: https://github.com/pytest-dev/pytest/issues/1821 diff --git a/doc/en/usage.rst b/doc/en/usage.rst index f6c20a978..763328f5a 100644 --- a/doc/en/usage.rst +++ b/doc/en/usage.rst @@ -177,6 +177,15 @@ integration servers, use this invocation:: to create an XML file at ``path``. +.. versionadded:: 3.1 + +To set the name of the root test suite xml item, you can configure the ``junit_suite_name`` option in your config file: + +.. code-block:: ini + + [pytest] + junit_suite_name = my_suite + record_xml_property ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^