ok/jj
1
0
Fork 0
forked from mirrors/jj

cli untrack --help: mention that files need to be already be ignored

Make it clearer what the command does, make the error message when the file is
not ignored less of a surprise.

Also, I think it's nice to mention `.git/info/exclude`, since the path is
not trivial to remember.
This commit is contained in:
Ilya Grigoriev 2023-12-17 18:10:41 -08:00
parent 9a990ad92f
commit c5f76d6b4d

View file

@ -27,7 +27,10 @@ use crate::ui::Ui;
/// Stop tracking specified paths in the working copy
#[derive(clap::Args, Clone, Debug)]
pub(crate) struct UntrackArgs {
/// Paths to untrack
/// Paths to untrack. They must already be ignored.
///
/// The paths could be ignored via a .gitignore or .git/info/exclude (in
/// colocated repos).
#[arg(required = true, value_hint = clap::ValueHint::AnyPath)]
paths: Vec<String>,
}