Skip to content

Commit 8323d45

Browse files
lbarcziovalbarcziova
authored
Update help messages of CLI commands
1 parent baf5c1a commit 8323d45

22 files changed

Lines changed: 4 additions & 729 deletions

‎docs/cli/build/in-copr.md‎

Lines changed: 0 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -35,58 +35,4 @@ for more details). Alternatively you can use copr API token available [here](htt
3535
3636
## Help
3737
38-
Usage: packit build in-copr [OPTIONS] [PATH_OR_URL]
3938
40-
Build selected upstream project in Copr.
41-
42-
PATH_OR_URL argument is a local path or a URL to the upstream git
43-
repository, it defaults to the current working directory.
44-
45-
Options:
46-
--wait / --no-wait Wait for the build to finish
47-
--owner TEXT Copr user, owner of the project. (defaults
48-
to username from copr config)
49-
--project TEXT Project name to build in. Will be created if
50-
does not exist. (defaults to the first found
51-
project value in the config file or 'packit-
52-
cli-{repo_name}-{branch/commit}')
53-
--targets TEXT Comma separated list of chroots to build in.
54-
(defaults to 'fedora-rawhide-x86_64')
55-
--description TEXT Description of the project to build in.
56-
--instructions TEXT Installation instructions for the project to
57-
build in.
58-
--list-on-homepage Created copr project will be visible on
59-
copr's home-page.
60-
--preserve-project Created copr project will not be removed
61-
after 60 days.
62-
--additional-repos TEXT URLs to additional yum repos, which can be
63-
used during build. Comma separated. This
64-
should be baseurl from .repo file. E.g.:
65-
http://copr-be.cloud.fedoraproject.org/resul
66-
ts/rhughes/f20-gnome-3-12/fedora-$releasever
67-
-$basearch/
68-
--bootstrap [default|on|off|image]
69-
mock bootstrap feature setup.
70-
--upstream-ref TEXT Git ref of the last upstream commit in the
71-
current branch from which packit should
72-
generate patches (this option implies the
73-
repository is source-git).
74-
--request-admin-if-needed Ask for admin permissions when we need to
75-
change settings of the copr project and are
76-
not allowed to do so.
77-
--enable-net / --disable-net Copr build is built with explicitly enabled
78-
network access or disabled
79-
--release-suffix TEXT Specifies release suffix. Allows to override
80-
default generated:{current_time}.{sanitized_
81-
current_branch}{git_desc_suffix}
82-
--default-release-suffix Allows to use default, packit-generated,
83-
release suffix when some release_suffix is
84-
specified in the configuration.
85-
--module-hotfixes Created copr project will have
86-
module_hotfixes set to True
87-
-p, --package TEXT Package to build, if more than one
88-
available, like in a monorepo configuration.
89-
Use it multiple times to select multiple
90-
packages.Defaults to all the packages listed
91-
inside the config.
92-
-h, --help Show this message and exit.

‎docs/cli/build/in-image-builder.md‎

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -39,35 +39,4 @@ Builder, for more details see the `vm_image_build` job description.
3939
4040
## Help
4141
42-
Usage: packit build in-image-builder [OPTIONS] IMAGE_NAME [PATH_OR_URL]
4342
44-
Create a VM image in Image Builder.
45-
46-
### EXPERIMENTAL ###
47-
48-
This command is experimental and the integration with Image Builder will be
49-
changed in a backwards incompatible way in the future.
50-
51-
Packit loads image build configuration from your packit.yaml file.
52-
53-
When `--job-config-index` is not specified, the job configuration is loaded
54-
from your .packit.yaml and the first matching vm_image_build job is used.
55-
56-
IMAGE_NAME is the name of the image to be created. Please pick something
57-
unique so it's easy to identify for you in the Image Builder interface and
58-
can be well associated with the image content.
59-
60-
[PATH_OR_URL] argument is a local path or a URL to the upstream git
61-
repository, it defaults to the current working directory
62-
63-
Options:
64-
--job-config-index INTEGER Use N-th job definition to load configuration
65-
for the image build. The type needs to be
66-
vm_image_build.
67-
--wait / --no-wait Wait for the build to finish
68-
-p, --package TEXT Package to build, if more than one available,
69-
like in a monorepo configuration. Use it
70-
multiple times to select multiple
71-
packages.Defaults to all the packages listed
72-
inside the config.
73-
-h, --help Show this message and exit.

‎docs/cli/build/in-koji.md‎

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -26,37 +26,4 @@ Submit a Koji build for the selected branch in Fedora dist-git.
2626
2727
## Help
2828
29-
Usage: packit build in-koji [OPTIONS] [PATH_OR_URL]
30-
31-
Build selected upstream project in Fedora.
32-
33-
By default, packit checks out the respective dist-git repository and
34-
performs `fedpkg build` for the selected branch. With `--from-upstream`,
35-
packit creates a SRPM out of the current checkout and sends it to koji.
36-
37-
PATH_OR_URL argument is a local path or a URL to the upstream git
38-
repository, it defaults to the current working directory
39-
40-
Options:
41-
--dist-git-branch TEXT Comma separated list of target branches in dist-
42-
git to release into. (defaults to repo's default
43-
branch)
44-
--dist-git-path TEXT Path to dist-git repo to work in. Otherwise clone
45-
the repo in a temporary directory.
46-
--from-upstream Build the project in koji directly from the
47-
upstream repository
48-
--koji-target TEXT Koji target to build inside (see `koji list-
49-
targets`).
50-
--scratch Submit a scratch koji build
51-
--wait / --no-wait Wait for the build to finish
52-
--release-suffix TEXT Specifies release suffix. Allows to override
53-
default generated:{current_time}.{sanitized_curren
54-
t_branch}{git_desc_suffix}
55-
--default-release-suffix Allows to use default, packit-generated, release
56-
suffix when some release_suffix is specified in
57-
the configuration.
58-
-p, --package TEXT Package to build, if more than one available, like
59-
in a monorepo configuration. Use it multiple times
60-
to select multiple packages.Defaults to all the
61-
packages listed inside the config.
62-
-h, --help Show this message and exit.
29+

‎docs/cli/build/in-mock.md‎

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -19,31 +19,4 @@ packit build in-mock --root=fedora-40-x86_64
1919

2020
## Help
2121

22-
Usage: packit build in-mock [OPTIONS] [PATH_OR_URL]
2322

24-
Build RPMs in mock using content of the upstream repository.
25-
26-
PATH_OR_URL argument is a local path or a URL to the upstream git
27-
repository, it defaults to the current working directory.
28-
29-
Options:
30-
--upstream-ref TEXT Git ref of the last upstream commit in the current
31-
branch from which packit should generate patches
32-
(this option implies the repository is source-
33-
git).
34-
--release-suffix TEXT Specifies release suffix. Allows to override
35-
default generated:{current_time}.{sanitized_curren
36-
t_branch}{git_desc_suffix}
37-
--default-release-suffix Allows to use default, packit-generated, release
38-
suffix when some release_suffix is specified in
39-
the configuration.
40-
-r, --root TEXT Uses specified chroot configuration. If ends with
41-
'.cfg', then it is treated as full path to the
42-
mock configuration.
43-
--resultdir DIRECTORY Specifies the resultdir option for ‹mock› command,
44-
for details see mock(1)
45-
-p, --package TEXT Package to build, if more than one available, like
46-
in a monorepo configuration. Use it multiple times
47-
to select multiple packages.Defaults to all the
48-
packages listed inside the config.
49-
-h, --help Show this message and exit.

‎docs/cli/build/in-obs.md‎

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -28,28 +28,4 @@ Submit a build of the present content in the upstream or local repository to [OB
2828
```
2929
## Help
3030
31-
Usage: packit build in-obs [OPTIONS] [PATH_OR_URL]
32-
33-
Build selected project in OBS
34-
35-
Before Running this command, your opensuse user account and password needs
36-
to be configured in osc configuration file ~/.config/osc/oscrc. This can be
37-
done by running `osc`.
38-
39-
Options:
40-
--owner TEXT OBS user, owner of the project. (defaults to the
41-
username from the oscrc)
42-
--project TEXT Project name to build in. It will be created if does
43-
not exist. It defaults to home:$owner:packit:$pkg
44-
--targets TEXT Comma separated list of chroots to build in. (defaults
45-
to 'fedora-rawhide-x86_64')
46-
--description TEXT Description of the project to build in.
47-
--upstream-ref TEXT Git ref of the last upstream commit in the current
48-
branch from which packit should generate patches (this
49-
option implies the repository is source-git).
50-
--wait / --no-wait Wait for the build to finish
51-
-p, --package TEXT Package to build, if more than one available, like in a
52-
monorepo configuration. Use it multiple times to select
53-
multiple packages.Defaults to all the packages listed
54-
inside the config.
55-
-h, --help Show this message and exit.
31+

‎docs/cli/build/locally.md‎

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,4 @@ Create RPMs using content of the upstream repository.
1010

1111
## Help
1212

13-
Usage: packit build locally [OPTIONS] [PATH_OR_URL]
1413

15-
Create RPMs using content of the upstream repository.
16-
17-
PATH_OR_URL argument is a local path or a URL to the upstream git
18-
repository, it defaults to the current working directory
19-
20-
Options:
21-
--upstream-ref TEXT Git ref of the last upstream commit in the current
22-
branch from which packit should generate patches
23-
(this option implies the repository is source-
24-
git).
25-
--release-suffix TEXT Specifies release suffix. Allows to override
26-
default generated:{current_time}.{sanitized_curren
27-
t_branch}{git_desc_suffix}
28-
--default-release-suffix Allows to use default, packit-generated, release
29-
suffix when some release_suffix is specified in
30-
the configuration.
31-
-p, --package TEXT Package to build, if more than one available, like
32-
in a monorepo configuration. Use it multiple times
33-
to select multiple packages.Defaults to all the
34-
packages listed inside the config.
35-
-h, --help Show this message and exit.

‎docs/cli/config/validate.md‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,4 @@ Validate the Packit configuration file.
1010

1111
## Help
1212

13-
Usage: packit config validate [OPTIONS] [PATH_OR_URL]
1413

15-
Validate PackageConfig.
16-
17-
- checks missing values
18-
- checks incorrect types
19-
- checks whether monitoring is enabled if 'pull_from_upstream` is used
20-
21-
PATH_OR_URL argument is a local path or a URL to a git repository with
22-
packit configuration file
23-
24-
Options:
25-
--offline Do not make remote API calls requiring network access.
26-
-h, --help Show this message and exit.

‎docs/cli/create-update.md‎

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -44,37 +44,4 @@ have an active Kerberos TGT, you will be automatically authenticated.
4444

4545
## Help
4646

47-
Usage: packit create-update [OPTIONS] [PATH_OR_URL]
4847

49-
Create a bodhi update for the selected upstream project
50-
51-
If you are not authenticated with the bodhi server, please make sure that
52-
you navigate in your browser to the URL provided by the bodhi-client and
53-
then paste the `code=XX...` to the terminal when prompted.
54-
55-
If you set `fas_user` and `kerberos_realm` in your "~/.config/packit.yaml"
56-
and have an active Kerberos TGT, you will be automatically authenticated.
57-
Otherwise, you need to follow the prompt
58-
59-
PATH_OR_URL argument is a local path or a URL to the upstream git
60-
repository, it defaults to the current working directory
61-
62-
Options:
63-
--dist-git-branch TEXT Comma separated list of target branches in
64-
dist-git to create bodhi update in.
65-
(defaults to repo's default branch)
66-
--dist-git-path TEXT Path to dist-git repo to work in. Otherwise
67-
clone the repo in a temporary directory.
68-
--koji-build TEXT Koji build (NVR) to add to the bodhi update
69-
(can be specified multiple times)
70-
--update-notes TEXT Bodhi update notes
71-
--update-type [security|bugfix|enhancement|newpackage]
72-
Type of the bodhi update
73-
-b, --resolve-bug TEXT Bugzilla IDs that are resolved with the
74-
update, e.g., rhbz#1234
75-
-p, --package TEXT Package to update, if more than one
76-
available, like in a monorepo configuration.
77-
Use it multiple times to select multiple
78-
packages.Defaults to all the packages listed
79-
inside the config.
80-
-h, --help Show this message and exit.

0 commit comments

Comments
 (0)