From: Michael Schroeder <mls@suse.de>
Date: Wed, 16 Oct 2013 10:13:46 +0000 (+0200)
Subject: add some comments about what linked packages are
X-Git-Tag: 0.6.4~185
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=42ac7c30443dc709ed1746bd9cdb983fc657f5ab;p=thirdparty%2Flibsolv.git

add some comments about what linked packages are
---

diff --git a/src/linkedpkg.c b/src/linkedpkg.c
index 6df497c0..dc0a3baa 100644
--- a/src/linkedpkg.c
+++ b/src/linkedpkg.c
@@ -7,6 +7,26 @@
 
 /*
  * linkedpkg.c
+ *
+ * Linked packages are "pseudo" packages that are bound to real packages but
+ * contain different information (name/summary/description). They are normally
+ * somehow generated from the real packages, either when the repositories are
+ * created or automatically from the packages by looking at the provides.
+ *
+ * We currently support:
+ *
+ * application:
+ *   created from AppStream appdata xml in the repository (which is generated
+ *   from files in /usr/share/appdata)
+ *
+ * product:
+ *   created from product data in the repository (which is generated from files
+ *   in /etc/products.d. In the future we may switch to using product()
+ *   provides of packages.
+ * 
+ * pattern:
+ *   created from pattern() provides of packages.
+ *
  */
 
 #include <stdio.h>