Skip to content

Add description of the new all_readonly_files attribute #650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
satishskamath merged 1 commit into from
Dec 23, 2025
Merged

Add description of the new all_readonly_files attribute #650

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions docs/test-suite/writing-portable-tests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = ['']
```
Expand Down