1fedpkg(1) fedora-packager fedpkg(1)
2
6 fedpkg - Fedora Packaging utility
7
9 fedpkg [ global_options ] command [ command_options ] [ command_argu‐
10 ments ]
11 fedpkg help
12 fedpkg command --help
13
15 fedpkg is a script to interact with the Fedora Packaging system.
16 Global Options
18 --dist DIST Override the distribution, eg f15 or el6
19 -u USER, --user USER Override the username found in the fedora cert
20 --path PATH Directory to interact with instead of current
21 dir
22 -v Run with verbose debug output
23 -q Run quietly only displaying errors
24
26 fedpkg build [-h] [--nowait] [--target TARGET] [--background] [--skip-
27 tag] [--scratch] [--srpm SRPM]
28 Request build
29 fedpkg chain-build [-h] [--nowait] [--target TARGET] [--background]
31 package [package ...]
32 Build current package in order with other packages
33 fedpkg ci [-h] [-c] [-t] [-m MESSAGE] [-F FILE] [-p] [files [files
35 ...]]
36 Alias for commit
37 fedpkg clean [-h] [--dry-run] [-x]
39 Remove untracked files
40 fedpkg clog [-h]
42 Make a clog file containing top changelog entry
43 fedpkg clone [-h] [--branches] [--branch BRANCH] [--anonymous] module
45 Clone and checkout a module
46 fedpkg co [-h] [--branches] [--branch BRANCH] [--anonymous] module
48 Alias for clone
49 fedpkg commit [-h] [-c] [-t] [-m MESSAGE] [-F FILE] [-p] [files [files
51 ...]]
52 Commit changes
53 fedpkg compile [-h] [--arch ARCH] [--short-circuit]
55 Local test rpmbuild compile
56 fedpkg diff [-h] [--cached] [files [files ...]]
58 Show changes between commits, commit and working tree, etc
59 fedpkg gimmespec [-h]
61 Print the spec file name
62 fedpkg giturl [-h]
64 Print the git url for building
65 fedpkg help [-h]
67 Show usage
68 fedpkg import [-h] [--branch BRANCH] [--create] srpm
70 Import srpm content into a module
71 fedpkg install [-h] [--arch ARCH] [--short-circuit]
73 Local test rpmbuild install
74 fedpkg lint [-h] [--info]
76 Run rpmlint against local build output
77 fedpkg local [-h] [--arch ARCH] [--md5]
79 Local test rpmbuild binary
80 fedpkg mockbuild [-h]
82 Local test build using mock
83 fedpkg new [-h]
85 Diff against last tag
86 fedpkg new-sources [-h] files [files ...]
88 Upload new source files
89 fedpkg patch [-h] [--suffix SUFFIX] [--rediff]
91 Create and add a gendiff patch file
92 fedpkg prep [-h] [--arch ARCH]
94 Local test rpmbuild prep
95 fedpkg pull [-h] [--rebase] [--no-rebase]
97 Pull changes from remote repository and update working copy.
98 fedpkg push [-h]
100 Push changes to remote repository
101 fedpkg retire [-h] [-p] [msg]
103 Retire a package
104 fedpkg scratch-build [-h] [--nowait] [--target TARGET] [--background]
106 [--arches [ARCHES [ARCHES ...]]] [--srpm SRPM]
107 Request scratch build
108 fedpkg sources [-h] [--outdir OUTDIR]
110 Download source files
111 fedpkg srpm [-h] [--md5]
113 Create a source rpm
114 fedpkg switch-branch [-h] [-l] [branch]
116 Work with branches
117 fedpkg tag [-h] [-f] [-m MESSAGE] [-c] [-F FILE] [-l] [-d] [tag]
119 Management of git tags
120 fedpkg tag-request [-h] [--desc DESC] [--build BUILD]
122 Submit current build nvr as a releng tag request
123 fedpkg unused-patches [-h]
125 Print list of patches not referenced by name in the specfile
126 fedpkg update [-h]
128 Submit last build as an update
129 fedpkg upload [-h] files [files ...]
131 Upload source files
132 fedpkg verify-files [-h]
134 Locally verify %%files section
135 fedpkg verrel [-h]
137 Print the name-version-release
138
140 fedpkg build
141 usage: fedpkg build [-h] [--nowait] [--target TARGET] [--background]
142 [--skip-tag] [--scratch] [--srpm SRPM]
143 This command requests a build of the package in the build system. By
145 default
146 it discovers the target to build for based on branch data, and uses
147 the latest
148 commit as the build source.
149 optional arguments:
151 -h, --help show this help message and exit
152 --nowait Don't wait on build
153 --target TARGET Define koji target to build into
154 --background Run the build at a lower priority
155 --skip-tag Do not attempt to tag package
156 --scratch Perform a scratch build
157 --srpm SRPM Build from an srpm. Requires --scratch
158 fedpkg chain-build
161 usage: fedpkg chain-build [-h] [--nowait] [--target TARGET] [--back‐
162 ground]
163 package [package ...]
164 Build current package in order with other packages.
166 example: fedpkg chain-build libwidget libgizmo
168 The current package is added to the end of the CHAIN list.
170 Colons (:) can be used in the CHAIN parameter to define groups of
171 packages. Packages in any single group will be built in parallel
172 and all packages in a group must build successfully and populate
173 the repository before the next group will begin building.
174 For example:
176 fedpkg chain-build libwidget libaselib : libgizmo :
178 will cause libwidget and libaselib to be built in parallel, followed
180 by libgizmo and then the currect directory package. If no groups are
181 defined, packages will be built sequentially.
182 positional arguments:
184 package List the packages and order you want to build in
185 optional arguments:
187 -h, --help show this help message and exit
188 --nowait Don't wait on build
189 --target TARGET Define koji target to build into
190 --background Run the build at a lower priority
191 fedpkg ci
194 usage: fedpkg ci [-h] [-c] [-t] [-m MESSAGE] [-F FILE] [-p]
195 [files [files ...]]
196 This envokes a git commit. All tracked files with changes will be
198 committed
199 unless a specific file list is provided. $EDITOR will be used to gen‐
200 erate a
201 changelog message unless one is given to the command. A push can be
202 done at
203 the same time.
204 positional arguments:
206 files Optional list of specific files to commit
207 optional arguments:
209 -h, --help show this help message and exit
210 -c, --clog Generate the commit message from the
211 Changelog section
212 -t, --tag Create a tag for this commit
213 -m MESSAGE, --message MESSAGE
214 Use the given <msg> as the commit message
215 -F FILE, --file FILE Take the commit message from the given file
216 -p, --push Commit and push as one action
217 fedpkg clean
220 usage: fedpkg clean [-h] [--dry-run] [-x]
221 This command can be used to clean up your working directory. By
223 default it
224 will follow .gitignore rules.
225 optional arguments:
227 -h, --help show this help message and exit
228 --dry-run, -n Perform a dry-run
229 -x Do not follow .gitignore rules
230 fedpkg clog
233 usage: fedpkg clog [-h]
234 This will create a file named "clog" that contains the latest rpm
236 changelog
237 entry. The leading "- " text will be stripped.
238 optional arguments:
240 -h, --help show this help message and exit
241 fedpkg clone
244 usage: fedpkg clone [-h] [--branches] [--branch BRANCH] [--anonymous]
245 module
246 This command will clone the named module from the configured reposi‐
248 tory base
249 URL. By default it will also checkout the master branch for your
250 working copy.
251 positional arguments:
253 module Name of the module to clone
254 optional arguments:
256 -h, --help show this help message and exit
257 --branches, -B Do an old style checkout with subdirs for
258 branches
259 --branch BRANCH, -b BRANCH
260 Check out a specific branch
261 --anonymous, -a Check out a branch anonymously
262 fedpkg co
265 usage: fedpkg co [-h] [--branches] [--branch BRANCH] [--anonymous]
266 module
267 This command will clone the named module from the configured reposi‐
269 tory base
270 URL. By default it will also checkout the master branch for your
271 working copy.
272 positional arguments:
274 module Name of the module to clone
275 optional arguments:
277 -h, --help show this help message and exit
278 --branches, -B Do an old style checkout with subdirs for
279 branches
280 --branch BRANCH, -b BRANCH
281 Check out a specific branch
282 --anonymous, -a Check out a branch anonymously
283 fedpkg commit
286 usage: fedpkg commit [-h] [-c] [-t] [-m MESSAGE] [-F FILE] [-p]
287 [files [files ...]]
288 This envokes a git commit. All tracked files with changes will be
290 committed
291 unless a specific file list is provided. $EDITOR will be used to gen‐
292 erate a
293 changelog message unless one is given to the command. A push can be
294 done at
295 the same time.
296 positional arguments:
298 files Optional list of specific files to commit
299 optional arguments:
301 -h, --help show this help message and exit
302 -c, --clog Generate the commit message from the
303 Changelog section
304 -t, --tag Create a tag for this commit
305 -m MESSAGE, --message MESSAGE
306 Use the given <msg> as the commit message
307 -F FILE, --file FILE Take the commit message from the given file
308 -p, --push Commit and push as one action
309 fedpkg compile
312 usage: fedpkg compile [-h] [--arch ARCH] [--short-circuit]
313 This command calls rpmbuild to compile the source. By default the
315 prep and
316 configure stages will be done as well, unless the short-circuit
317 option is
318 used.
319 optional arguments:
321 -h, --help show this help message and exit
322 --arch ARCH Arch to compile for
323 --short-circuit short-circuit compile
324 fedpkg diff
327 usage: fedpkg diff [-h] [--cached] [files [files ...]]
328 Use git diff to show changes that have been made to tracked files. By
330 default
331 cached changes (changes that have been git added) will not be shown.
332 positional arguments:
334 files Optionally diff specific files
335 optional arguments:
337 -h, --help show this help message and exit
338 --cached View staged changes
339 fedpkg gimmespec
342 usage: fedpkg gimmespec [-h]
343 Print the spec file name.
345 optional arguments:
347 -h, --help show this help message and exit
348 fedpkg giturl
351 usage: fedpkg giturl [-h]
352 This will show you which git URL would be used in a build command. It
354 uses the
355 git hashsum of the HEAD of the current branch (which may not be
356 pushed).
357 optional arguments:
359 -h, --help show this help message and exit
360 fedpkg help
363 usage: fedpkg help [-h]
364 Show usage.
366 optional arguments:
368 -h, --help show this help message and exit
369 fedpkg import
372 usage: fedpkg import [-h] [--branch BRANCH] [--create] srpm
373 This will extract sources, patches, and the spec file from an srpm
375 and update
376 the current module accordingly. It will import to the current branch
377 by
378 default.
379 positional arguments:
381 srpm Source rpm to import
382 optional arguments:
384 -h, --help show this help message and exit
385 --branch BRANCH, -b BRANCH
386 Branch to import onto
387 --create, -c Create a new local repo
388 fedpkg install
391 usage: fedpkg install [-h] [--arch ARCH] [--short-circuit]
392 This will call rpmbuild to run the install section. All leading sec‐
394 tions will
395 be processed as well, unless the short-circuit option is used.
396 optional arguments:
398 -h, --help show this help message and exit
399 --arch ARCH Arch to install for
400 --short-circuit short-circuit install
401 fedpkg lint
404 usage: fedpkg lint [-h] [--info]
405 Run rpmlint against local build output.
407 optional arguments:
409 -h, --help show this help message and exit
410 --info, -i Display explanations for reported messages
411 fedpkg local
414 usage: fedpkg local [-h] [--arch ARCH] [--md5]
415 Locally test run of rpmbuild producing binary RPMs. The rpmbuild out‐
417 put will
418 be logged into a file named .build-%{version}-%{release}.log
419 optional arguments:
421 -h, --help show this help message and exit
422 --arch ARCH Build for arch
423 --md5 Use md5 checksums (for older rpm hosts)
424 fedpkg mockbuild
427 usage: fedpkg mockbuild [-h]
428 This will use the mock utility to build the package for the distribu‐
430 tion
431 detected from branch information. This can be overridden using the
432 global
433 --dist option. Your user must be in the local "mock" group.
434 optional arguments:
436 -h, --help show this help message and exit
437 fedpkg new
440 usage: fedpkg new [-h]
441 This will use git to show a diff of all the changes (even uncommited
443 changes)
444 since the last git tag was applied.
445 optional arguments:
447 -h, --help show this help message and exit
448 fedpkg new-sources
451 usage: fedpkg new-sources [-h] files [files ...]
452 This will upload new source files to the lookaside cache and remove
454 any
455 existing files. The "sources" and .gitignore file will be updated for
456 the new
457 file(s).
458 positional arguments:
460 files
461 optional arguments:
463 -h, --help show this help message and exit
464 fedpkg patch
467 usage: fedpkg patch [-h] [--suffix SUFFIX] [--rediff]
468 Create and add a gendiff patch file.
470 optional arguments:
472 -h, --help show this help message and exit
473 --suffix SUFFIX
474 --rediff Recreate gendiff file retaining comments
475 fedpkg prep
478 usage: fedpkg prep [-h] [--arch ARCH]
479 Use rpmbuild to "prep" the sources (unpack the source archive(s) and
481 apply any
482 patches.)
483 optional arguments:
485 -h, --help show this help message and exit
486 --arch ARCH Prep for a specific arch
487 fedpkg pull
490 usage: fedpkg pull [-h] [--rebase] [--no-rebase]
491 This command uses git to fetch remote changes and apply them to the
493 current
494 working copy. A rebase option is available which can be used to avoid
495 merges.
496 optional arguments:
498 -h, --help show this help message and exit
499 --rebase Rebase the locally committed changes on top of the
500 remote
501 changes after fetching. This can avoid a merge commit,
502 but does
503 rewrite local history.
504 --no-rebase Do not rebase, override .git settings to automatically
505 rebase
506 See git pull --help for more details
508 fedpkg push
511 usage: fedpkg push [-h]
512 Push changes to remote repository.
514 optional arguments:
516 -h, --help show this help message and exit
517 fedpkg retire
520 usage: fedpkg retire [-h] [-p] [msg]
521 This command will remove all files from the repo and leave a
523 dead.package
524 file.
525 positional arguments:
527 msg Message for retiring the package
528 optional arguments:
530 -h, --help show this help message and exit
531 -p, --push Push changes to remote repository
532 fedpkg scratch-build
535 usage: fedpkg scratch-build [-h] [--nowait] [--target TARGET]
536 [--background]
537 [--arches [ARCHES [ARCHES ...]]] [--srpm
538 SRPM]
539 This command will request a scratch build of the package. Without
541 providing an
542 srpm, it will attempt to build the latest commit, which must have
543 been pushed.
544 By default all approprate arches will be built.
545 optional arguments:
547 -h, --help show this help message and exit
548 --nowait Don't wait on build
549 --target TARGET Define koji target to build into
550 --background Run the build at a lower priority
551 --arches [ARCHES [ARCHES ...]]
552 Build for specific arches
553 --srpm SRPM Build from srpm
554 fedpkg sources
557 usage: fedpkg sources [-h] [--outdir OUTDIR]
558 Download source files.
560 optional arguments:
562 -h, --help show this help message and exit
563 --outdir OUTDIR Directory to download files into (defaults to pwd)
564 fedpkg srpm
567 usage: fedpkg srpm [-h] [--md5]
568 Create a source rpm.
570 optional arguments:
572 -h, --help show this help message and exit
573 --md5 Use md5 checksums (for older rpm hosts)
574 fedpkg switch-branch
577 usage: fedpkg switch-branch [-h] [-l] [branch]
578 This command can create or switch to a local git branch. It can also
580 be used
581 to list the existing local and remote branches.
582 positional arguments:
584 branch Switch to or create branch
585 optional arguments:
587 -h, --help show this help message and exit
588 -l, --list List both remote-tracking branches and local branches
589 fedpkg tag
592 usage: fedpkg tag [-h] [-f] [-m MESSAGE] [-c] [-F FILE] [-l] [-d]
593 [tag]
594 This command uses git to create, list, or delete tags.
596 positional arguments:
598 tag Name of the tag
599 optional arguments:
601 -h, --help show this help message and exit
602 -f, --force Force the creation of the tag
603 -m MESSAGE, --message MESSAGE
604 Use the given <msg> as the tag message
605 -c, --clog Generate the tag message from the spec
606 changelog
607 section
608 -F FILE, --file FILE Take the tag message from the given file
609 -l, --list List all tags with a given pattern, or all if
610 not
611 pattern is given
612 -d, --delete Delete a tag
613 fedpkg tag-request
616 usage: fedpkg tag-request [-h] [--desc DESC] [--build BUILD]
617 This command files a ticket with release engineering, usually for a
619 buildroot
620 override. It will discover the build n-v-r automatically but can be
621 overridden.
622 optional arguments:
624 -h, --help show this help message and exit
625 --desc DESC Description of tag request
626 --build BUILD Override the build n-v-r
627 fedpkg unused-patches
630 usage: fedpkg unused-patches [-h]
631 Print list of patches not referenced by name in the specfile.
633 optional arguments:
635 -h, --help show this help message and exit
636 fedpkg update
639 usage: fedpkg update [-h]
640 This will create a bodhi update request for the current package n-v-
642 r.
643 optional arguments:
645 -h, --help show this help message and exit
646 fedpkg upload
649 usage: fedpkg upload [-h] files [files ...]
650 This command will add a new source archive to the lookaside cache.
652 The sources
653 and .gitignore file will be updated with the new file(s).
654 positional arguments:
656 files
657 optional arguments:
659 -h, --help show this help message and exit
660 fedpkg verify-files
663 usage: fedpkg verify-files [-h]
664 Locally run 'rpmbuild -bl' to verify the spec file's %files sections.
666 This
667 requires a successful run of 'fedpkg compile'
668 optional arguments:
670 -h, --help show this help message and exit
671 fedpkg verrel
674 usage: fedpkg verrel [-h]
675 Print the name-version-release.
677 optional arguments:
679 -h, --help show this help message and exit
680
683 https://fedorahosted.org/fedora-packager/
684 2011-08-27 fedpkg(1)