rebase-helper(1)

1REBASE-HELPER(1)                 rebase-helper                REBASE-HELPER(1)
2
3
4

NAME

6       rebase-helper - helps you rebase your package to the latest version
7

SYNOPSIS

9       rebase-helper [-h] [--version] [-v] [--color {always,never,auto}]
10         [--background {dark,light,auto}] [--results-dir RESULTS_DIR]
11         [--workspace-dir WORKSPACE_DIR]
12         [--buildtool {copr,koji,mock,rpmbuild}]
13         [--srpm-buildtool {mock,rpmbuild}]
14         [--pkgcomparetool
15         [{abipkgdiff,csmock,licensecheck,pkgdiff,rpmdiff,rpminspect-
16         rpm,rpminspect-srpm,sonamecheck}]]
17         [--outputtool {json,text}]
18         [--versioneer {anitya,cpan,hackage,npmjs,pypi,rubygems}]
19         [--versioneer-blacklist [{anitya,cpan,hackage,npmjs,pypi,rubygems}]]
20         [--spec-hook-blacklist [{commit-hash-updater,escape-macros,paths-to-rpm-
21         macros,pypi-url-fix,replace-old-version,ruby-helper,typo-fix}]]
22         [--build-log-hook-blacklist [{files}]] [--bugzilla-id BUG_ID]
23         [--non-interactive] [--favor-on-conflict {downstream,upstream,off}]
24         [--not-download-sources] [-w] [--apply-changes]
25         [--disable-inapplicable-patches] [--skip-version-check]
26         [--update-sources] [--skip-upload] [--force-build-log-hooks]
27         [--builds-nowait] [--build-tasks OLD_TASK,NEW_TASK]
28         [--builder-options BUILDER_OPTIONS]
29         [--srpm-builder-options SRPM_BUILDER_OPTIONS]
30         [--lookaside-cache-preset {fedpkg,centpkg,rhpkg,rhpkg-sha512}]
31         [--changelog-entry CHANGELOG_ENTRY] [--no-changelog-entry]
32         [--config-file CONFIG_FILE] [-D 'MACRO EXPR']
33         [--copr-project-permanent] [--copr-project-frontpage]
34         [--copr-chroots COPR_CHROOTS] [--get-old-build-from-koji]
35         [--replace-old-version-with-macro] [SOURCES]
36
37
38
39
40

DESCRIPTION

42       rebase-helper is a tool which helps package maintainers to rebase their
43       packages to latest upstream versions.
44
45       It should be executed from a directory containing  spec  file,  sources
46       and patches (usually cloned dist-git repository).
47
48       The  new  version is specified by SOURCES argument, which can be either
49       version number or filename of the new source  archive.   Starting  with
50       version 0.10.0, this argument can be omitted and the new version deter‐
51       mined automatically using one of available versioneers.
52

OPTIONS

