From f567a12c208ee1daad3d6236158c788573a5d9bc Mon Sep 17 00:00:00 2001 From: Till Ehrengruber Date: Mon, 2 Dec 2024 13:20:34 +0100 Subject: [PATCH] Improve docs --- src/gt4py/next/program_processors/runners/gtfn.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/gt4py/next/program_processors/runners/gtfn.py b/src/gt4py/next/program_processors/runners/gtfn.py index 2ed427d728..41eebbeb01 100644 --- a/src/gt4py/next/program_processors/runners/gtfn.py +++ b/src/gt4py/next/program_processors/runners/gtfn.py @@ -145,10 +145,12 @@ class FileCache(diskcache.Cache): This class extends `diskcache.Cache` to ensure the cache is properly - opened when accessed by multiple processes using a file lock. This guards the creating of the cache object, which has been reported to cause `sqlite3.OperationalError: database is locked` - errors and slow startup times when multiple processes access the cache concurrently. While - this issue occurred frequently and was observed to be fixed on distributed file systems, the - lock does not guarantee correct behavior in particular for the accesses to the cache (beyond - opening. See #1745 for more details. + errors and slow startup times when multiple processes access the cache concurrently. While this + issue occurred frequently and was observed to be fixed on distributed file systems, the lock + does not guarantee correct behavior in particular for accesses to the cache (beyond opening) + since the underlying SQLite database is unreliable when stored on an NFS based file system. + It does however ensure correctness off concurrent cache accesses on a local file system. See + #1745 for more details. - closed upon deletion, i.e. it ensures that any resources associated with the cache are properly released when the instance is garbage collected. """