[gnome-software] trivial: Move the now-obsolete README file to the source files
- From: Richard Hughes <rhughes src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-software] trivial: Move the now-obsolete README file to the source files
- Date: Thu, 14 Jan 2016 20:50:43 +0000 (UTC)
commit 4d71941773217eb35758537e8210c48440368b27
Author: Richard Hughes <richard hughsie com>
Date: Thu Jan 14 20:45:42 2016 +0000
trivial: Move the now-obsolete README file to the source files
It bitrotted being a separate document.
src/gs-plugin.c | 18 ++++
src/plugins/README.md | 120 -------------------------
src/plugins/gs-plugin-appstream.c | 11 +++
src/plugins/gs-plugin-dummy.c | 8 ++
src/plugins/gs-plugin-epiphany.c | 7 ++
src/plugins/gs-plugin-fedora-provenance.c | 8 ++
src/plugins/gs-plugin-fedora-tagger-ratings.c | 7 ++
src/plugins/gs-plugin-fedora-tagger-usage.c | 7 ++
src/plugins/gs-plugin-fwupd.c | 8 ++
src/plugins/gs-plugin-hardcoded-featured.c | 8 ++
src/plugins/gs-plugin-icons.c | 8 ++
src/plugins/gs-plugin-limba.c | 5 +
src/plugins/gs-plugin-local-ratings.c | 11 ++-
src/plugins/gs-plugin-menu-spec-categories.c | 6 ++
src/plugins/gs-plugin-menu-spec-refine.c | 6 ++
src/plugins/gs-plugin-moduleset.c | 6 ++
src/plugins/gs-plugin-packagekit-history.c | 5 +
src/plugins/gs-plugin-packagekit-offline.c | 8 ++
src/plugins/gs-plugin-packagekit-refine.c | 9 ++
src/plugins/gs-plugin-packagekit-refresh.c | 6 ++
src/plugins/gs-plugin-packagekit.c | 9 ++
src/plugins/gs-plugin-systemd-updates.c | 6 ++
22 files changed, 166 insertions(+), 121 deletions(-)
---
diff --git a/src/gs-plugin.c b/src/gs-plugin.c
index 9818f96..78763f3 100644
--- a/src/gs-plugin.c
+++ b/src/gs-plugin.c
@@ -19,6 +19,24 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
+/* Introduction:
+ *
+ * Plugins are modules that are loaded at runtime to provide information
+ * about requests and to service user actions like installing, removing
+ * and updating.
+ * This allows different distributions to pick and choose how the
+ * application installer gathers data.
+ *
+ * Plugins also have a priority system where the largest number gets
+ * run first. That means if one plugin requires some property or
+ * metadata set by another plugin then it **must** depend on the other
+ * plugin to be run in the correct order.
+ *
+ * As a general rule, try to make plugins as small and self-contained
+ * as possible and remember to cache as much data as possible for speed.
+ * Memory is cheap, time less so.
+ */
+
#include "config.h"
#include <glib.h>
diff --git a/src/plugins/gs-plugin-appstream.c b/src/plugins/gs-plugin-appstream.c
index b09b637..c8a2710 100644
--- a/src/plugins/gs-plugin-appstream.c
+++ b/src/plugins/gs-plugin-appstream.c
@@ -28,6 +28,17 @@
#include "appstream-common.h"
+/*
+ * SECTION:
+ * Uses offline AppStream data to populate and refine package results.
+ *
+ * This plugin calls UpdatesChanged() if any of the AppStream stores are
+ * changed in any way.
+ *
+ * Methods: | AddCategory
+ * Refines: | [source]->[name,summary,pixbuf,id,kind]
+ */
+
struct GsPluginPrivate {
AsStore *store;
GMutex store_mutex;
diff --git a/src/plugins/gs-plugin-dummy.c b/src/plugins/gs-plugin-dummy.c
index e1b779e..dd3a6ff 100644
--- a/src/plugins/gs-plugin-dummy.c
+++ b/src/plugins/gs-plugin-dummy.c
@@ -23,6 +23,14 @@
#include <gs-plugin.h>
+/*
+ * SECTION:
+ * Provides some dummy data that is useful in self test programs.
+ *
+ * Methods: | Search, AddUpdates, AddInstalled, AddPopular
+ * Refines: | [id]->[name], [id]->[summary]
+ */
+
struct GsPluginPrivate {
guint dummy;
};
diff --git a/src/plugins/gs-plugin-epiphany.c b/src/plugins/gs-plugin-epiphany.c
index c711efb..685581f 100644
--- a/src/plugins/gs-plugin-epiphany.c
+++ b/src/plugins/gs-plugin-epiphany.c
@@ -31,6 +31,13 @@
#include <gs-plugin.h>
#include <gs-utils.h>
+/*
+ * SECTION:
+ * Uses epiphany to launch web applications.
+ *
+ * If the epiphany binary is not present then it self-disables.
+ */
+
/**
* gs_plugin_get_name:
*/
diff --git a/src/plugins/gs-plugin-fedora-provenance.c b/src/plugins/gs-plugin-fedora-provenance.c
index 7d87580..ec337b0 100644
--- a/src/plugins/gs-plugin-fedora-provenance.c
+++ b/src/plugins/gs-plugin-fedora-provenance.c
@@ -23,6 +23,14 @@
#include <gs-plugin.h>
+/*
+ * SECTION:
+ * Sets the package provanance to TRUE if installed by an official
+ * Fedora repo.
+ *
+ * It will self-disable if not run on a Fedora system.
+ */
+
/**
* gs_plugin_get_name:
*/
diff --git a/src/plugins/gs-plugin-fedora-tagger-ratings.c b/src/plugins/gs-plugin-fedora-tagger-ratings.c
index 6a2cefc..6f72a72 100644
--- a/src/plugins/gs-plugin-fedora-tagger-ratings.c
+++ b/src/plugins/gs-plugin-fedora-tagger-ratings.c
@@ -30,6 +30,13 @@
#include <gs-plugin.h>
#include <gs-utils.h>
+/*
+ * SECTION:
+ * Gets and sets the application rating using the fedora-tagger service.
+ *
+ * It will self-disable if not run on a Fedora system.
+ */
+
struct GsPluginPrivate {
SoupSession *session;
gchar *db_path;
diff --git a/src/plugins/gs-plugin-fedora-tagger-usage.c b/src/plugins/gs-plugin-fedora-tagger-usage.c
index 9be1a25..d5ce131 100644
--- a/src/plugins/gs-plugin-fedora-tagger-usage.c
+++ b/src/plugins/gs-plugin-fedora-tagger-usage.c
@@ -29,6 +29,13 @@
#include <gs-plugin.h>
#include <gs-utils.h>
+/*
+ * SECTION:
+ * Gets the application usage data using the fedora-tagger service.
+ *
+ * It will self-disable if not run on a Fedora system.
+ */
+
struct GsPluginPrivate {
SoupSession *session;
};
diff --git a/src/plugins/gs-plugin-fwupd.c b/src/plugins/gs-plugin-fwupd.c
index fe5a38b..fedfafb 100644
--- a/src/plugins/gs-plugin-fwupd.c
+++ b/src/plugins/gs-plugin-fwupd.c
@@ -33,6 +33,14 @@
#include "gs-utils.h"
+/*
+ * SECTION:
+ * Queries for new firmware and schedules it to be installed as required.
+ *
+ * This plugin calls UpdatesChanged() if any updatable devices are
+ * added or removed or if a device has been updated live.
+ */
+
struct GsPluginPrivate {
GMutex mutex;
GDBusProxy *proxy;
diff --git a/src/plugins/gs-plugin-hardcoded-featured.c b/src/plugins/gs-plugin-hardcoded-featured.c
index 5287117..1f36b54 100644
--- a/src/plugins/gs-plugin-hardcoded-featured.c
+++ b/src/plugins/gs-plugin-hardcoded-featured.c
@@ -23,6 +23,14 @@
#include <gs-plugin.h>
+/*
+ * SECTION:
+ * Provides some hardcoded static featured applications from the
+ * installed featured.ini file.
+ *
+ * Methods: | AddFeatured
+ */
+
/**
* gs_plugin_get_name:
*/
diff --git a/src/plugins/gs-plugin-icons.c b/src/plugins/gs-plugin-icons.c
index 61fd0ef..299d180 100644
--- a/src/plugins/gs-plugin-icons.c
+++ b/src/plugins/gs-plugin-icons.c
@@ -30,6 +30,14 @@
#include <gs-plugin.h>
#include <gs-utils.h>
+/*
+ * SECTION:
+ * Loads remote icons and converts them into local cached ones.
+ *
+ * It is provided so that each plugin handling REMOTE icons does not
+ * have to handle the download and caching functionality.
+ */
+
struct GsPluginPrivate {
SoupSession *session;
};
diff --git a/src/plugins/gs-plugin-limba.c b/src/plugins/gs-plugin-limba.c
index 885aea7..a111c67 100644
--- a/src/plugins/gs-plugin-limba.c
+++ b/src/plugins/gs-plugin-limba.c
@@ -26,6 +26,11 @@
#include <appstream-glib.h>
#include <gs-plugin.h>
+/*
+ * SECTION:
+ * Adds and removes limba packages.
+ */
+
struct GsPluginPrivate {
LiManager *mgr;
};
diff --git a/src/plugins/gs-plugin-local-ratings.c b/src/plugins/gs-plugin-local-ratings.c
index ef8c199..b38bfc2 100644
--- a/src/plugins/gs-plugin-local-ratings.c
+++ b/src/plugins/gs-plugin-local-ratings.c
@@ -27,8 +27,17 @@
#include <gs-plugin.h>
#include <gs-utils.h>
+/*
+ * SECTION:
+ * Provides a local SQL database of user-set ratings, useful for
+ * testing or when the user 'overrides' the default rating.
+ *
+ * Methods: | AppSetRating
+ * Refines: | [id]->[rating]
+ */
+
struct GsPluginPrivate {
- gsize loaded;
+ gsize loaded;
gchar *db_path;
sqlite3 *db;
};
diff --git a/src/plugins/gs-plugin-menu-spec-categories.c b/src/plugins/gs-plugin-menu-spec-categories.c
index ab4e423..5d56f6c 100644
--- a/src/plugins/gs-plugin-menu-spec-categories.c
+++ b/src/plugins/gs-plugin-menu-spec-categories.c
@@ -26,6 +26,12 @@
#include "menu-spec-common.h"
+/*
+ * SECTION:
+ * Adds categories from a hardcoded list based on the the desktop menu
+ * specification.
+ */
+
/**
* gs_plugin_get_name:
*/
diff --git a/src/plugins/gs-plugin-menu-spec-refine.c b/src/plugins/gs-plugin-menu-spec-refine.c
index f068f5a..4c0197f 100644
--- a/src/plugins/gs-plugin-menu-spec-refine.c
+++ b/src/plugins/gs-plugin-menu-spec-refine.c
@@ -26,6 +26,12 @@
#include "menu-spec-common.h"
+/*
+ * SECTION:
+ * Sets the menu path of the applcation using the Freedesktop menu spec
+ * previously set.
+ */
+
/**
* gs_plugin_get_name:
*/
diff --git a/src/plugins/gs-plugin-moduleset.c b/src/plugins/gs-plugin-moduleset.c
index 9e28e91..d5937ae 100644
--- a/src/plugins/gs-plugin-moduleset.c
+++ b/src/plugins/gs-plugin-moduleset.c
@@ -29,6 +29,12 @@
#include "gs-moduleset.h"
+/*
+ * SECTION:
+ * Set some applications as non-removable system apps and also add
+ * custom featured apps depending on the desktop environment.
+ */
+
struct GsPluginPrivate {
GSettings *settings;
GsModuleset *moduleset;
diff --git a/src/plugins/gs-plugin-packagekit-history.c b/src/plugins/gs-plugin-packagekit-history.c
index ab7a783..5f20bd1 100644
--- a/src/plugins/gs-plugin-packagekit-history.c
+++ b/src/plugins/gs-plugin-packagekit-history.c
@@ -28,6 +28,11 @@
#define GS_PLUGIN_PACKAGEKIT_HISTORY_TIMEOUT 5000 /* ms */
+/*
+ * SECTION:
+ * This returns update history using the system PackageKit instance.
+ */
+
struct GsPluginPrivate {
gsize loaded;
GDBusConnection *connection;
diff --git a/src/plugins/gs-plugin-packagekit-offline.c b/src/plugins/gs-plugin-packagekit-offline.c
index 8d0b4e2..21d8a6a 100644
--- a/src/plugins/gs-plugin-packagekit-offline.c
+++ b/src/plugins/gs-plugin-packagekit-offline.c
@@ -23,6 +23,14 @@
#include <gs-plugin.h>
+/*
+ * SECTION:
+ * This adds historical updates to the application history.
+ *
+ * Note: when this is cleared by one user is is unavailable for all
+ * other users.
+ */
+
/**
* gs_plugin_get_name:
*/
diff --git a/src/plugins/gs-plugin-packagekit-refine.c b/src/plugins/gs-plugin-packagekit-refine.c
index 69091d6..c2f982c 100644
--- a/src/plugins/gs-plugin-packagekit-refine.c
+++ b/src/plugins/gs-plugin-packagekit-refine.c
@@ -30,6 +30,15 @@
#include "packagekit-common.h"
+/*
+ * SECTION:
+ * Uses the system PackageKit instance to return convert filenames to
+ * package-ids and to also discover update details about a package.
+ *
+ * Requires: | [id]
+ * Refines: | [source-id], [installed]
+ */
+
struct GsPluginPrivate {
PkControl *control;
PkClient *client;
diff --git a/src/plugins/gs-plugin-packagekit-refresh.c b/src/plugins/gs-plugin-packagekit-refresh.c
index 32e6690..76b0cf9 100644
--- a/src/plugins/gs-plugin-packagekit-refresh.c
+++ b/src/plugins/gs-plugin-packagekit-refresh.c
@@ -29,6 +29,12 @@
#include "packagekit-common.h"
+/*
+ * SECTION:
+ * Do a PackageKit UpdatePackages(ONLY_DOWNLOAD) method on refresh and
+ * also convert any package files to applications the best we can.
+ */
+
struct GsPluginPrivate {
PkTask *task;
};
diff --git a/src/plugins/gs-plugin-packagekit.c b/src/plugins/gs-plugin-packagekit.c
index 4269827..d107f48 100644
--- a/src/plugins/gs-plugin-packagekit.c
+++ b/src/plugins/gs-plugin-packagekit.c
@@ -30,6 +30,15 @@
#include "packagekit-common.h"
+/*
+ * SECTION:
+ * Uses the system PackageKit instance to return installed packages,
+ * sources and the ability to add and remove packages.
+ *
+ * Requires: | [source-id]
+ * Refines: | [source-id], [source], [update-details], [management-plugin]
+ */
+
struct GsPluginPrivate {
PkTask *task;
};
diff --git a/src/plugins/gs-plugin-systemd-updates.c b/src/plugins/gs-plugin-systemd-updates.c
index e5237e3..4a36d39 100644
--- a/src/plugins/gs-plugin-systemd-updates.c
+++ b/src/plugins/gs-plugin-systemd-updates.c
@@ -27,6 +27,12 @@
#include <gs-plugin.h>
+/*
+ * SECTION:
+ * Add previously downloads apps to the update list and also allow
+ * scheduling the offline update.
+ */
+
struct GsPluginPrivate {
GFileMonitor *monitor;
gsize done_init;
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
