Skip to content
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.

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

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

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

Conversation

jwakely
Copy link
Contributor

@jwakely jwakely commented Mar 13, 2023

I'm not sure what the sentence "Extension define extension points in the app/runtime that can be implemented by extensions, supplying extra files which are available during runtime" is really trying to say (it uses the word extension too many times!) but I think this is better.

I'm also not sure exactly what the no-debuginfo description is saying. Please check my changes make sense.

doc/flatpak-manifest.xml Outdated Show resolved Hide resolved
@TingPing
Copy link
Member

TingPing commented Mar 13, 2023

I'm not sure what the sentence "Extension define extension points in the app/runtime that can be implemented by extensions, supplying extra files which are available during runtime" is really trying to say (it uses the word extension too many times!) but I think this is better.

The first "Extension" is referring to the item type itself. You could probably omit it and say:

Defines extension points ...

@jwakely
Copy link
Contributor Author

jwakely commented Mar 13, 2023

You could probably omit it and say:

Yes, the same thought had occurred to me. I'll push an update to the branch.

<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>

@@ -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,

@@ -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>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants