From 0691f307a148e31dc185dc8e24635ca5660ff078 Mon Sep 17 00:00:00 2001
From: Doug Wiegley <dougw@a10networks.com>
Date: Thu, 21 Jul 2016 17:43:12 -0600
Subject: [PATCH] Add new lock-file setting to the config doc and reference
config
Change-Id: If3af9429d708bb5d877f31cbc34dec34bd21a544
---
doc/source/configuration.rst | 4 ++++
examples/reference-gertty.yaml | 4 ++++
2 files changed, 8 insertions(+)
diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst
index 5ec78e3..56e7718 100644
--- a/doc/source/configuration.rst
+++ b/doc/source/configuration.rst
@@ -107,6 +107,10 @@ line.
Gertty listens on a unix domain socket for remote commands at
~/.gertty.sock. This option may be used to change the path.
+ **lock-file**
+ Gertty uses a lock file per server to prevent multiple processes
+ from running at the same time. The default is ~/.gertty.servername.lock
+
Example:
.. code-block: yaml
diff --git a/examples/reference-gertty.yaml b/examples/reference-gertty.yaml
index fd4c21e..83b4e3c 100644
--- a/examples/reference-gertty.yaml
+++ b/examples/reference-gertty.yaml
@@ -13,6 +13,7 @@ servers:
# account settings to generate/retrieve this password.
password: CHANGEME
git-root: ~/git/
+ lock-file: ~/.gertty.CHANGEME.lock
# Each server section can have the following fields:
# A name that describes the server, to reference on the command line. [required]
@@ -53,6 +54,9 @@ servers:
# Gertty listens on a unix domain socket for remote commands at
# ~/.gertty.sock. You may change the path here:
# socket: ~/.gertty.sock
+# Gertty uses a lock file per server to prevent multiple processes
+# from running at the same time. Example:
+# lock-file: /run/lockme.lock
# Gertty comes with two palettes defined internally. The default
# palette is suitable for use on a terminal with a dark background.