After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 709164 - [patch] Please include an AppData file
[patch] Please include an AppData file
Status: RESOLVED FIXED
Product: gparted
Classification: Other
Component: application
GIT HEAD
Other Linux
: Normal enhancement
: ---
Assigned To: gparted maintainers alias
gparted maintainers alias
Depends on:
Blocks:
 
 
Reported: 2013-10-01 08:10 UTC by Richard Hughes
Modified: 2013-12-09 18:13 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
patch that works for me (2.70 KB, patch)
2013-10-01 08:10 UTC, Richard Hughes
none Details | Review
GParted add an AppData file v2 (3.07 KB, patch)
2013-11-22 20:11 UTC, Curtis Gedak
none Details | Review
GParted add an AppData file v3 (3.54 KB, patch)
2013-11-23 18:48 UTC, Curtis Gedak
none Details | Review

Description Richard Hughes 2013-10-01 08:10:33 UTC
Created attachment 256161 [details] [review]
patch that works for me

Fedora users and deveolpers have written an AppData file which is used for showing screenshots and descriptions in various software centers such as GNOME Software which we are previewing in Fedora 20.

If the file is shipped upstream and installed in /usr/share/appdata, all the other Linux distributions other than Fedora can use this data themselves. Also, if the file is upstream you can change the description, screenshots and homepage as much as you like as your application evolves.

Similarly, we are translating the AppData file which is really awesome for people using the software center that can't use en_US as a locale.

Patch for review attached.

Thanks,

Richard
Comment 1 Curtis Gedak 2013-10-01 16:11:05 UTC
Hi Richard,

Thank you for bringing this enhancement to our attention, creating a bug report, and providing an initial patch.

QUESTION ON CC0 LICENSE:

I noticed that the patch specifies the CCO (Creative Commons license).  Do you see some additional advantages or disadvantages to using CC0 over the GNU Free Documentation License (GFDL) which is used for the GParted help manual?

My preference would be to keep the number of licenses used in GParted to a minimum.  Currently this is GPL v2+ and GFDL v1.2+.


For clarity sake I have included portions of your original email that included additional information and links:

   "The extra appdata files are stored here for
https://github.com/hughsie/fedora-appstream/tree/master/appdata-extra/desktop,
   but we've love these files to be included upstream and installed in
   /usr/share/appdata, which means all the other Linux distributions
   other than Fedora can use this data themselves. Also, if the file
   is upstream you can change the description, screenshots and
   homepage as much as you like as your application evolves.

   Similarly, if you have something like intltool set up, you can
   translate the AppData file which is really awesome for people using
   the software center that can't use en_US as a locale."

   See also http://people.freedesktop.org/~hughsient/appdata/


I do like that by including the appdata file upstream, the GParted team is able to control and update the content as needed.

Curtis
Comment 2 Erkin Alp Güney 2013-11-02 19:21:21 UTC
(In reply to comment #1)
> Hi Richard,
> 
> Thank you for bringing this enhancement to our attention, creating a bug
> report, and providing an initial patch.
> 
> QUESTION ON CC0 LICENSE:
> 
> I noticed that the patch specifies the CCO (Creative Commons license).  Do you
> see some additional advantages or disadvantages to using CC0 over the GNU Free
> Documentation License (GFDL) which is used for the GParted help manual?
> 
> My preference would be to keep the number of licenses used in GParted to a
> minimum.  Currently this is GPL v2+ and GFDL v1.2+.
> 
> 

> Curtis

CC0 waives all the copyright and related rights forever and unconditionally to the maximal extent.
Comment 3 Richard Hughes 2013-11-02 20:38:32 UTC
GFDL is fine as well. I'll add that to the whitelist in appdata-tools.
Comment 4 Curtis Gedak 2013-11-11 17:45:10 UTC
Thank you Erkin for the license clarification, and thank you Richard for offering to add the GFDL to the whitelist of licenses.  I will think further on the license given this new information.

I plan to create a new screen shot for this enhancement and host it on gparted.org so I anticipate needing to make some changes to the patch.
Comment 5 Mike Fleetwood 2013-11-11 18:50:35 UTC
Hi Curtis,

A few references to help with any deliberations.

"Application metadata with AppData", what it's all about
http://lwn.net/Articles/568375/

AppData specification - including allowable licenses and guidance on
the contents (included in comment #1)
http://people.freedesktop.org/~hughsient/appdata/

List of "Good" documentation licenses according to Fedora.
https://fedoraproject.org/wiki/Licensing:Main?rd=Licensing#Good_Licenses_2

Licenses CC-BY, CC-BY-SA and GFDL are allowed by AppData spec and Fedora.

Thanks,
Mike
Comment 6 Curtis Gedak 2013-11-22 20:11:45 UTC
Created attachment 261266 [details] [review]
GParted add an AppData file v2

Thank you Richard for the original patch and comments.  Thank you also Erkin and Mike for your additional clarifications.

The attached patch has been rebased on Richard's original patch and includes changes such as updated wording and URL's updated to GParted's official http://gparted.org web site.  Hopefully Richard you do not mind these changes.  I wanted to ensure that you got credit in git for the creation of this patch.  I simply edited it.

The screen shot referenced in the updated patch has been uploaded to gparted.org.

Mike, when you have a chance please review this patch.

Curtis
Comment 7 Mike Fleetwood 2013-11-23 16:48:22 UTC
Hi Curtis & Richard,

It looked OK, but when I did a "make distcheck" I got this error:

Making check in po
make[2]: Entering directory `/home/mike/programming/c/gparted/gparted-0.16.2-git/_build/po'
INTLTOOL_EXTRACT=/usr/bin/intltool-extract srcdir=../../po /usr/bin/intltool-update --gettext-package gparted --pot
can't open ../../po/../gparted.appdata.xml.in: No such file or directory at /usr/bin/intltool-extract line 211.
xgettext: error while opening "../gparted.appdata.xml.in.h" for reading: No such file or directory
ERROR: xgettext failed to generate PO template file. Please consult
       error message above if there is any.
make[2]: *** [gparted.pot] Error 1

In case it matters that was on Fedora 19 & Fedora 14.

Thanks,
Mike
Comment 8 Curtis Gedak 2013-11-23 17:18:39 UTC
Hi Mike,

Good catch on the error.  I just tried 'make distcheck' and get the same error on kubuntu 12.04.  I will investigate.

Curtis
Comment 9 Curtis Gedak 2013-11-23 18:48:53 UTC
Created attachment 261313 [details] [review]
GParted add an AppData file v3

Hi Mike,

To fix this bug I took a look at how DESKTOP_IN_FILES worked and changed the APPDATA_IN_FILES stuff to match this (including UPPER/LOWERCASE).  In the process I re-arranged the location of a few of the DESKTOP lines so that the match-up is more obvious (and because the order of these lines in Makefile.am should not matter).

This new v3 patchset passes 'make distcheck' on my kubuntu 12.04 development computer.

Curtis
Comment 10 Mike Fleetwood 2013-11-24 11:43:18 UTC
Hi Curtis and Richard,

Appdata XML validated OK and "make distcheck" succeeded on a few
different distros.  Review passed.  Patch v3 from comment #9 has been
commited to GParted GIT repository:

Add an AppData file (#709164)
https://git.gnome.org/browse/gparted/commit/?id=640f92790b7cc5e91f367dfaa01a02a7497afbb4

Thanks,
Mike
Comment 11 Curtis Gedak 2013-12-09 18:13:51 UTC
This enhancement was included in the GParted 0.17.0 release on December 9, 2013.