Skip to content

Commit 7a713d7

Browse files
authored
Improve grammar in doc/flatpak-manifest.xml
1 parent 2d35004 commit 7a713d7

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

doc/flatpak-manifest.xml

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,15 @@
5959
<varlistentry>
6060
<term><option>branch</option> (string)</term>
6161
<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>
6464
<para>This key overrides both the default-branch
6565
key, and the --default-branch commandline
6666
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
6868
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>
7171
</varlistentry>
7272
<varlistentry>
7373
<term><option>default-branch</option> (string)</term>
@@ -80,9 +80,9 @@
8080
<varlistentry>
8181
<term><option>collection-id</option> (string)</term>
8282
<listitem><para>The collection ID of the repository,
83-
defaults to being unset. Setting a globally
83+
unset by default. Setting a globally
8484
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.
8686
If building in an existing repository, the collection ID
8787
must match the existing configured collection ID for that
8888
repository.</para></listitem>
@@ -132,11 +132,11 @@
132132
<term><option>command</option> (string)</term>
133133
<listitem><para>
134134
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,
136136
install a shell script wrapper and use that as the command.
137137
</para><para>
138138
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
140140
the application is run in other ways, e.g. via the desktop file or D-Bus
141141
activation.
142142
</para></listitem>
@@ -377,7 +377,7 @@
377377
</varlistentry>
378378
<varlistentry>
379379
<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>
381381
</varlistentry>
382382
<varlistentry>
383383
<term><option>build-args</option> (array of strings)</term>
@@ -394,8 +394,8 @@
394394
<varlistentry>
395395
<term><option>secret-opts</option> (array of strings)</term>
396396
<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>
399399
</varlistentry>
400400
<varlistentry>
401401
<term><option>make-args</option> (array of strings)</term>
@@ -411,24 +411,24 @@
411411
</varlistentry>
412412
<varlistentry>
413413
<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>
416416
</varlistentry>
417417
<varlistentry>
418418
<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>
420420
</varlistentry>
421421
<varlistentry>
422422
<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>
424424
</varlistentry>
425425
</variablelist>
426426
</refsect2>
427427
<refsect2>
428428
<title>Extension</title>
429429
<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.
432432
</para>
433433
<para>
434434
These are the properties that are accepted:
@@ -452,7 +452,7 @@
452452
<varlistentry>
453453
<term><option>remove-after-build</option> (boolean)</term>
454454
<listitem><para>If this is true, the extension is
455-
removed during when finishing. This is only
455+
removed when finishing. This is only
456456
interesting for extensions in the
457457
add-build-extensions property.</para></listitem>
458458
</varlistentry>

0 commit comments

Comments
 (0)