From 64380f0f55e284a3bc397afd101ea45c3b63665c Mon Sep 17 00:00:00 2001
From: Fontrodona Nicolas <nicolas.fontrodona@ens-lyon.fr>
Date: Wed, 15 Feb 2023 09:14:37 +0100
Subject: [PATCH] README.qmd: update
---
README.qmd | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/README.qmd b/README.qmd
index e84d299..0395997 100644
--- a/README.qmd
+++ b/README.qmd
@@ -185,8 +185,9 @@ Not: if gblk pre-co says that you might lose data compared to the saved version
Git hooks are commands that can be automatically executed before and after some git commands. They are defined in the repository `.git/hooks`.
gblk can create two hooks:
-* `post-commit` hook that executes `gblk commit` after every git commit
-* `post-checkout` hook that execute:
+
+- `post-commit` hook that executes `gblk commit` after every git commit
+- `post-checkout` hook that execute:
1. `git co` to revert back to the last commit as a pre-checkout hooks doesn't exits.
2. `gblk pre-co` to be sure to not lose any data before the actual chekout
3. `git checkout` do the actual chekout
@@ -572,8 +573,8 @@ gblk config add <KEY> <VALUE> [--global]
```
Where `KEY` corresponds to a `prune` command argument. You can choose from:
-- keep_within, keep_last, keep_minutely, keep_hourly, keep_daily
-- keep_weekly, keep_monthly, keep_yearly, prefix, glob_archives, save_space
+
+- `keep_within`, `keep_last`, `keep_minutely`, `keep_hourly`, `keep_daily`, `keep_weekly`, `keep_monthly`, `keep_yearly`, `prefix`, `glob_archives`, `save_space`
And `VALUE` corresponds to the value to associate with the key
Check [borg documentation](https://borgbackup.readthedocs.io/en/stable/usage/prune.html) to know what those arguments do. You can also run the command `gblk prune --help` to see a description of those arguments.
@@ -676,6 +677,7 @@ The way of duplicating and storing an archive folder is not the way borg was int
## Remotes
In order to be able to share your archived results in the `.borg` folder, you use remotes like in git. Remotes can be defined *globally* or *locally*:
+
- *local* remotes are only defined for a given project
- *global* remotes are available for any gblk projects. It can be usefull if you often want to store your gblk results on a same location.
@@ -885,7 +887,7 @@ Here are the steps that the pull command execute:
8. Removes borg manifest timestamp and the cache associated to the current project archive folder.
::: {.callout-note}
-The pull command saves the inital content of the `.borg` folder inside the `.tmp` directory. **Remember to delte it if the pull is sucessful
+The pull command saves the inital content of the `.borg` folder inside the `.tmp` directory. **Remember to delete it if the pull is sucessful**
:::
# Gblk restore command
--
GitLab