Skip to content

Commit fac751e

Browse files
jwakelyhfiguierebbhtt
committed
docs: Improve grammar and style
Co-authored-by: Hubert Figuière <hub@figuiere.net> Co-authored-by: bbhtt <bbhtt.zn0i8@slmail.me>
1 parent 2edd162 commit fac751e

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

doc/flatpak-manifest.xml

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,14 @@
6161
<varlistentry>
6262
<term><option>branch</option> (string)</term>
6363
<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>
6666
<para>This key overrides both the default-branch
6767
key, and the --default-branch commandline
6868
option. Unless you need a very specific branchname
6969
(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>
7372
</varlistentry>
7473
<varlistentry>
7574
<term><option>default-branch</option> (string)</term>
@@ -84,7 +83,7 @@
8483
<listitem><para>The collection ID of the repository,
8584
defaults to being unset. Setting a globally
8685
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.
8887
If building in an existing repository, the collection ID
8988
must match the existing configured collection ID for that
9089
repository.</para></listitem>
@@ -134,7 +133,7 @@
134133
<term><option>command</option> (string)</term>
135134
<listitem><para>
136135
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,
138137
install a shell script wrapper and use that as the command.
139138
</para><para>
140139
Also note that the command is used when the application is run via
@@ -387,7 +386,7 @@
387386
</varlistentry>
388387
<varlistentry>
389388
<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>
391390
</varlistentry>
392391
<varlistentry>
393392
<term><option>build-args</option> (array of strings)</term>
@@ -404,8 +403,8 @@
404403
<varlistentry>
405404
<term><option>secret-opts</option> (array of strings)</term>
406405
<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>
409408
</varlistentry>
410409
<varlistentry>
411410
<term><option>make-args</option> (array of strings)</term>
@@ -421,24 +420,24 @@
421420
</varlistentry>
422421
<varlistentry>
423422
<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>
426425
</varlistentry>
427426
<varlistentry>
428427
<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>
430429
</varlistentry>
431430
<varlistentry>
432431
<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>
434433
</varlistentry>
435434
</variablelist>
436435
</refsect2>
437436
<refsect2>
438437
<title>Extension</title>
439438
<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.
442441
</para>
443442
<para>
444443
These are the properties that are accepted:
@@ -462,7 +461,7 @@
462461
<varlistentry>
463462
<term><option>remove-after-build</option> (boolean)</term>
464463
<listitem><para>If this is true, the extension is
465-
removed during when finishing. This is only
464+
removed when finishing. This is only
466465
interesting for extensions in the
467466
add-build-extensions property.</para></listitem>
468467
</varlistentry>

0 commit comments

Comments
 (0)