|
59 | 59 | <varlistentry>
|
60 | 60 | <term><option>branch</option> (string)</term>
|
61 | 61 | <listitem><para>The branch to use when exporting
|
62 |
| - the application. If this is unset the defaults |
63 |
| - come from the default-branch option.</para> |
| 62 | + the application. If this is unset the default |
| 63 | + comes from the default-branch option.</para> |
64 | 64 | <para>This key overrides both the default-branch
|
65 | 65 | key, and the --default-branch commandline
|
66 | 66 | option. Unless you need a very specific branchname
|
67 |
| - (like for a runtime or an extension) it is |
| 67 | + (e.g., for a runtime or an extension) it is |
68 | 68 | recommended to use the default-branch key instead, because
|
69 |
| - you can then override the default using --default-branch when |
70 |
| - building for instance a test build.</para></listitem> |
| 69 | + that can be overridden by the --default-branch option |
| 70 | + (e.g., to test a build from another branch).</para></listitem> |
71 | 71 | </varlistentry>
|
72 | 72 | <varlistentry>
|
73 | 73 | <term><option>default-branch</option> (string)</term>
|
|
80 | 80 | <varlistentry>
|
81 | 81 | <term><option>collection-id</option> (string)</term>
|
82 | 82 | <listitem><para>The collection ID of the repository,
|
83 |
| - defaults to being unset. Setting a globally |
| 83 | + unset by default. Setting a globally |
84 | 84 | unique collection ID allows the apps in the repository to be shared over
|
85 |
| - peer to peer systems without needing further configuration. |
| 85 | + peer-to-peer systems without needing further configuration. |
86 | 86 | If building in an existing repository, the collection ID
|
87 | 87 | must match the existing configured collection ID for that
|
88 | 88 | repository.</para></listitem>
|
|
132 | 132 | <term><option>command</option> (string)</term>
|
133 | 133 | <listitem><para>
|
134 | 134 | The filename or path to the main binary of the application. Note that this
|
135 |
| - is really just a single file, not a commandline. If you want to pass arguments, |
| 135 | + must be just a single file, not a commandline. If you want to pass arguments, |
136 | 136 | install a shell script wrapper and use that as the command.
|
137 | 137 | </para><para>
|
138 | 138 | Also note that the command is used when the application is run via
|
139 |
| - <command>flatpak run</command>, and does not affect what gets executed when |
| 139 | + <command>flatpak run</command>, and does not necessarily affect what gets executed when |
140 | 140 | the application is run in other ways, e.g. via the desktop file or D-Bus
|
141 | 141 | activation.
|
142 | 142 | </para></listitem>
|
|
377 | 377 | </varlistentry>
|
378 | 378 | <varlistentry>
|
379 | 379 | <term><option>secret-env</option> (array of strings)</term>
|
380 |
| - <listitem><para>This is a array defining which host environment variables is transfered to build-commands or post-install environment.</para></listitem> |
| 380 | + <listitem><para>This is a array defining which host environment variables are transfered to the build-commands or post-install environment.</para></listitem> |
381 | 381 | </varlistentry>
|
382 | 382 | <varlistentry>
|
383 | 383 | <term><option>build-args</option> (array of strings)</term>
|
|
394 | 394 | <varlistentry>
|
395 | 395 | <term><option>secret-opts</option> (array of strings)</term>
|
396 | 396 | <listitem><para>This is an array of options that will be passed to
|
397 |
| - configure, meant to be used to pass secrets through host environment variables. Put |
398 |
| - the option with an environment variables and will be resolved beforehand. '-DSECRET_ID=$CI_SECRET'</para></listitem> |
| 397 | + configure, meant to be used to pass secrets through host environment variables. |
| 398 | + Environment variables in the options will be expanded. '-DSECRET_ID=$CI_SECRET'</para></listitem> |
399 | 399 | </varlistentry>
|
400 | 400 | <varlistentry>
|
401 | 401 | <term><option>make-args</option> (array of strings)</term>
|
|
411 | 411 | </varlistentry>
|
412 | 412 | <varlistentry>
|
413 | 413 | <term><option>no-debuginfo</option> (boolean)</term>
|
414 |
| - <listitem><para>By default (if strip is not true) flatpak-builder extracts all debug info in ELF files to a separate files |
415 |
| - and puts this in an extension. If you want to disable this, set no-debuginfo to true.</para></listitem> |
| 414 | + <listitem><para>By default (if strip is not true) flatpak-builder extracts all debug info in ELF files to separate files |
| 415 | + and puts them in an extension. If you want to disable this, set no-debuginfo to true.</para></listitem> |
416 | 416 | </varlistentry>
|
417 | 417 | <varlistentry>
|
418 | 418 | <term><option>no-debuginfo-compression</option> (boolean)</term>
|
419 |
| - <listitem><para>By default when extracting debuginfo we compress the debug sections. If you want to disable this, set no-debuginfo-compression to true.</para></listitem> |
| 419 | + <listitem><para>By default when extracting debuginfo the debug sections are compressed. If you want to disable this, set no-debuginfo-compression to true.</para></listitem> |
420 | 420 | </varlistentry>
|
421 | 421 | <varlistentry>
|
422 | 422 | <term><option>arch</option> (object)</term>
|
423 |
| - <listitem><para>This is a dictionary defining for each arch a separate build options object that override the main one.</para></listitem> |
| 423 | + <listitem><para>This is a dictionary defining a separate build options object for each arch, to override the main build options.</para></listitem> |
424 | 424 | </varlistentry>
|
425 | 425 | </variablelist>
|
426 | 426 | </refsect2>
|
427 | 427 | <refsect2>
|
428 | 428 | <title>Extension</title>
|
429 | 429 | <para>
|
430 |
| - Extension define extension points in the app/runtime that can be implemented by extensions, supplying extra files |
431 |
| - which are available during runtime.. |
| 430 | + Extensions define extension points in the app/runtime that can be implemented by extensions, supplying extra files |
| 431 | + which are available during runtime. |
432 | 432 | </para>
|
433 | 433 | <para>
|
434 | 434 | These are the properties that are accepted:
|
|
452 | 452 | <varlistentry>
|
453 | 453 | <term><option>remove-after-build</option> (boolean)</term>
|
454 | 454 | <listitem><para>If this is true, the extension is
|
455 |
| - removed during when finishing. This is only |
| 455 | + removed when finishing. This is only |
456 | 456 | interesting for extensions in the
|
457 | 457 | add-build-extensions property.</para></listitem>
|
458 | 458 | </varlistentry>
|
|
0 commit comments