[PATCH ethtool] Set type property to console-application for provided AppStream metainfo XML

[PATCH ethtool] Set type property to console-application for provided AppStream metainfo XML

[Salvatore Bonaccorso]

As pointed out in the Debian downstream report, as ethtool is a
command-line tool the XML root myst have the type property set to
console-application.

Additionally with the type propety set to desktop, ethtool is user
uninstallable via GUI (such as GNOME Software or KDE Discover).

Fixes: 02d505bba6fe ("Add AppStream metainfo XML with modalias documented supported hardware.")
Reported-by: asciiwolf@seznam.cz
Cc: Petter Reinholdtsen <pere@hungry.com>
Link: https://bugs.debian.org/1102647
Link: https://bugzilla.redhat.com/show_bug.cgi?id=2359069
Link: https://freedesktop.org/software/appstream/docs/sect-Metadata-ConsoleApplication.html
Signed-off-by: Salvatore Bonaccorso <carnil@debian.org>
---
 org.kernel.software.network.ethtool.metainfo.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/org.kernel.software.network.ethtool.metainfo.xml b/org.kernel.software.network.ethtool.metainfo.xml
index efe84c17e4cd..c31cae4bede6 100644
--- a/org.kernel.software.network.ethtool.metainfo.xml
+++ b/org.kernel.software.network.ethtool.metainfo.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<component type="desktop">
+<component type="console-application">
   <id>org.kernel.software.network.ethtool</id>
   <metadata_license>MIT</metadata_license>
   <name>ethtool</name>
-- 
2.49.0

Re: [PATCH ethtool] Set type property to console-application for provided AppStream metainfo XML

[Salvatore Bonaccorso]

Hi Michal,

On Fri, Apr 11, 2025 at 04:10:24PM +0200, Salvatore Bonaccorso wrote:
> As pointed out in the Debian downstream report, as ethtool is a
> command-line tool the XML root myst have the type property set to
> console-application.
> 
> Additionally with the type propety set to desktop, ethtool is user
> uninstallable via GUI (such as GNOME Software or KDE Discover).
> 
> Fixes: 02d505bba6fe ("Add AppStream metainfo XML with modalias documented supported hardware.")
> Reported-by: asciiwolf@seznam.cz
> Cc: Petter Reinholdtsen <pere@hungry.com>
> Link: https://bugs.debian.org/1102647
> Link: https://bugzilla.redhat.com/show_bug.cgi?id=2359069
> Link: https://freedesktop.org/software/appstream/docs/sect-Metadata-ConsoleApplication.html
> Signed-off-by: Salvatore Bonaccorso <carnil@debian.org>
> ---
>  org.kernel.software.network.ethtool.metainfo.xml | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/org.kernel.software.network.ethtool.metainfo.xml b/org.kernel.software.network.ethtool.metainfo.xml
> index efe84c17e4cd..c31cae4bede6 100644
> --- a/org.kernel.software.network.ethtool.metainfo.xml
> +++ b/org.kernel.software.network.ethtool.metainfo.xml
> @@ -1,5 +1,5 @@
>  <?xml version="1.0" encoding="UTF-8"?>
> -<component type="desktop">
> +<component type="console-application">
>    <id>org.kernel.software.network.ethtool</id>
>    <metadata_license>MIT</metadata_license>
>    <name>ethtool</name>
> -- 
> 2.49.0

ignore that please as Daniel and Petter have the proper proposal
building up.

Thanks Daniel and Petter.

Petter, once it's commited upstream I will cherry-pick back for
Debian.

Regards,
Salvatore

Re: [PATCH ethtool] Set type property to console-application for provided AppStream metainfo XML

[Petter Reinholdtsen]

You are definitely on the right track, but the proposal from Daniel is
to include a binary provides too to fill a field wanted for
console-application components, ie:

diff --git a/org.kernel.software.network.ethtool.metainfo.xml b/org.kernel.software.network.ethtool.metainfo.xml
index efe84c1..7cfacf2 100644
--- a/org.kernel.software.network.ethtool.metainfo.xml
+++ b/org.kernel.software.network.ethtool.metainfo.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<component type="desktop">
+<component type="console-application">
   <id>org.kernel.software.network.ethtool</id>
   <metadata_license>MIT</metadata_license>
   <name>ethtool</name>
@@ -11,6 +11,7 @@
   </description>
   <url type="homepage">https://www.kernel.org/pub/software/network/ethtool/</url>
   <provides>
+    <binary>ethtool</binary>
     <modalias>pci:v*d*sv*sd*bc02sc80i*</modalias>
   </provides>
 </component>

This look like a great proposal to me, and I have already tested the
change using 'appstreamcli validate-tree debian/ethtool' to check if
there are any issues with it.

The only minor information messages shown are these, which are not fatal
as far as I know:

  I: org.kernel.software.network.ethtool:6: summary-first-word-not-capitalized
  I: org.kernel.software.network.ethtool:~: content-rating-missing
  I: org.kernel.software.network.ethtool:~: developer-info-missing

-- 
Happy hacking
Petter Reinholdtsen

