Skip to content

Commit

Permalink
docs: update doc strings for dump command
Browse files Browse the repository at this point in the history
Signed-off-by: simonsan <[email protected]>
  • Loading branch information
simonsan committed Oct 25, 2024
1 parent cfe9048 commit 5d3bb18
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
2 changes: 1 addition & 1 deletion src/commands.rs
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ enum RusticCmd {
/// Open the documentation
Docs(Box<DocsCmd>),

/// Dump the contents of a file within a snapshot to stdout
/// Dump the contents of a file within a snapshot
Dump(Box<DumpCmd>),

/// Find patterns in given snapshots
Expand Down
10 changes: 8 additions & 2 deletions src/commands/dump.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,17 @@ pub(crate) struct DumpCmd {
#[clap(value_name = "SNAPSHOT[:PATH]")]
snap: String,

/// set archive format to use. Possible values: auto, content, tar, targz, zip. For "auto" format is dertermined by file extension (if given) or "tar" for dirs.
/// Set archive format to use.
///
/// Possible values: auto, content, tar, targz, zip.
///
/// # Note
///
/// For "auto" format is determined by file extension (if given) or "tar" for dirs.
#[clap(long, value_name = "FORMAT", default_value = "auto")]
archive: ArchiveKind,

/// dump output to the given file. Use this instead of redirecting stdout to a file.
/// Dump output to the given file. Use this instead of redirecting stdout to a file.
#[clap(long)]
file: Option<PathBuf>,

Expand Down

0 comments on commit 5d3bb18

Please sign in to comment.