54       SOURCES
55              version number or filename of the new source archive
56
57       -h, --help
58              show help message and exit
59
60       --version
61              show rebase-helper version and exit
62
63       -v, --verbose
64              be more verbose
65
66       --color {always,never,auto}
67              colorize the output, defaults to auto
68
69       --background {dark,light,auto}
70              use color scheme for the given background, defaults to auto
71
72       --results-dir RESULTS_DIR
73              location where the rebase-helper-results directory will be  cre‐
74              ated
75
76       --workspace-dir WORKSPACE_DIR
77              location  where  the  rebase-helper-workspace  directory will be
78              created
79
80       --buildtool {copr,koji,mock,rpmbuild}
81              build tool to use, defaults to mock
82
83       --srpm-buildtool {mock,rpmbuild}
84              SRPM build tool to use, defaults to rpmbuild
85
86       --pkgcomparetool   [{abipkgdiff,csmock,licensecheck,pkgdiff,rpmdiff,rp‐
87       minspect-rpm,rpminspect-srpm,sonamecheck}]
88              set  of  tools  to use for package comparison, defaults to abip‐
89              kgdiff,licensecheck,pkgdiff,rpmdiff,rpminspect-rpm,rpmin‐
90              spect-srpm,sonamecheck if available
91
92       --outputtool {json,text}
93              tool to use for formatting rebase output, defaults to text
94
95       --versioneer {anitya,cpan,hackage,npmjs,pypi,rubygems}
96              tool to use for determining latest upstream version
97
98       --versioneer-blacklist [{anitya,cpan,hackage,npmjs,pypi,rubygems}]
99              prevent specified versioneers from being run
100
101       --spec-hook-blacklist [{commit-hash-updater,escape-macros,paths-to-rpm-
102       macros,pypi-url-fix,replace-old-version,ruby-helper,typo-fix}]
103              prevent specified spec hooks from being run
104
105       --build-log-hook-blacklist [{files}]
106              prevent specified build log hooks from being run
107
108       --bugzilla-id BUG_ID
109              do a rebase based on Upstream Release Monitoring bugzilla
110
111       --non-interactive
112              do not interact with user
113
114       --favor-on-conflict {downstream,upstream,off}
115              favor downstream or upstream changes when conflicts appear
116
117       --not-download-sources
118              do not download sources
119
120       -w, --keep-workspace
121              do not remove workspace directory after finishing
122
123       --apply-changes
124              apply changes.patch after a successful rebase
125
126       --disable-inapplicable-patches
127              disable inapplicable patches in rebased SPEC file
128
129       --skip-version-check
130              force rebase even if current version  is  newer  than  requested
131              version
132
133       --update-sources
134              update “sources” file and upload new sources to lookaside cache
135
136       --skip-upload
137              skip uploading new sources to lookaside cache
138
139       --force-build-log-hooks
140              enforce  running  of  build  log  hooks (even in non-interactive
141              mode)
142
143       --builds-nowait
144              do not wait for remote builds to finish
145
146       --build-tasks OLD_TASK,NEW_TASK
147              comma-separated remote build task ids
148
149       --builder-options BUILDER_OPTIONS
150              enable arbitrary local builder  option(s),  enclose  BUILDER_OP‐
151              TIONS in quotes to pass more than one
152
153       --srpm-builder-options SRPM_BUILDER_OPTIONS
154              enable   arbitrary   local   srpm   builder  option(s),  enclose
155              SRPM_BUILDER_OPTIONS in quotes to pass more than one
156
157       --lookaside-cache-preset {fedpkg,centpkg,rhpkg,rhpkg-sha512}
158              use specified lookaside cache configuration preset, defaults  to
159              fedpkg
160
161       --changelog-entry CHANGELOG_ENTRY
162              text  to  use  as changelog entry, can contain RPM macros, which
163              will be expanded
164
165       --no-changelog-entry
166              do not add a changelog entry at all
167
168       --config-file CONFIG_FILE
169              path to a configuration file, defaults  to  $XDG_CONFIG_HOME/re‐
170              base-helper.cfg
171
172       -D 'MACRO EXPR', --define 'MACRO EXPR'
173              define an rpm macro, can be used multiple times
174
175       --copr-project-permanent
176              make the created copr project permanent
177
178       --copr-project-frontpage
179              make the created copr project visible on the frontpage
180
181       --copr-chroots COPR_CHROOTS
182              comma-separated list of chroots to create copr project with
183
184       --get-old-build-from-koji
185              do  not  build  old sources, download latest build from Koji in‐
186              stead
187
188       --replace-old-version-with-macro
189              replace old version string with %{version} instead of  new  ver‐
190              sion string
191
192
193

EXIT STATUS

195       This  program  returns 0 if successful, or non-zero if there was an er‐
196       ror.
197

AUTHOR

202       Petr  Hráček  <phracek@redhat.com>,  Tomáš  Hozza  <thozza@redhat.com>,
203       Nikola Forró <nforro@redhat.com>, František Nečas <fifinecas@seznam.cz>
204

COPYRIGHT

206       2014-2023, Red Hat
207
208
209
210
2110.28                             Oct 26, 2023                 REBASE-HELPER(1)