#108 - Update docs

tum-esm · Oct 18, 2022 · b0390e0 · b0390e0
1 parent 078bab7
commit b0390e0
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/packages/docs/docs/index.mdx b/packages/docs/docs/index.mdx
@@ -29,6 +29,7 @@ This documentation page serves as a guide for both users and developers. By user
 -   How to [use it and work with the command line interface](/docs/user-guide/usage)
 -   How the [upload](/docs/user-guide/upload) works
 -   What the [TUM PLC and Helios](/docs/user-guide/tum-plc-and-helios)
+-   Answers to [frequently asked euestions](/docs/user-guide/faq)
 
 **For developers:**
 

diff --git a/packages/docs/docs/user-guide/faq.mdx b/packages/docs/docs/user-guide/faq.mdx
@@ -0,0 +1,22 @@
+---
+sidebar_position: 6
+sidebar_label: FAQ
+---
+
+# FAQ
+
+## Pyra Shows a `filelock._error.Timeout` Exception
+
+In theory it is possible that Pyra encounters a deadlock when reading state or log files - although we have never encountered it yet. The error message will say something like this:
+
+```
+filelock._error.Timeout: The file lock 'C:\Users\ga56fem\Downloads\pyra\pyra-4.0.6\config\.state.lock' could not be acquired.
+```
+
+You can use the CLI command `pyra-cli remove-filelocks` to resolve that.
+
+```note
+
+We are using the python library `filelock` to enforce exclusive use of state- and log-files: There should not be two processes interacting with one of these files at the same time. This is necessary because we have at least 4 processes that work with these files: the CLI and the main-, upload- and helios-thread.
+
+```