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.

Sign up for GitHub

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

Jump to bottom

Add appdata file and make it known to Makefile.am #1142

Closed
wants to merge 14 commits into from
Closed

Add appdata file and make it known to Makefile.am #1142

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
78dc206
Add appdata file and make it known to Makefile.am.
badshah400 Jul 19, 2016
4dfb964
Make appdata file translatable.
badshah400 Jul 19, 2016
4674d12
Change name to "Geany IDE".
badshah400 Jul 19, 2016
923ec5b
Drop pkgname field, supposed to be used by downstream packagers.
badshah400 Jul 19, 2016
7097a9d
Improve description using text from upstream README.
badshah400 Jul 20, 2016
7f9bcab
Update Makefile.am logic for appdata file.
badshah400 Jul 20, 2016
2be68cb
Update appstream file with inputs from PR#1142.
badshah400 Jul 20, 2016
ed86b5a
Incorporate new suggestions from PR#1142.
badshah400 Jul 20, 2016
0eac4c6
Add translation field to appstream file.
badshah400 Jul 20, 2016
976898a
Fix tab vs space issue, other formatting.
badshah400 Jul 20, 2016
32c4f45
Change install dir to /usr/share/metainfo.
badshah400 Jul 20, 2016
fbe987a
Move xml.in->xml.in.in and run it through configure.ac
badshah400 Jul 28, 2016
7b6e4be
Revert "Move xml.in->xml.in.in and run it through configure.ac"
badshah400 Jul 28, 2016
b8885f1
Insert package name directly into translation node.
badshah400 Jul 28, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions Makefile.am
View file
Open in desktop
Expand Up @@ -17,6 +17,7 @@ WIN32_BUILD_FILES = \
EXTRA_DIST = \
autogen.sh \
scripts/gen-api-gtkdoc.py \
geany.appdata.xml.in \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

indentation issue

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I am probably wrong, but I don't see it. Everything lines up just well:
https://github.com/badshah400/geany/blob/master/Makefile.am

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, because GitHub uses tab stops of 8 and doesn't display tabs or spaces themselves, so it alignes,but it should be exactly one tab like the other lines, not 4 spaces. And you can see in the diff that it's not aligned.

diff --git a/Makefile.am b/Makefile.am
index c5d2a90..ffa9b33 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -17,7 +17,7 @@ WIN32_BUILD_FILES = \
 EXTRA_DIST = \
    autogen.sh \
    scripts/gen-api-gtkdoc.py \
-        geany.appdata.xml.in \
+   geany.appdata.xml.in \
    geany.desktop.in \
    geany.pc.in \
    geany.spec \
@@ -87,8 +87,7 @@ desktop_in_files = geany.desktop
 desktop_DATA = $(desktop_in_files:.desktop.in=.desktop)
 @INTLTOOL_DESKTOP_RULE@

-appdata_in_files = geany.appdata.xml.in
-
 appdatadir = $(datadir)/appdata
+appdata_in_files = geany.appdata.xml.in
 nodist_appdata_DATA = $(appdata_in_files:.xml.in=.xml)
 @INTLTOOL_XML_RULE@

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, thanks!

geany.desktop.in \
geany.pc.in \
geany.spec \
Expand Down Expand Up @@ -85,3 +86,9 @@ desktopdir = $(datadir)/applications
desktop_in_files = geany.desktop
desktop_DATA = $(desktop_in_files:.desktop.in=.desktop)
@INTLTOOL_DESKTOP_RULE@

appdata_in_files = geany.appdata.xml.in
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be at the same place as the desktop one relative to the dir and other definitions, and the extra blank line removed.


appdatadir = $(datadir)/appdata
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

generally, there is a trend toward /usr/share/metainfo - for new code I'd recommend following this move.
See https://www.freedesktop.org/software/appstream/docs/chap-Quickstart.html#sect-Quickstart-DesktopApps

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since its for distros why should we say where it goes? Different distributions put things in different places, it shoudlbe up to them. Since this is no use for anyone who installs geany from tarball or source it doesn't need to be installed by our build.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

generally, there is a trend toward /usr/share/metainfo

Indeed, that's what all linked docs state (they are unexpectedly consistent on that)

nodist_appdata_DATA = $(appdata_in_files:.appdata.xml.in=.appdata.xml)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.xml.in=.xml would be enough

@INTLTOOL_XML_RULE@
42 changes: 42 additions & 0 deletions geany.appdata.xml.in
View file
Open in desktop
@@ -0,0 +1,42 @@
<?xml version='1.0' encoding='UTF-8'?>
<component>
<id type="desktop">geany.desktop</id>
<metadata_license>CC0-1.0</metadata_license>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this one file in the entire source not GPL? I suspect LICENSE needs updating.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A permissive license is required for the metadata file alone; see here

<_name>Geany IDE</_name>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now pkgname is gone, maybe this should be Geany only

<project_license>GPL-2.0+</project_license>
<_summary>A fast and lightweight IDE</_summary>
<url type="homepage">http://geany.org/</url>
<description>
<_p>Geany was developed to provide a small and fast IDE, which has only a
few dependencies on other packages. Another goal was to be as independent
as possible from a specific Desktop Environment like KDE or GNOME.</_p>

<_p>Geany includes the following features:</_p>
<ul>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

List probably needs a heading like "Geany includes:"

<_li>Syntax highlighting</_li>
<_li>Code completion</_li>
<_li>Auto completion of often used constructs like if, for and while</_li>
<_li>Auto completion of XML and HTML tags</_li>
<_li>Call tips</_li>
<_li>Code folding</_li>
<_li>Many supported filetypes like C, Java, PHP, HTML, Python, Perl, Pascal</_li>
<_li>Symbol lists</_li>
<_li>Embedded terminal emulation</_li>
<_li>Extensibility through plugins.</_li>
</ul>
</description>
<screenshots>
<!-- Screenshots are recommended to be 16:9 ratio but the ones here from the main website are not. Please
change the links to point to appropriate 16:9 sized screenshots. -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So additional maintenance work required to keep screenshots updated? and which distro and theme do we make them for?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only if you want to. Think of this as as advertisement for your app. You choose to put the screenshots that best shows your app off.

<screenshot type="default">
<image height="808" width="942">http://www.geany.org/uploads/Gallery/geany_main.png</image>
</screenshot>
<screenshot>
<image height="808" width="942">http://www.geany.org/uploads/Gallery/geany_build.png</image>
</screenshot>
<screenshot>
<image height="808" width="942">http://www.geany.org/uploads/Gallery/geany_vte.png</image>
</screenshot>
</screenshots>
<update_contact>https://github.com/geany/geany</update_contact>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's unfortunately unclear whether anything else than an email address is allowed. But well, I prefer that.

</component>
1 change: 1 addition & 0 deletions po/POTFILES.in
View file
Open in desktop
@@ -1,5 +1,6 @@
# List of source files containing translatable strings.

geany.appdata.xml.in
geany.desktop.in
data/geany.glade
src/about.c
Expand Down