[gnome-software/1077-stop-mentioning-the-steam-plugin-in-docs] api-doc: Update documentation to not mention 'steam' plugin
- From: Milan Crha <mcrha src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-software/1077-stop-mentioning-the-steam-plugin-in-docs] api-doc: Update documentation to not mention 'steam' plugin
- Date: Fri, 13 May 2022 08:32:54 +0000 (UTC)
commit 79e6127d5183bd93f216f37b467856f4eff4326b
Author: Milan Crha <mcrha redhat com>
Date: Fri May 13 10:31:39 2022 +0200
api-doc: Update documentation to not mention 'steam' plugin
The 'steam' plugin does not exist anymore, thus remove it from
the API documentation.
Closes https://gitlab.gnome.org/GNOME/gnome-software/-/issues/1077
doc/api/gnome-software-docs.xml | 18 +++++-------------
1 file changed, 5 insertions(+), 13 deletions(-)
---
diff --git a/doc/api/gnome-software-docs.xml b/doc/api/gnome-software-docs.xml
index 27c25f0d5..ecc9545d5 100644
--- a/doc/api/gnome-software-docs.xml
+++ b/doc/api/gnome-software-docs.xml
@@ -27,7 +27,7 @@
each one can do things like editing an existing application or adding a
new application to the result set.
This is how we can add support for things like firmware updating,
- Steam, GNOME Shell web-apps and flatpak bundles without making big
+ GNOME Shell web-apps and flatpak bundles without making big
changes all over the source tree.
</para>
<para>
@@ -597,20 +597,12 @@ gs_plugin_example_refine_finish (GsPlugin *plugin,
<para>
This allows plugins to care a lot less about how applications are
going to be shown.
- For example, the <code>steam</code> plugin downloads and parses the
- descriptions from a remote service during
- <code>refresh_metadata_async()</code>, and also finds the best icon types
- and downloads them too.
- Then it exports the data to an AppStream XML file, saving it to your
- home directory.
- This allows all the applications to be easily created (and then refined)
- using something as simple as <code>gs_app_new("steam:foo.desktop")</code>.
- All the search tokenisation and matching is done automatically,
- so it makes the plugin much simpler and faster.
+ For example, the <code>flatpak</code> plugin downloads AppStream data
+ for configured remotes during <code>refresh_metadata_async()</code>.
</para>
<para>
- The only extra step the steam plugin needs to do is implement the
- <code>gs_plugin_adopt_app()</code> function.
+ The only extra step a plugin providing its own apps needs to do
+ is to implement the <code>gs_plugin_adopt_app()</code> function.
This is called when an application does not have a management plugin
set, and allows the plugin to <emphasis>claim</emphasis> the
application for itself so it can handle installation, removal and
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]