From 0c3c1e6e3ccab030d2bfece5dae5055f6cc2ed5f Mon Sep 17 00:00:00 2001 From: kmille Date: Sun, 7 Jan 2024 18:20:38 +0100 Subject: [PATCH] improve docs for borg with-lock discussion in #8022 port of #8024 --- src/borg/archiver.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/borg/archiver.py b/src/borg/archiver.py index 0110d6342..33a502537 100644 --- a/src/borg/archiver.py +++ b/src/borg/archiver.py @@ -4924,7 +4924,11 @@ class Archiver: # borg with-lock 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 running in the repo), then execute the given command as a subprocess and wait