From f357c1b94668bb82d2cae907a61986c5f69b7a8a Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Mon, 15 Feb 2021 21:15:41 +0100 Subject: [PATCH] backport comment about archives.list() defaults backport of comment from a77db94b010bdec71637a6a73ca0788c1e78bae4 --- src/borg/helpers.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/borg/helpers.py b/src/borg/helpers.py index f61e15b71..704f4eaff 100644 --- a/src/borg/helpers.py +++ b/src/borg/helpers.py @@ -279,6 +279,10 @@ class Archives(abc.MutableMapping): Apply *first* and *last* filters, and then possibly *reverse* the list. *sort_by* is a list of sort keys applied in reverse order. + + Note: for better robustness, all filtering / limiting parameters must default to + "not limit / not filter", so a FULL archive list is produced by a simple .list(). + some callers EXPECT to iterate over all archives in a repo for correct operation. """ if isinstance(sort_by, (str, bytes)): raise TypeError('sort_by must be a sequence of str')