Merge pull request #80 from blimmer/docs/document-lockfile-behavior

Document LockFile behavior
maxmind · Nov 2, 2017 · 917d924 · 917d924
2 parents 0adbe3d + 542726b
commit 917d924
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -1,6 +1,9 @@
 GeoIP Update Change Log
 =======================
 
+* Document that the `LockFile` is not removed from the filesystem after
+  a successful exit from the program. GitHub issue #79.
+
 2.5.0 (2017-10-30)
 ------------------
 

diff --git a/conf/GeoIP.conf.default b/conf/GeoIP.conf.default
@@ -45,5 +45,6 @@ EditionIDs GeoLite2-Country GeoLite2-City
 
 # The lock file to use. This ensures only one geoipupdate process can run at a
 # time.
+# Note: Once created, this lockfile is not removed from the filesystem.
 # Defaults to ".geoipupdate.lock" under the DatabaseDirectory.
 # LockFile /usr/local/share/GeoIP/.geoipupdate.lock
diff --git a/man/GeoIP.conf.5.in b/man/GeoIP.conf.5.in
@@ -68,7 +68,9 @@ This option is either
 .B LockFile
 The lock file to use. This ensures only one
 .B geoipupdate
-process can run at a time. The default is
+process can run at a time. 
+Note: Once created, this lockfile is not removed from the filesystem. 
+The default is
 .BR .geoipupdate.lock " under the " DatabaseDirectory .
 .SH FILES
 .PP