diff options
| author | Christian Neukirchen <chneukirchen@gmail.com> | 2015-08-10 13:28:18 +0200 |
|---|---|---|
| committer | Christian Neukirchen <chneukirchen@gmail.com> | 2015-08-10 13:28:18 +0200 |
| commit | 62bf9cc5a08d524c2acaff22c34ff5c6943e2454 (patch) | |
| tree | 4f309df59b903c0918855c861b91ce6de1200f2f | |
| parent | dafba4fe7102df3a123b33b95b69cb2577e39cc3 (diff) | |
| download | nq-62bf9cc5a08d524c2acaff22c34ff5c6943e2454.tar.gz nq-62bf9cc5a08d524c2acaff22c34ff5c6943e2454.tar.xz nq-62bf9cc5a08d524c2acaff22c34ff5c6943e2454.zip | |
README.md: document assumptions
| -rw-r--r-- | README.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md index 364477c..4a3e324 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,15 @@ different queues for different purposes is encouraged. All these operations take worst-case quadratic time in the amount of lock files produced, so you should clean them regularly. +## Assumptions + +`nq` will only work correctly when: +- `$NQDIR` (respectively `.`) is writable. +- `flock(2)` works in `$NQDIR` (respectively `.`). +- `gettimeofday` behaves monotonic (using `CLOCK_MONOTONIC` would + create confusing file names). +- No other programs put files matching `,*` into `$NQDIR` (respectively `.`). + ## nq helpers Two helper programs are provided: |