Skip to content

Improve grammar in doc/flatpak-manifest.xml #525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve grammar in doc/flatpak-manifest.xml #525

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions doc/flatpak-manifest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,15 @@
<varlistentry>
<term><option>branch</option> (string)</term>
<listitem><para>The branch to use when exporting
the application. If this is unset the defaults
come from the default-branch option.</para>
the application. If this is unset the default
comes from the default-branch option.</para>
<para>This key overrides both the default-branch
key, and the --default-branch commandline
option. Unless you need a very specific branchname
(like for a runtime or an extension) it is
(e.g., for a runtime or an extension) it is
recommended to use the default-branch key instead, because
you can then override the default using --default-branch when
building for instance a test build.</para></listitem>
that can be overridden by the --default-branch option
(e.g., to test a build from another branch).</para></listitem>
</varlistentry>
<varlistentry>
<term><option>default-branch</option> (string)</term>
Expand All @@ -80,9 +80,9 @@
<varlistentry>
<term><option>collection-id</option> (string)</term>
<listitem><para>The collection ID of the repository,
defaults to being unset. Setting a globally
unset by default. Setting a globally
unique collection ID allows the apps in the repository to be shared over
peer to peer systems without needing further configuration.
peer-to-peer systems without needing further configuration.
If building in an existing repository, the collection ID
must match the existing configured collection ID for that
repository.</para></listitem>
Expand Down Expand Up @@ -132,7 +132,7 @@
<term><option>command</option> (string)</term>
<listitem><para>
The filename or path to the main binary of the application. Note that this
is really just a single file, not a commandline. If you want to pass arguments,
must be just a single file, not a commandline. If you want to pass arguments,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
must be just a single file, not a commandline. If you want to pass arguments,
must be just a single command name, not a commandline, nor path. If you want to pass arguments,
or run from a location not in PATH,

install a shell script wrapper and use that as the command.
</para><para>
Also note that the command is used when the application is run via
Expand Down Expand Up @@ -377,7 +377,7 @@
</varlistentry>
<varlistentry>
<term><option>secret-env</option> (array of strings)</term>
<listitem><para>This is a array defining which host environment variables is transfered to build-commands or post-install environment.</para></listitem>
<listitem><para>This is a array defining which host environment variables are transfered to the build-commands or post-install environment.</para></listitem>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<listitem><para>This is a array defining which host environment variables are transfered to the build-commands or post-install environment.</para></listitem>
<listitem><para>This is an array defining which host environment variables are transfered to the build-commands or post-install environment.</para></listitem>

</varlistentry>
<varlistentry>
<term><option>build-args</option> (array of strings)</term>
Expand All @@ -394,8 +394,8 @@
<varlistentry>
<term><option>secret-opts</option> (array of strings)</term>
<listitem><para>This is an array of options that will be passed to
configure, meant to be used to pass secrets through host environment variables. Put
the option with an environment variables and will be resolved beforehand. '-DSECRET_ID=$CI_SECRET'</para></listitem>
configure, meant to be used to pass secrets through host environment variables.
Environment variables in the options will be expanded. '-DSECRET_ID=$CI_SECRET'</para></listitem>
</varlistentry>
<varlistentry>
<term><option>make-args</option> (array of strings)</term>
Expand All @@ -411,24 +411,24 @@
</varlistentry>
<varlistentry>
<term><option>no-debuginfo</option> (boolean)</term>
<listitem><para>By default (if strip is not true) flatpak-builder extracts all debug info in ELF files to a separate files
and puts this in an extension. If you want to disable this, set no-debuginfo to true.</para></listitem>
<listitem><para>By default (if strip is not true) flatpak-builder extracts all debug info in ELF files to separate files
and puts them in an extension. If you want to disable this, set no-debuginfo to true.</para></listitem>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
and puts them in an extension. If you want to disable this, set no-debuginfo to true.</para></listitem>
and puts them into an extension. If you want to disable this, set no-debuginfo to true.</para></listitem>

</varlistentry>
<varlistentry>
<term><option>no-debuginfo-compression</option> (boolean)</term>
<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>
<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>
</varlistentry>
<varlistentry>
<term><option>arch</option> (object)</term>
<listitem><para>This is a dictionary defining for each arch a separate build options object that override the main one.</para></listitem>
<listitem><para>This is a dictionary defining a separate build options object for each arch, to override the main build options.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Extension</title>
<para>
Extension define extension points in the app/runtime that can be implemented by extensions, supplying extra files
which are available during runtime..
Defines extension points in the app/runtime that can be implemented by extensions,
supplying extra files which are available during runtime.
</para>
<para>
These are the properties that are accepted:
Expand All @@ -452,7 +452,7 @@
<varlistentry>
<term><option>remove-after-build</option> (boolean)</term>
<listitem><para>If this is true, the extension is
removed during when finishing. This is only
removed when finishing. This is only
interesting for extensions in the
add-build-extensions property.</para></listitem>
</varlistentry>
Expand Down