/
flatpak-build-commit-from.xml
290 lines (232 loc) · 10.9 KB
/
flatpak-build-commit-from.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http:https://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<refentry id="flatpak-build-commit-from">
<refentryinfo>
<title>flatpak build-commit-from</title>
<productname>flatpak</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Alexander</firstname>
<surname>Larsson</surname>
<email>[email protected]</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>flatpak build-commit-from</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>flatpak-build-commit-from</refname>
<refpurpose>Create new commits based on existing one (possibly from another repository)</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>flatpak build-commit-from</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">DST-REPO</arg>
<arg choice="plain" rep="repeat">DST-REF</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Creates new commits on the <arg choice="plain">DST-REF</arg>
branch in the <arg choice="plain">DST-REPO</arg>, with the
contents (and most of the metadata) taken from another
branch, either from another repo, or from another branch in
the same repository.
</para>
<para>
The collection ID set on
<arg choice="plain">DST-REPO</arg> (if set) will be used for the
newly created commits.
</para>
<para>
This command is very useful when you want to maintain a branch
with a clean history that has no unsigned or broken commits.
For instance, you can import the head from a different repository
from an automatic builder when you've verified that it worked.
The new commit will have no parents or signatures from the
autobuilder, and can be properly signed with the official
key.
</para>
<para>
Any deltas that affect the original commit and that match parent
commits in the destination repository are copied and rewritten
for the new commit id.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>-h</option></term>
<term><option>--help</option></term>
<listitem><para>
Show help options and exit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--src-repo=SRC-REPO</option></term>
<listitem><para>
The (local) repository to pull the source branch from. Defaults to the
destination repository.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--src-ref=SRC-REF</option></term>
<listitem><para>
The branch to use as the source for the new commit. Defaults to the same
as the destination ref, which is useful only if a different source repo
has been specified.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--extra-collection-id=COLLECTION-ID</option></term>
<listitem><para>
Add an extra collection-ref binding for this collection, in addition to whatever
would normally be added due to the destination repository collection id.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--subset=SUBSET</option></term>
<listitem><para>
Mark the commit to be included in the named subset. This will cause the commit
to be put in the named subset summary (in addition to the main one), allowing
users to see only this subset instead of the whole repo.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--untrusted</option></term>
<listitem><para>
The source repostory is not trusted, all objects are copied (not hardlinked) and
all checksums are verified.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-s</option></term>
<term><option>--subject=SUBJECT</option></term>
<listitem><para>
One line subject for the commit message. If not specified, will be taken from the source commit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-b</option></term>
<term><option>--body=BODY</option></term>
<listitem><para>
Full description for the commit message. If not specified, will be taken from the source commit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--update-appstream</option></term>
<listitem><para>
Update the appstream branch after the build.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-update-summary</option></term>
<listitem><para>
Don't update the summary file after the new commit is added. This means
the repository will not be useful for serving over http until build-update-repo
has been run. This is useful is you want to do multiple repo operations before
finally updating the summary.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--force</option></term>
<listitem><para>
Create new commit even if the content didn't change from the existing branch head.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--disable-fsync</option></term>
<listitem><para>
Don't fsync when writing to the repository. This can result in data loss in exceptional situations, but can improve performance when
working with temporary or test repositories.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--gpg-sign=KEYID</option></term>
<listitem><para>
Sign the commit with this GPG key.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--gpg-homedir=PATH</option></term>
<listitem><para>
GPG Homedir to use when looking for keyrings
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--end-of-life=REASON</option></term>
<listitem><para>
Mark build as end-of-life
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--end-of-life-rebase=OLDID=NEWID</option></term>
<listitem><para>
Mark new refs as end-of-life. Unlike <option>--end-of-life</option>,
this one takes an ID that supersedes the current one. By the user's
request, the application data may be preserved for the new application.
Note, this is actually a prefix match, so if you say org.the.app=org.new.app,
then something like org.the.app.Locale will be rebased to org.new.app.Locale.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--timestamp=TIMESTAMP</option></term>
<listitem><para>
Override the timestamp of the commit. Use an ISO 8601 formatted
date, or NOW for the current time
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--disable-fsync</option></term>
<listitem><para>
Don't fsync when writing to the repository. This can result in data loss in exceptional situations, but can improve performance when
working with temporary or test repositories.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<term><option>--verbose</option></term>
<listitem><para>
Print debug information during command processing.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--ostree-verbose</option></term>
<listitem><para>
Print OSTree debug information during command processing.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
To revert a commit to the commit before:
</para>
<para>
<command>$ flatpak build-commit-from --timestamp=NOW --src-ref=app/org.gnome.gedit/x86_64/master^ repo app/org.gnome.gedit/x86_64/master</command>
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<citerefentry><refentrytitle>ostree</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-build-init</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-build</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-build-finish</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-build-sign</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-build-update-repo</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>