Skip to content

Commit

Permalink
Clarify tedge-write writes standard input in tedge-write help
Browse files Browse the repository at this point in the history
Signed-off-by: Marcel Guzik <[email protected]>
  • Loading branch information
Bravo555 committed Sep 18, 2024
1 parent 61fdb06 commit 75b8ba9
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions crates/core/tedge_write/src/bin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ use camino::Utf8PathBuf;
use clap::Parser;
use tedge_utils::atomic::MaybePermissions;

/// A binary used for writing to files which `tedge` user does not have write permissions for, using
/// sudo.
/// tee-like helper for writing to files which `tedge` user does not have write permissions to.
///
/// To be used in combination with sudo, passing the file content via standard input.
#[derive(Debug, Clone, PartialEq, Eq, Parser)]
#[command(about, version, long_about = None)]
#[command(about, version, long_about)]
pub struct Args {
/// A canonical path to a file which will be written to.
/// A canonical path to a file to which standard input will be written.
///
/// If the file does not exist, it will be created with the specified owner/group/permissions.
/// If the file does exist, it will be overwritten, but its owner/group/permissions will remain
Expand Down

0 comments on commit 75b8ba9

Please sign in to comment.