Skip to content

Commit 3302371

Browse files
authored
Merge pull request #3552 from vkarak/doc/develop-cherry-picks
[doc] Documentation enhancements
2 parents e1a3bc5 + 8eee0f4 commit 3302371

File tree

4 files changed

+14
-0
lines changed

4 files changed

+14
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,3 +133,5 @@ The corresponding BibTeX entry is the following:
133133
issn = {1865-0937},
134134
}
135135
```
136+
137+
For a complete list of publications and talks about ReFrame, please refer to the latest documentation page [here](https://reframe-hpc.readthedocs.io/en/latest/#publications).

README_minimal.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,3 +75,5 @@ The corresponding BibTeX entry is the following:
7575
issn = {1865-0937},
7676
}
7777
```
78+
79+
For a complete list of publications and talks about ReFrame, please refer to the latest documentation page [here](https://reframe-hpc.readthedocs.io/en/latest/#publications).

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Publications
2323
Presentations & Talks
2424
---------------------
2525

26+
* [`slides + talk <https://fosdem.org/2025/schedule/event/fosdem-2025-4755-adding-built-in-support-for-basic-performance-test-analytics-to-reframe/>`__] "Adding built-in support for basic performance test analytics to ReFrame," `FOSDEM 25 <https://fosdem.org/2025/>`__.
2627
* [`slides <https://drive.google.com/file/d/1cwlIipJtJoD-0xGcDMxbL4FQe3xtwAen/view?usp=sharing>`__] "Introduction to ReFrame," CINECA visit, Jun 2024.
2728
* [`slides <https://users.ugent.be/~kehoste/eum24/008_eum24_ReFrame.pdf>`__][`recording <https://www.youtube.com/live/uSEeU-VJf6k?si=YB19mFpG6aAEBOgH>`__] "Recent Advances in ReFrame," `9th EasyBuild User Meeting 2024 <https://easybuild.io/eum24/>`__.
2829
* [`slides <https://docs.google.com/presentation/d/1GmO2Uf29SaLg36bPB9g9eeaKMN-bLlDJ5IvLGLQJfD8/edit?usp=share_link>`__][`recording <https://youtu.be/0ApEKc185Bw>`__] "Recent Advances in ReFrame," `8th EasyBuild User Meeting 2023 <https://easybuild.io/eum23/>`__.

docs/regression_test_api.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,10 @@ the run hooks of :class:`Y` will be executed as follows:
158158
.. seealso::
159159
- :func:`@run_before <reframe.core.builtins.run_before>`, :func:`@run_after <reframe.core.builtins.run_after>` decorators
160160

161+
.. note::
162+
163+
Pipeline hook functions cannot be private, i.e., starting with double underscore: ``__``.
164+
161165
.. note::
162166
Pipeline hooks do not execute in the test's stage directory, but in the directory that ReFrame executes in.
163167
However, the test's :attr:`~reframe.core.pipeline.RegressionTest.stagedir` can be accessed by explicitly changing the working directory from within the hook function itself (see the :class:`~reframe.utility.osext.change_dir` utility for further details):
@@ -197,6 +201,11 @@ the run hooks of :class:`Y` will be executed as follows:
197201
This version defines the execution order of hooks, which now follows a strict reverse MRO order, so that parent hooks will execute before those of derived classes.
198202
Tests that relied on the execution order of hooks might break with this change.
199203

204+
.. tip::
205+
206+
When writing library tests or :class:`~reframe.core.pipeline.RegressionMixin`'s that are meant to be re-used by multiple final tests, it is a good practice to define their hooks using a unique name scheme, e.g., ``_<ClassName>_<hook_name>``.
207+
This will avoid possible clashes with hooks in derived test classes that may use the same hook name hiding inadvertently the base class hook.
208+
Note that in future ReFrame may create unique names for pipeline hooks automatically.
200209

201210

202211
.. _test-variants:

0 commit comments

Comments
 (0)