Mention the Test Runner section in release notes (#3312)

Add a short mention about the new `Test Runner` section to the release notes. I forgot to include this in #3201.
teemtee · Oct 23, 2024 · bc64a2f · bc64a2f
1 parent 74630a0
commit bc64a2f
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/guide/test-runner.inc.rst b/docs/guide/test-runner.inc.rst
@@ -10,6 +10,8 @@ care of the execution. This section covers some important details
 about common test runners.
 
 
+.. _user-system:
+
 User System
 ------------------------------------------------------------------
 
@@ -29,6 +31,8 @@ you trust the project before executing tests on your system. See
 also the :ref:`/stories/features/feeling-safe` section.
 
 
+.. _testing-farm:
+
 Testing Farm
 ------------------------------------------------------------------
 

diff --git a/docs/releases.rst b/docs/releases.rst
@@ -8,6 +8,11 @@
 tmt-1.38.0
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+A new :ref:`test-runner` section has been added to the tmt
+:ref:`guide`. It describes some important differences between
+running tests on a :ref:`user-system` and scheduling test jobs in
+:ref:`testing-farm`.
+
 The :ref:`/plugins/report/junit` report plugin now removes all
 invalid XML characters from the final JUnit XML.