Re: [PATCH ethtool] Set type property to console-application for provided AppStream metainfo XML

[Salvatore Bonaccorso]

Hi,

On Sat, Apr 12, 2025 at 06:26:46AM +0200, Petter Reinholdtsen wrote:
> 
> You are definitely on the right track, but the proposal from Daniel is
> to include a binary provides too to fill a field wanted for
> console-application components, ie:
> 
> diff --git a/org.kernel.software.network.ethtool.metainfo.xml b/org.kernel.software.network.ethtool.metainfo.xml
> index efe84c1..7cfacf2 100644
> --- a/org.kernel.software.network.ethtool.metainfo.xml
> +++ b/org.kernel.software.network.ethtool.metainfo.xml
> @@ -1,5 +1,5 @@
>  <?xml version="1.0" encoding="UTF-8"?>
> -<component type="desktop">
> +<component type="console-application">
>    <id>org.kernel.software.network.ethtool</id>
>    <metadata_license>MIT</metadata_license>
>    <name>ethtool</name>
> @@ -11,6 +11,7 @@
>    </description>
>    <url type="homepage">https://www.kernel.org/pub/software/network/ethtool/</url>
>    <provides>
> +    <binary>ethtool</binary>
>      <modalias>pci:v*d*sv*sd*bc02sc80i*</modalias>
>    </provides>
>  </component>
> 
> This look like a great proposal to me, and I have already tested the
> change using 'appstreamcli validate-tree debian/ethtool' to check if
> there are any issues with it.

Yes sorry I realized Daniel did as well started to provide the
required changes.

If you want to submit the patch just ignore my submission.

Can we add a Tested-by: Petter Reinholdtsen <pere@hungry.com> ?

> The only minor information messages shown are these, which are not fatal
> as far as I know:
> 
>   I: org.kernel.software.network.ethtool:6: summary-first-word-not-capitalized
>   I: org.kernel.software.network.ethtool:~: content-rating-missing
>   I: org.kernel.software.network.ethtool:~: developer-info-missing

I think at least the summary-first-word-not-capitalized should be done
in a seprate commit? Not sure about the other two reported info level
issues.

The updated patch is below, changes v1->v2 is adding the binary
provides tag.

Regards,
Salvatore

From 7daa26e40d0888c13a2346053638408c03376015 Mon Sep 17 00:00:00 2001
From: Salvatore Bonaccorso <carnil@debian.org>
Date: Fri, 11 Apr 2025 15:58:55 +0200
Subject: [PATCH] Set type property to console-application for provided
 AppStream metainfo XML

As pointed out in the Debian downstream report, as ethtool is a
command-line tool the XML root myst have the type property set to
console-application.

Additionally with the type propety set to desktop, ethtool is user
uninstallable via GUI (such as GNOME Software or KDE Discover).

console-application AppStream metainfo XML at least one binary provided
must be listed in the <binary> tag, thus add the required value along.

Fixes: 02d505bba6fe ("Add AppStream metainfo XML with modalias documented supported hardware.")
Reported-by: Daniel Rusek <asciiwolf@seznam.cz>
Co-Developed-by: Daniel Rusek <asciiwolf@seznam.cz>
Link: https://bugs.debian.org/1102647
Link: https://bugzilla.redhat.com/show_bug.cgi?id=2359069
Link: https://freedesktop.org/software/appstream/docs/sect-Metadata-ConsoleApplication.html
Tested-by: Petter Reinholdtsen <pere@hungry.com>
Signed-off-by: Salvatore Bonaccorso <carnil@debian.org>
---
 org.kernel.software.network.ethtool.metainfo.xml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/org.kernel.software.network.ethtool.metainfo.xml b/org.kernel.software.network.ethtool.metainfo.xml
index efe84c17e4cd..7cfacf223af7 100644
--- a/org.kernel.software.network.ethtool.metainfo.xml
+++ b/org.kernel.software.network.ethtool.metainfo.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<component type="desktop">
+<component type="console-application">
   <id>org.kernel.software.network.ethtool</id>
   <metadata_license>MIT</metadata_license>
   <name>ethtool</name>
@@ -11,6 +11,7 @@
   </description>
   <url type="homepage">https://www.kernel.org/pub/software/network/ethtool/</url>
   <provides>
+    <binary>ethtool</binary>
     <modalias>pci:v*d*sv*sd*bc02sc80i*</modalias>
   </provides>
 </component>
-- 
2.49.0

Re: [PATCH ethtool] Set type property to console-application for provided AppStream metainfo XML

[Petter Reinholdtsen]

[Salvatore Bonaccorso]
> Can we add a Tested-by: Petter Reinholdtsen <pere@hungry.com> ?

Sure. :)

> I think at least the summary-first-word-not-capitalized should be done
> in a seprate commit? Not sure about the other two reported info level
> issues.

Note, I believe neither of them need to be addressed, as they are minor
nitpick issues that do not affect the usefulnes of the entry, and only
affect the amount of noise from appstreamcli validate-tree. :)

-- 
Happy hacking
Petter Reinholdtsen