Skip to content
Snippets Groups Projects
Verified Commit 58d11703 authored by nfontrod's avatar nfontrod
Browse files

Readme.md: fix compact section + update gblk help command display

parent 3f650098
No related branches found
No related tags found
No related merge requests found
......@@ -57,37 +57,34 @@ A tool used to link borg and git together
This tool was created to link borg and git together and ease the management of developpment artifact
versionning using git
gbl
A tool used to link borg and git together
USAGE:
gblk <SUBCOMMAND>
OPTIONS:
-h, --help
Print help information
-h, --help Print help information
SUBCOMMANDS:
checkout
Checkout results to the current git commit
commit
Save the results folder of a git repository in an archive
create-hooks
Create github hooks to use gbl automaticaly after commit, before and after checkout
delete-hooks
Remove the post-checkout and the post-commit hooks
diff
Show differences between two commits of the `results` folder
help
Print this message or the help of the given subcommand(s)
init
Initialize a borg repository inside a git project
list
List the content of the .borg archive
mount
Mount an old file/directory from one or multiple commits into the .mount folder inside
de project directory
pre-co
Check if a checkout can be performed without losing data
umount
Unmount everything in the folder .mount
checkout Checkout results to the current git commit
commit Save the results folder of a git repository in an archive
compact This command frees repository space by compacting segments
create-hooks Create github hooks to use gbl automaticaly after commit, before and after
checkout
delete This command deletes an archive from the repository or the complete
repository
delete-hooks Remove the post-checkout and the post-commit hooks
diff Show differences between two commits of the `results` folder
help Print this message or the help of the given subcommand(s)
init Initialize a borg repository inside a git project
list List the content of the .borg archive
mount Mount an old file/directory from one or multiple archive named afert git
commits into the .mount folder inside de project directory
pre-co Check if a checkout can be performed without losing data
prune This command prunes the .borg repository. This can be used to keep only
archive created during a given time interval
umount Unmount everything in the folder .mount
```
You can type `gblk help <SUBCOMMAND>` or `gblk <SUBCOMMAND> --help` to display the help of any given subcommands.
......@@ -493,7 +490,7 @@ To display the help of gblk delete, run the following command:
gblk delete -h # -h for compact help, --help for a more exhaustive help
```
To see what archive youére about to remove, enter
To see what archive you are about to remove, enter
```
gblk delete --list --dry-run [OTHER_OPTIONS]
......@@ -513,11 +510,16 @@ Note that this command doesn't actually free disk space. You have to use `gblk c
### gblk prune usage
To display the help of `gblk prune`, run the following command:
by compacting segmen for compact help, --help for a more exhaustive help
```
gblk prune -h # -h for compact help, --help for a more exhaustive help
```
- The `dry-run` option will keep the archive unchanged
- The `--list` option will display what was deleted (without `--dry-run` option) or what would be deleted (with the `dry-run` option)
To see what archives you are about to remove, enter
```
gblk prune --list --dry-run [OTHER_OPTIONS]
```
## gblk compact
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment