From c3f5dfa932854b8a08987758d68eca411c3ce858 Mon Sep 17 00:00:00 2001 From: Jonathan Wakely Date: Tue, 14 Mar 2023 20:16:40 +0000 Subject: [PATCH] Improve grammar in doc/flatpak-manifest.xml --- doc/flatpak-manifest.xml | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/flatpak-manifest.xml b/doc/flatpak-manifest.xml index af7b7e09..5c8a269b 100644 --- a/doc/flatpak-manifest.xml +++ b/doc/flatpak-manifest.xml @@ -59,15 +59,15 @@ (string) The branch to use when exporting - the application. If this is unset the defaults - come from the default-branch option. + the application. If this is unset the default + comes from the default-branch option. 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. + that can be overridden by the --default-branch option + (e.g., to test a build from another branch). (string) @@ -80,9 +80,9 @@ (string) 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. @@ -132,7 +132,7 @@ (string) 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, install a shell script wrapper and use that as the command. Also note that the command is used when the application is run via @@ -377,7 +377,7 @@ (array of strings) - This is a array defining which host environment variables is transfered to build-commands or post-install environment. + This is a array defining which host environment variables are transfered to the build-commands or post-install environment. (array of strings) @@ -394,8 +394,8 @@ (array of strings) 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' + configure, meant to be used to pass secrets through host environment variables. + Environment variables in the options will be expanded. '-DSECRET_ID=$CI_SECRET' (array of strings) @@ -411,24 +411,24 @@ (boolean) - 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. + 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. (boolean) - By default when extracting debuginfo we compress the debug sections. If you want to disable this, set no-debuginfo-compression to true. + By default when extracting debuginfo the debug sections are compressed. If you want to disable this, set no-debuginfo-compression to true. (object) - This is a dictionary defining for each arch a separate build options object that override the main one. + This is a dictionary defining a separate build options object for each arch, to override the main build options. Extension - 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. These are the properties that are accepted: @@ -452,7 +452,7 @@ (boolean) 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.