浏览代码

Merge pull request #5694 from ThomasWaldmann/misc-fixes-1.1

backport comment about archives.list() defaults
TW 4 年之前
父节点
当前提交
4a181f74a4
共有 1 个文件被更改,包括 4 次插入0 次删除
  1. 4 0
      src/borg/helpers.py

+ 4 - 0
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')