Browse Source

Merge pull request #8031 from kmille/1.2-maint

improve docs for borg with-lock, 1.2-maint backport
TW 1 year ago
parent
commit
988d8a1c82
1 changed files with 5 additions and 1 deletions
  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