浏览代码

improve docs for borg with-lock

discussion in #8022
port of #8024
kmille 1 年之前
父节点
当前提交
9c860bafaf
共有 1 个文件被更改,包括 5 次插入1 次删除
  1. 5 1
      src/borg/archiver.py

+ 5 - 1
src/borg/archiver.py

@@ -4997,7 +4997,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