From 4db935a9356a949a3a45f4706deba32988a4d7f2 Mon Sep 17 00:00:00 2001 From: jutty Date: Sun, 7 Jul 2024 21:01:21 -0300 Subject: [PATCH] Split docs between development and usage --- docs/{ => development}/check.md | 0 docs/{ => development}/portability.md | 0 docs/{ => development}/system_detection.md | 0 docs/{ => development}/user-data.md | 0 docs/{ => development}/user-files.md | 0 docs/{ => development}/user-packages.md | 0 docs/{ => development}/utilities.md | 0 docs/usage/backups.md | 4 ++++ 8 files changed, 4 insertions(+) rename docs/{ => development}/check.md (100%) rename docs/{ => development}/portability.md (100%) rename docs/{ => development}/system_detection.md (100%) rename docs/{ => development}/user-data.md (100%) rename docs/{ => development}/user-files.md (100%) rename docs/{ => development}/user-packages.md (100%) rename docs/{ => development}/utilities.md (100%) create mode 100644 docs/usage/backups.md diff --git a/docs/check.md b/docs/development/check.md similarity index 100% rename from docs/check.md rename to docs/development/check.md diff --git a/docs/portability.md b/docs/development/portability.md similarity index 100% rename from docs/portability.md rename to docs/development/portability.md diff --git a/docs/system_detection.md b/docs/development/system_detection.md similarity index 100% rename from docs/system_detection.md rename to docs/development/system_detection.md diff --git a/docs/user-data.md b/docs/development/user-data.md similarity index 100% rename from docs/user-data.md rename to docs/development/user-data.md diff --git a/docs/user-files.md b/docs/development/user-files.md similarity index 100% rename from docs/user-files.md rename to docs/development/user-files.md diff --git a/docs/user-packages.md b/docs/development/user-packages.md similarity index 100% rename from docs/user-packages.md rename to docs/development/user-packages.md diff --git a/docs/utilities.md b/docs/development/utilities.md similarity index 100% rename from docs/utilities.md rename to docs/development/utilities.md diff --git a/docs/usage/backups.md b/docs/usage/backups.md new file mode 100644 index 0000000..50dc8bf --- /dev/null +++ b/docs/usage/backups.md @@ -0,0 +1,4 @@ +tori creates a backup directory called `bkp` that contains two top-level directories: + +- `canonical`: Canonical backups are created the first time tori is told to modify a given file. If there is already a canonical backup, it defers to the cretaion of an ephemeral one. If tori is running against a recently-instaled system, the canonical backups should be close to the original state of the system as of its installation. +- `ephemeral`: Ephemeral backups are timestamped backups created every time tori has to modify a file. This is mainly meant as a safety net against undesired consequences when using non-interactive options.