Clarify rpmtsCheck() documentation (rhbz#159638)
authorPanu Matilainen <pmatilai@redhat.com>
Thu, 11 Oct 2007 10:50:05 +0000 (13:50 +0300)
committerPanu Matilainen <pmatilai@redhat.com>
Thu, 11 Oct 2007 10:50:05 +0000 (13:50 +0300)
lib/rpmts.h

index 25b6f86..88ae859 100644 (file)
@@ -300,7 +300,12 @@ struct rpmts_s {
 #endif /* _RPMTS_INTERNAL */
 
 /** \ingroup rpmts
- * Check that all dependencies can be resolved.
+ * Perform dependency resolution on the transaction set.
+ *
+ * Any problems found by rpmtsCheck() can be examined by retrieving the 
+ * problem set with rpmtsProblems(), success here only means that
+ * the resolution was successfully attempted for all packages in the set.
+ *
  * @param ts           transaction set
  * @return             0 on success
  */