No explanation of delta directory in README #26

Open
opened 2025-11-15 03:44:24 +00:00 by snegov · 0 comments
Owner

No explanation of delta directory in README

Priority: Low
Component: README.md
Type: Documentation

Description

The README mentions .backup_delta directories in the backup structure but doesn't explain their purpose or how to use them.

Current Documentation

backups/
  2025-01-15_10-30-00/
    .backup_finished            # completion marker
    .backup_delta/              # changed files in this backup
    [your backed up files]

Users are left wondering:

  • What is .backup_delta for?
  • How is it different from the main backup?
  • When would I need to look at it?
  • Is it safe to delete?

Proposed Addition

## Understanding .backup_delta/

Each backup contains a `.backup_delta/` directory with copies of files that were:
- Created in this backup
- Modified since the previous backup
- Had metadata changes (permissions, ownership)

### Use Cases

**Track what changed:** Quickly see what files were modified without comparing entire directory trees.

**Audit trail:** Review changes over time to understand what happened when.

**Incremental transfers:** If you need to sync only changes to a remote location, the delta directory contains exactly what changed.

### Important Notes

- DO NOT delete `.backup_delta/` directories - they're part of the backup metadata
- Files in `.backup_delta/` are hardlinked to the main backup (not duplicates)
- The delta directory adds minimal space overhead due to hardlinks

Impact

Low - Documentation clarity improvement.

# No explanation of delta directory in README **Priority:** Low **Component:** README.md **Type:** Documentation ## Description The README mentions `.backup_delta` directories in the backup structure but doesn't explain their purpose or how to use them. ## Current Documentation ``` backups/ 2025-01-15_10-30-00/ .backup_finished # completion marker .backup_delta/ # changed files in this backup [your backed up files] ``` Users are left wondering: - What is `.backup_delta` for? - How is it different from the main backup? - When would I need to look at it? - Is it safe to delete? ## Proposed Addition ```markdown ## Understanding .backup_delta/ Each backup contains a `.backup_delta/` directory with copies of files that were: - Created in this backup - Modified since the previous backup - Had metadata changes (permissions, ownership) ### Use Cases **Track what changed:** Quickly see what files were modified without comparing entire directory trees. **Audit trail:** Review changes over time to understand what happened when. **Incremental transfers:** If you need to sync only changes to a remote location, the delta directory contains exactly what changed. ### Important Notes - DO NOT delete `.backup_delta/` directories - they're part of the backup metadata - Files in `.backup_delta/` are hardlinked to the main backup (not duplicates) - The delta directory adds minimal space overhead due to hardlinks ``` ## Impact **Low** - Documentation clarity improvement.
Sign in to join this conversation.
No Label
No Milestone
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: snegov/cura-te-ipsum#26
No description provided.