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

news-to-metainfo: elements within Translations header are omitted #270

Closed
fedelibre opened this issue Apr 22, 2020 · 3 comments
Closed

news-to-metainfo: elements within Translations header are omitted #270

fedelibre opened this issue Apr 22, 2020 · 3 comments

Comments

@fedelibre
Copy link

After reading your interesting blog post, I started experimenting with news-to-metainfo command.

I had some headaches initially to guess the format of NEWS file, in particular the one (not two!) space indentation required by bulletted lists. GNU did not set any standard format, right? I mean, there's no link to point people to?

Anyway, I'm writing to complain about a weird behaviour, probably a bug. The following string in NEWS

Translations:
 - Updated dutch and italian translations.
 - Added esperanto.

is converted into

<p>This release updates translations.</p>

Why is it ignoring the items in the list?
How can I specify which languages have been updated or added?

@ximion
Copy link
Owner

ximion commented Apr 22, 2020

I had some headaches initially to guess the format of NEWS file, in particular the one (not two!) space indentation required by bulletted lists. GNU did not set any standard format, right? I mean, there's no link to point people to?

Sadly no, BUT we could create that ;-) I see no reason why we shouldn't specify that in the AppStream spec as auxiliary format - PRs for the documentation are very welcome on this (I might have a look at this myself at some point, but I am currently a bit busy with porting the specification to another doc generator).
For the spacing, maybe appstreamcli should simply support one or two spaces. I'll have a look at that.

As for the conversion of the "translations" section: This was adopted from GNOME behavior, as a lot of people tend to create very long lists of languages under that section that aren't interesting to people who read the release information.
I do see that this is surprising though... I wonder whether this behavior should be made configurable.

ximion added a commit that referenced this issue Apr 22, 2020
@fedelibre
Copy link
Author

Actually, I'm fine with the idea of stripping translations details in the metainfo files. I just wanted to be sure it was intended.

Allowing arbitrary indentation in NEWS is a good idea, thanks for the quick fix.

I would keep this issue open as a reminder to include all this information in the doc.
I may send a PR when I find some spare time.

@ximion
Copy link
Owner

ximion commented Jan 5, 2021

Very good, thank you!

@ximion ximion closed this as completed Jan 5, 2021
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

No branches or pull requests

2 participants