From 534f5f6e99b4d259451a49d68d7ca38703ce7a1d Mon Sep 17 00:00:00 2001
From: "James E. Blair" <jeblair@redhat.com>
Date: Thu, 19 Apr 2018 08:09:56 -0700
Subject: [PATCH] Add docs on mailman lock files

Change-Id: I3451e1061270f56774119bc6eb80c4da78ccb6da
---
 doc/source/lists.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/doc/source/lists.rst b/doc/source/lists.rst
index 583c04df38..e846061cae 100644
--- a/doc/source/lists.rst
+++ b/doc/source/lists.rst
@@ -88,3 +88,16 @@ argument to withlist.  To run the same script on a single list, use:
 Note that the ban list accepts regular expressions, so to ban an
 address and all suffixes, use '^address.*@example.com' as the "address
 to ban".
+
+Lock Files
+----------
+
+If a list stops handling traffic for some time, it may be due to a
+stale lock file.  Mailman locks are in /srv/mailman/openstack/locks.
+If a lock is held for a list, then ``listname.lock`` will exist.  The
+contents of the file will be the name of the lock sequence file which
+was used to obtain the lock.  That file is in the form
+``listname.lock.hostname.pid.sequence``.  If the process id in that
+string no longer exists, it's safe to assume the process died without
+cleaning up the lock.  It should generally be safe to remove the
+lockfile in that case.