Merge pull request #4436 from MichaelEischer/add-snapshot-subfolder-syntax-to-help-text

Add snapshot subfolder syntax in help output of diff/dump/restore
This commit is contained in:
Michael Eischer 2023-08-13 19:36:38 +02:00 committed by GitHub
commit e60c5b2d7f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 16 additions and 5 deletions

View file

@ -16,7 +16,7 @@ import (
)
var cmdDiff = &cobra.Command{
Use: "diff [flags] snapshot-ID snapshot-ID",
Use: "diff [flags] snapshotID snapshotID",
Short: "Show differences between two snapshots",
Long: `
The "diff" command shows differences from the first to the second snapshot. The
@ -29,6 +29,10 @@ directory:
* M The file's content was modified
* T The type was changed, e.g. a file was made a symlink
To only compare files in specific subfolders, you can use the
"<snapshotID>:<subfolder>" syntax, where "subfolder" is a path within the
snapshot.
EXIT STATUS
===========

View file

@ -24,9 +24,13 @@ single file is selected, it prints its contents to stdout. Folders are output
as a tar (default) or zip file containing the contents of the specified folder.
Pass "/" as file name to dump the whole snapshot as an archive file.
The special snapshot "latest" can be used to use the latest snapshot in the
The special snapshotID "latest" can be used to use the latest snapshot in the
repository.
To include the folder content at the root of the archive, you can use the
"<snapshotID>:<subfolder>" syntax, where "subfolder" is a path within the
snapshot.
EXIT STATUS
===========

View file

@ -25,9 +25,12 @@ var cmdRestore = &cobra.Command{
The "restore" command extracts the data from a snapshot from the repository to
a directory.
The special snapshot "latest" can be used to restore the latest snapshot in the
The special snapshotID "latest" can be used to restore the latest snapshot in the
repository.
To only restore a specific subfolder, you can use the "<snapshotID>:<subfolder>"
syntax, where "subfolder" is a path within the snapshot.
EXIT STATUS
===========

View file

@ -12,7 +12,7 @@ import (
)
var cmdTag = &cobra.Command{
Use: "tag [flags] [snapshot-ID ...]",
Use: "tag [flags] [snapshotID ...]",
Short: "Modify tags on snapshots",
Long: `
The "tag" command allows you to modify tags on exiting snapshots.
@ -20,7 +20,7 @@ The "tag" command allows you to modify tags on exiting snapshots.
You can either set/replace the entire set of tags on a snapshot, or
add tags to/remove tags from the existing set.
When no snapshot-ID is given, all snapshots matching the host, tag and path filter criteria are modified.
When no snapshotID is given, all snapshots matching the host, tag and path filter criteria are modified.
EXIT STATUS
===========