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

quickstart docs unclear about releases/provides tag #51

Closed
cbm755 opened this issue Jun 17, 2016 · 7 comments
Closed

quickstart docs unclear about releases/provides tag #51

cbm755 opened this issue Jun 17, 2016 · 7 comments
Assignees

Comments

@cbm755
Copy link

cbm755 commented Jun 17, 2016

https://www.freedesktop.org/software/appstream/docs/chap-Quickstart.html#sect-Quickstart-DesktopApps

4.1.4. Suggested metadata file contents

You may choose to add these tags as well, if you need them.

Ok so "I may". I'm not sure if I "need them" or not, so I read further...

<releases/>
    The application metainfo should at least provide one <releases/> tag

Now its "I should".

The <provides> tag is similarly unclear to me.

@ximion
Copy link
Owner

ximion commented Jun 17, 2016

Jup, it's definitely a "can be added" not a "must be present". We do recommend the tags though.

@ximion ximion self-assigned this Jun 17, 2016
@ximion ximion closed this as completed in b05e7e9 Jun 17, 2016
@ximion
Copy link
Owner

ximion commented Jun 17, 2016

The wording should be more clear now - please check if this makes sense to you :-)

ximion added a commit that referenced this issue Jun 17, 2016
@cbm755
Copy link
Author

cbm755 commented Jun 17, 2016

The application metainfo may at least provides one

This sounds awkward, and provides should not have an s.

Is this better?

The application metainfo may include a single <code>&lt;releases/&gt;</code> tag...

(unless there is a common reason to have more than one?!)

@ximion
Copy link
Owner

ximion commented Jun 17, 2016

Yes, there must never be more than one <releases/> tag, in fact. It may have multiple release subnodes though.

ximion added a commit that referenced this issue Jun 17, 2016
@cbm755
Copy link
Author

cbm755 commented Jun 17, 2016 via email

@ximion
Copy link
Owner

ximion commented Jun 17, 2016

Good, but your update implies more than one ok
Since this isn't the actual specification, but a supplementary document, I think this is fine. Changing "one" to "a single" would make sense, but having the former is also okay, IMHO. It isn't confusing.

@cbm755
Copy link
Author

cbm755 commented Jun 17, 2016

The application metainfo may at least provides one

But this this sentence is not parse-able: delete "at least" and drop the "s" from provide.

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

No branches or pull requests

2 participants