From 68fa66b7d60f9bfb7f18df4bf921918d161a33b2 Mon Sep 17 00:00:00 2001 From: Caspar van Leeuwen Date: Tue, 23 Dec 2025 12:01:31 +0100 Subject: [PATCH] Add description of the new all_readonly_files attribute --- docs/test-suite/writing-portable-tests.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/test-suite/writing-portable-tests.md b/docs/test-suite/writing-portable-tests.md index 10737f6aef..b1c13a4e42 100644 --- a/docs/test-suite/writing-portable-tests.md +++ b/docs/test-suite/writing-portable-tests.md @@ -356,9 +356,17 @@ test, so it can be safely symlinked: ``` readonly_files = ['mpi4py_reduce.py'] ``` -We’ve made the `readonly_files` attribute mandatory for all tests to ensure it’s -not overlooked. If you are sure no files should be symlinked in your test, set -it to `['']`: + +If _all_ files in the source directory are read-only, instead of specifying the full list in `readonly_files` +you can simply define + +``` +all_readonly_files = True +``` +and omit `readonly_files` from your class definition. + +It's mandatory to define either the `readonly_files` or `all_readonly_files` attribute for all tests to ensure it’s +not overlooked. If you are sure no files should be symlinked in your test, you can set: ``` readonly_files = [''] ```