Skip to content

Commit 3d01716

Browse files
authored
Update help messages of CLI commands
1 parent 38b84af commit 3d01716

File tree

2 files changed

+28
-23
lines changed

2 files changed

+28
-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: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -83,26 +83,29 @@ 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 using content from the upstream repository.
89+
90+
This command builds RPMs from the current repository state and runs tests in
91+
containerized environments, mimicking Packit's testing service behavior for
92+
local debugging and development.
9393
9494
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.
95+
-p, --package TEXT Package to source build, if more than one
96+
available, like in a monorepo configuration.
97+
Use it multiple times to select multiple
98+
packages.Defaults to all the packages listed
99+
inside the config.
100+
--rpm_paths TEXT Path to RPM file(s) to test. Can be used
101+
multiple times.If not provided, RPMs will be
102+
built automatically from source.
103+
--target TEXT Container image for the testing environment,
104+
e.g., `fedora:39`, `centos:stream9`.
105+
--plan TEXT List of specific tmt plans to run. Can be
106+
used multiple times. If not specified, all
107+
plans are executed.
108+
--clean-before / --no-clean-before
109+
Run 'tmt clean --all' before starting the
110+
test (default: disabled).
111+
-h, --help Show this message and exit.

0 commit comments

Comments
 (0)