From 11253df6ac95554a895aa1412c75020ce663260c Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sun, 16 Jan 2022 17:59:29 +0200 Subject: docs: add some explanation of what Skipped should mean Sponsored-by: author --- src/backup_reason.rs | 3 ++- src/policy.rs | 9 +++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/src/backup_reason.rs b/src/backup_reason.rs index 590f470..9a17d80 100644 --- a/src/backup_reason.rs +++ b/src/backup_reason.rs @@ -7,7 +7,8 @@ use std::fmt; /// Represent the reason a file is in a backup. #[derive(Debug, Copy, Clone)] pub enum Reason { - /// File was skipped for some reason, but carried over without changes. + /// File was skipped due to policy, but carried over without + /// changes. Skipped, /// File is new, compared to previous backup. IsNew, diff --git a/src/policy.rs b/src/policy.rs index 9b66c1d..7241f0f 100644 --- a/src/policy.rs +++ b/src/policy.rs @@ -6,6 +6,15 @@ use crate::generation::LocalGeneration; use log::{debug, warn}; /// Policy for what gets backed up. +/// +/// The policy allows two aspects to be controlled: +/// +/// * should new files )(files that didn't exist in the previous +/// backup be included in the new backup? +/// * should files that haven't been changed since the previous backup +/// be included in the new backup? +/// +/// If policy doesn't allow a file to be included, it's skipped. pub struct BackupPolicy { new: bool, old_if_changed: bool, -- cgit v1.2.1