|
61 | 61 | <varlistentry> |
62 | 62 | <term><option>branch</option> (string)</term> |
63 | 63 | <listitem><para>The branch to use when exporting |
64 | | - the application. If this is unset the defaults |
65 | | - come from the default-branch option.</para> |
| 64 | + the application. If this is unset the default |
| 65 | + comes from the default-branch option.</para> |
66 | 66 | <para>This key overrides both the default-branch |
67 | 67 | key, and the --default-branch commandline |
68 | 68 | option. Unless you need a very specific branchname |
69 | 69 | (like for a runtime or an extension) it is |
70 | | - recommended to use the default-branch key instead, because |
71 | | - you can then override the default using --default-branch when |
72 | | - building for instance a test build.</para></listitem> |
| 70 | + recommended to use the default-branch key instead, as |
| 71 | + that can be overridden by the --default-branch option.</para></listitem> |
73 | 72 | </varlistentry> |
74 | 73 | <varlistentry> |
75 | 74 | <term><option>default-branch</option> (string)</term> |
|
84 | 83 | <listitem><para>The collection ID of the repository, |
85 | 84 | defaults to being unset. Setting a globally |
86 | 85 | unique collection ID allows the apps in the repository to be shared over |
87 | | - peer to peer systems without needing further configuration. |
| 86 | + peer-to-peer systems without needing further configuration. |
88 | 87 | If building in an existing repository, the collection ID |
89 | 88 | must match the existing configured collection ID for that |
90 | 89 | repository.</para></listitem> |
|
134 | 133 | <term><option>command</option> (string)</term> |
135 | 134 | <listitem><para> |
136 | 135 | The filename or path to the main binary of the application. Note that this |
137 | | - is really just a single file, not a commandline. If you want to pass arguments, |
| 136 | + must be a single executable, not a commandline or an absolute path. If you want to pass arguments, |
138 | 137 | install a shell script wrapper and use that as the command. |
139 | 138 | </para><para> |
140 | 139 | Also note that the command is used when the application is run via |
|
387 | 386 | </varlistentry> |
388 | 387 | <varlistentry> |
389 | 388 | <term><option>secret-env</option> (array of strings)</term> |
390 | | - <listitem><para>This is a array defining which host environment variables is transfered to build-commands or post-install environment.</para></listitem> |
| 389 | + <listitem><para>This is an array defining which host environment variables are transfered to the build-commands or post-install environment.</para></listitem> |
391 | 390 | </varlistentry> |
392 | 391 | <varlistentry> |
393 | 392 | <term><option>build-args</option> (array of strings)</term> |
|
404 | 403 | <varlistentry> |
405 | 404 | <term><option>secret-opts</option> (array of strings)</term> |
406 | 405 | <listitem><para>This is an array of options that will be passed to |
407 | | - configure, meant to be used to pass secrets through host environment variables. Put |
408 | | - the option with an environment variables and will be resolved beforehand. '-DSECRET_ID=$CI_SECRET'</para></listitem> |
| 406 | + configure. This is meant to be used to pass secrets through host environment variables. |
| 407 | + Environment variables in the options will be expanded. '-DSECRET_ID=$CI_SECRET'</para></listitem> |
409 | 408 | </varlistentry> |
410 | 409 | <varlistentry> |
411 | 410 | <term><option>make-args</option> (array of strings)</term> |
|
421 | 420 | </varlistentry> |
422 | 421 | <varlistentry> |
423 | 422 | <term><option>no-debuginfo</option> (boolean)</term> |
424 | | - <listitem><para>By default (if strip is not true) flatpak-builder extracts all debug info in ELF files to a separate files |
425 | | - and puts this in an extension. If you want to disable this, set no-debuginfo to true.</para></listitem> |
| 423 | + <listitem><para>By default (if strip is not true) flatpak-builder extracts all debug info in ELF files to separate files |
| 424 | + and puts them into an extension. If you want to disable this, set no-debuginfo to true.</para></listitem> |
426 | 425 | </varlistentry> |
427 | 426 | <varlistentry> |
428 | 427 | <term><option>no-debuginfo-compression</option> (boolean)</term> |
429 | | - <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> |
| 428 | + <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> |
430 | 429 | </varlistentry> |
431 | 430 | <varlistentry> |
432 | 431 | <term><option>arch</option> (object)</term> |
433 | | - <listitem><para>This is a dictionary defining for each arch a separate build options object that override the main one.</para></listitem> |
| 432 | + <listitem><para>This is a dictionary defining a separate build options object for each arch, to override the main build options.</para></listitem> |
434 | 433 | </varlistentry> |
435 | 434 | </variablelist> |
436 | 435 | </refsect2> |
437 | 436 | <refsect2> |
438 | 437 | <title>Extension</title> |
439 | 438 | <para> |
440 | | - Extension define extension points in the app/runtime that can be implemented by extensions, supplying extra files |
441 | | - which are available during runtime.. |
| 439 | + Defines extension points in the app or runtime that can be implemented by extensions, |
| 440 | + supplying extra files which are available during runtime. |
442 | 441 | </para> |
443 | 442 | <para> |
444 | 443 | These are the properties that are accepted: |
|
462 | 461 | <varlistentry> |
463 | 462 | <term><option>remove-after-build</option> (boolean)</term> |
464 | 463 | <listitem><para>If this is true, the extension is |
465 | | - removed during when finishing. This is only |
| 464 | + removed when finishing. This is only |
466 | 465 | interesting for extensions in the |
467 | 466 | add-build-extensions property.</para></listitem> |
468 | 467 | </varlistentry> |
|
0 commit comments