Skip to content

Commit 8106339

Browse files
committed
Update help text for ignore and skip
- Also update the README with the new help text
1 parent 7959947 commit 8106339

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ cargo clean-all -i --ignore ~/Downloads --ignore ~/Documents ~
7474
| Interactive selection of projects | yes | no |
7575
| Clean only `release`, `debug` or `docs` | no (not yet) | yes |
7676
| Real `cargo clean` command under the hood | no | yes |
77+
| Keep executables in an extra directory | yes | no |
7778

7879
Note that `cargo-clean-recursive` uses the actual `cargo clean` command under the hood instead of
7980
simply deleting the target directories. This gies makes the cleaning work exactly as intended by
@@ -98,7 +99,9 @@ Options:
9899
-t, --threads <THREADS> The number of threads to use for directory scaning. 0 automatically selects the number of threads [default: 0]
99100
-v, --verbose Show access errors that occur while scanning. By default those errors are hidden
100101
-i, --interactive Use the interactive project selection. This will show a selection of all cleanable projects with the possibility to manually select or deselect
101-
--ignore <IGNORE> Directories that should be ignored by default, including subdirectories. This will still detect the projects in those directories, but mark them to not be cleaned
102+
--ignore <IGNORE> Directories that should be ignored by default, including subdirectories. This will still detect the projects in those directories, but mark them to not be cleaned. To actually skip scanning directories, use --skip instead. The directories can be specified as absolute paths or relative to the workdir
103+
-e, --keep-executable Keeping compiled executables in release, debug and cross-compilation directories. Moves the executable to a new folder outside of target
104+
--skip <SKIP> Directories that should be fully skipped during scanning, including subdirectories. This will speed up the scanning time by not doing any reads for the specified directories. The directories can be specified as absolute paths or relative to the workdir
102105
-h, --help Print help information
103106
-V, --version Print version information
104107
```

src/main.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,9 @@ struct AppArgs {
6767
interactive: bool,
6868

6969
/// Directories that should be ignored by default, including subdirectories. This will still
70-
/// detect the projects in those directories, but mark them to not be cleaned
70+
/// detect the projects in those directories, but mark them to not be cleaned. To actually skip
71+
/// scanning directories, use --skip instead.
72+
/// The directories can be specified as absolute paths or relative to the workdir.
7173
#[arg(long = "ignore")]
7274
ignore: Vec<String>,
7375

@@ -78,6 +80,7 @@ struct AppArgs {
7880

7981
/// Directories that should be fully skipped during scanning, including subdirectories. This
8082
/// will speed up the scanning time by not doing any reads for the specified directories.
83+
/// The directories can be specified as absolute paths or relative to the workdir.
8184
#[arg(long = "skip")]
8285
skip: Vec<String>,
8386
}

0 commit comments

Comments
 (0)