Skip to content

Commit bbdaeb4

Browse files
authored
Update help messages of CLI commands
1 parent 6602c85 commit bbdaeb4

File tree

2 files changed

+20
-23
lines changed

2 files changed

+20
-23
lines changed

docs/cli/init.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,15 @@ initialize a [source-git repo](/source-git).
2525

2626
Usage: packit init [OPTIONS] [PATH_OR_URL]
2727

28-
Create the initial Packit configuration in a repository
28+
Create the initial Packit configuration in a repository and add a pre-commit
29+
hook to validate Packit configuration file
2930

3031
See 'packit source-git init', if you want to initialize a repository as a
3132
source-git repo.
3233

3334
Options:
34-
--force-precommit Automatically create an empty pre-commit configuration file if missing.
35-
--without-precommit Skip adding pre-commit hook to pre-commit configuration file.
3635
-f, --force Reset config to default if already exists.
36+
--without_precommit Skip adding packit-specific pre-commit configuration
37+
hook.
38+
--force_precommit Create pre-commit configuration file if missing.
3739
-h, --help Show this message and exit.

docs/cli/test.md

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -83,26 +83,21 @@ The command supports two main workflows:
8383
8484
## Help
8585
86-
Usage: packit test [OPTIONS]
86+
Usage: packit test [OPTIONS] [PATH_OR_URL]
8787
88-
Run tmt tests locally using content from the upstream repository.
89-
90-
This command builds RPMs from the current repository state and runs
91-
tests in containerized environments, mimicking Packit's testing service
92-
behavior for local debugging and development.
88+
Run tmt tests locally without needing a PR or release
9389
9490
Options:
95-
--rpm-paths PATH Path to RPM file(s) to test. Can be used
96-
multiple times. If not provided, RPMs will
97-
be built automatically from source.
98-
--target TEXT Container image for testing environment
99-
(e.g., 'fedora:39', 'centos:stream9').
100-
Defaults to 'fedora:rawhide'.
101-
--plans TEXT tmt plan name(s) to execute. Can be used
102-
multiple times to run specific plans only.
103-
If not specified, all plans are executed.
104-
--clean-before / --no-clean-before
105-
Run 'tmt clean --all' before starting the
106-
test. Defaults to disabled for clean test
107-
environments.
108-
-h, --help Show this message and exit.
91+
-p, --package TEXT Package to source build, if more than one
92+
available, like in a monorepo configuration.
93+
Use it multiple times to select multiple
94+
packages.Defaults to all the packages listed
95+
inside the config.
96+
--rpm_paths TEXT Path(s) to RPMs that should be installed in
97+
the test environment.
98+
--target TEXT Container/VM image to use.
99+
--plans TEXT List of specific tmt plans to run.
100+
--clean-before / --no-clean-before
101+
Run 'tmt clean --all' before starting the
102+
test (default: disabled).
103+
-h, --help Show this message and exit.

0 commit comments

Comments
 (0)