From a46b2d4fb7dee11fcc508c6871b86d9bff8d01ae Mon Sep 17 00:00:00 2001 From: Robin Candau Date: Sun, 28 Apr 2024 12:39:20 +0200 Subject: feat(repo): add repo clean command to remove untracked files This introduces the `pkgctl repo clean` command which removes every untracked files from local package repositories (via `git clean`). The usage is as simple as `pkgctl repo clean [OPTION] [PATH]` (where "[PATH]" can be equal to a wildcard "*"). Component: pkgctl repo clean --- doc/man/pkgctl-repo-clean.1.asciidoc | 40 ++++++++++++++++++++++++++++++++++++ doc/man/pkgctl-repo.1.asciidoc | 4 ++++ 2 files changed, 44 insertions(+) create mode 100644 doc/man/pkgctl-repo-clean.1.asciidoc (limited to 'doc') diff --git a/doc/man/pkgctl-repo-clean.1.asciidoc b/doc/man/pkgctl-repo-clean.1.asciidoc new file mode 100644 index 0000000..b39693c --- /dev/null +++ b/doc/man/pkgctl-repo-clean.1.asciidoc @@ -0,0 +1,40 @@ +pkgctl-repo-clean(1) +==================== + +Name +---- + +pkgctl-repo-clean - Remove untracked files from the working tree + +Synopsis +-------- + +pkgctl repo clean [OPTION] [PATH]... + +Description +----------- + +Cleans the working tree by recursively removing files that are not under +version control, starting from the current directory. + +Files unknown to Git as well as ignored files are removed. This can, for +example, be useful to remove all build products. + +Options +------- + +*-i, --interactive*:: + Show what would be done and clean files interactively + +*-n, --dry-run*:: + Don't actually remove anything, just show what would be done + +*-h, --help*:: + Show a help text + +See Also +-------- + +git-clean(1) + +include::include/footer.asciidoc[] diff --git a/doc/man/pkgctl-repo.1.asciidoc b/doc/man/pkgctl-repo.1.asciidoc index 3d0f3f1..c1fd298 100644 --- a/doc/man/pkgctl-repo.1.asciidoc +++ b/doc/man/pkgctl-repo.1.asciidoc @@ -32,6 +32,9 @@ Options Subcommands ----------- +pkgctl repo clean:: + Remove untracked files from the working tree + pkgctl repo clone:: Clone a package repository @@ -50,6 +53,7 @@ pkgctl repo web:: See Also -------- +pkgctl-repo-clean(1) pkgctl-repo-clone(1) pkgctl-repo-configure(1) pkgctl-repo-create(1) -- cgit v1.2.3-70-g09d2