From 13abab83bf92c2d8b2396904e32bfee292bb9ea7 Mon Sep 17 00:00:00 2001 From: Vasileios Karakasis Date: Sat, 3 Sep 2022 11:15:57 +0200 Subject: [PATCH] Add a warning in documentation about `perf_patterns` --- reframe/core/pipeline.py | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/reframe/core/pipeline.py b/reframe/core/pipeline.py index 4911cff8df..2f789437b4 100644 --- a/reframe/core/pipeline.py +++ b/reframe/core/pipeline.py @@ -702,9 +702,6 @@ def pipeline_hooks(cls): #: Patterns for verifying the performance of this test. #: - #: Refer to the :doc:`ReFrame Tutorials ` for concrete usage - #: examples. - #: #: If set to :class:`None`, no performance checking will be performed. #: #: :type: A dictionary with keys of type :class:`str` and deferrable @@ -712,6 +709,14 @@ def pipeline_hooks(cls): #: `) as values. #: :class:`None` is also allowed. #: :default: :class:`None` + #: + #: .. warning:: + #: + #: You are advised to follow the new syntax for defining performance + #: variables in your tests using either the :func:`@performance_function + #: ` builtin or the + #: :attr:`perf_variables`, as :attr:`perf_patterns` will likely be + #: deprecated in the future. perf_patterns = variable(typ.Dict[str, _DeferredExpression], type(None)) #: The performance variables associated with the test. @@ -725,7 +730,7 @@ def pipeline_hooks(cls): #: By default, ReFrame will populate this field during the test's #: instantiation with all the member functions decorated with the #: :func:`@performance_function - #: ` decorator. + #: ` decorator. #: If no performance functions are present in the class, no performance #: checking or reporting will be carried out. #: @@ -743,7 +748,7 @@ def pipeline_hooks(cls): #: :ref:`deferrable-performance-functions`). #: :default: Collection of performance variables associated to each of #: the member functions decorated with the :func:`@performance_function - #: ` + #: ` #: decorator. #: #: .. versionadded:: 3.8.0