Introduce a new page for release notes

Let's document the more interesting features so that users are aware of what's new in each release.
teemtee · Jun 5, 2024 · caecd1d · caecd1d
1 parent dcab598
commit caecd1d
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 0 deletions.
diff --git a/docs/features.rst b/docs/features.rst
@@ -229,6 +229,8 @@ The key content attributes are not supposed to be hard-coded in
 the Flexible Metadata Format but freely configurable. Multiple key
 content attributes (e.g. script & backend) could be used as well.
 
+.. _select:
+
 Select
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -23,6 +23,7 @@ Table of Contents
     Examples <examples>
     Modules <modules>
     Contribute <contribute>
+    Releases <releases>
 
 Indices and Tables
 ==================

diff --git a/docs/releases.rst b/docs/releases.rst
@@ -0,0 +1,29 @@
+.. _releases:
+
+======================
+    Releases
+======================
+
+fmf-1.4
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The :py:func:`fmf.filter()` function now supports **searching by
+node name**. Just specify the desired name instead of the ``key:
+value`` pair. For example, to search for all tests with the name
+starting with ``/test/core`` and tag ``quick`` you can do::
+
+    /tests/core/.* & tag: quick
+
+It is now possible to **escape boolean operators** ``|`` and ``&``
+as well. This allows to use more complex regular expressions like
+this::
+
+    tag: Tier(1\|2\|3)
+
+The new :ref:`select<select>` directive can be used to **include
+branch nodes or skip leaf nodes** when searching the tree using
+the :py:meth:`fmf.Tree.climb` method.
+
+The :py:meth:`fmf.Tree.adjust` method now supports new parameter
+``additional_rules`` for providing **additional adjust rules**
+which are applied after the rules detected in the node itself.