瀏覽代碼

Merge pull request #8032 from kmille/1.4-maint

improve docs for borg with-lock, 1.4-maint backport
TW 1 年之前
父節點
當前提交
2812f992b8
共有 1 個文件被更改,包括 5 次插入1 次删除
  1. 5 1
      src/borg/archiver.py

+ 5 - 1
src/borg/archiver.py

@@ -4926,7 +4926,11 @@ class Archiver:
 
 
         # borg with-lock
         # borg with-lock
         with_lock_epilog = process_epilog("""
         with_lock_epilog = process_epilog("""
-        This command runs a user-specified command while the repository lock is held.
+        This command runs a user-specified command while locking the repository. For example:
+
+        ::
+
+            $ borg with-lock /mnt/borgrepo rsync -av /mnt/borgrepo /somewhere/else/borgrepo
 
 
         It will first try to acquire the lock (make sure that no other operation is
         It will first try to acquire the lock (make sure that no other operation is
         running in the repo), then execute the given command as a subprocess and wait
         running in the repo), then execute the given command as a subprocess and wait