replication: prepare: adapt/expand function comment

Commit 8d1cd44 ("partially fix #3111: replication: be less picky when
selecting incremental base") changed prepare() to return all local
snapshots.

Special behavior regarding last_sync is also better mentioned
explicitly.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>

diff --git a/src/PVE/Replication.pm b/src/PVE/Replication.pm
index 31cabecfd08e7b8dca57c10ea0f975ef3755034c..fcd59bbcc207a4449579a8b9a2ba15129d4291f7 100644 (file)
--- a/src/PVE/Replication.pm
+++ b/src/PVE/Replication.pm
@@ -156,8 +156,9 @@ sub remote_finalize_local_job {
     PVE::Tools::run_command($cmd, outfunc => $logger, errfunc => $logger);
 }
 
-# finds local replication snapshots from $last_sync
-# and removes all replication snapshots with other time stamps
+# Finds all local snapshots and removes replication snapshots not matching $last_sync. Use
+# last_sync=0 (or undef) to prevent removal (useful if VM was stolen). Use last_sync=1 to remove all
+# replication snapshots (limited to job if specified).
 sub prepare {
     my ($storecfg, $volids, $jobid, $last_sync, $parent_snapname, $logfunc) = @_;