Skip to content

Commit 6392446

Browse files
authored
Merge pull request #3457 from teojgo/doc/db_lock
[doc] Document the requirement of file lock support for enabling results storage
2 parents 64f6338 + 3cd552e commit 6392446

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/manpage.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1348,6 +1348,13 @@ Since the report file information is now kept in the results database, there is
13481348
You can disable the report generation by turning off the :attr:`~config.general.generate_file_reports` configuration parameter.
13491349
The file report of any session can be retrieved from the database with the :option:`--describe-stored-sessions` option.
13501350

1351+
.. warning::
1352+
1353+
ReFrame uses file locking to coordinate storing of run session data in the database file.
1354+
Enabling the database storage on filesystems that do not support locking (e.g some networked filesystems) might lead to hangs at the end of a run session.
1355+
For this reason, you must make sure that the database file is located on a filesystem that supports locking.
1356+
You can set the database location through the :attr:`~config.storage.sqlite_db_file` configuration setting or the :envvar:`RFM_SQLITE_DB_FILE` environment variable.
1357+
13511358

13521359
.. _querying-past-results:
13531360

0 commit comments

Comments
 (0)