Browse Source

docs: add note about GFS (#6006)

docs: add note about grandfather-father-son backup retention policy / rotation scheme
Philip Waritschlager 3 years ago
parent
commit
8b61fd308c
1 changed files with 3 additions and 1 deletions
  1. 3 1
      src/borg/archiver.py

+ 3 - 1
src/borg/archiver.py

@@ -4309,7 +4309,9 @@ class Archiver:
         Important: Repository disk space is **not** freed until you run ``borg compact``.
         Important: Repository disk space is **not** freed until you run ``borg compact``.
 
 
         This command is normally used by automated backup scripts wanting to keep a
         This command is normally used by automated backup scripts wanting to keep a
-        certain number of historic backups.
+        certain number of historic backups. This retention policy is commonly referred to as
+        `GFS <https://en.wikipedia.org/wiki/Backup_rotation_scheme#Grandfather-father-son>`_
+        (Grandfather-father-son) backup rotation scheme.
 
 
         Also, prune automatically removes checkpoint archives (incomplete archives left
         Also, prune automatically removes checkpoint archives (incomplete archives left
         behind by interrupted backup runs) except if the checkpoint is the latest
         behind by interrupted backup runs) except if the checkpoint is the latest