From: joden <devnull@localhost>
Date: Wed, 11 Aug 2004 00:32:19 +0000 (+0000)
Subject: Add docs to rpmtsRun to explain what is required before a call
X-Git-Tag: tznext/4.11.0.1.tizen20130304~6389
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=31b9e5419a824222880b4c85fab554e904ab90e0;p=tools%2Flibrpm-tizen.git

Add docs to rpmtsRun to explain what is required before a call
to rpmtsRun can be successful.

CVS patchset: 7395
CVS date: 2004/08/11 00:32:19
---

diff --git a/lib/rpmts.h b/lib/rpmts.h
index dc7b62c..c058a25 100644
--- a/lib/rpmts.h
+++ b/lib/rpmts.h
@@ -369,7 +369,13 @@ int rpmtsOrder(rpmts ts)
 	/*@modifies ts, rpmGlobalMacroContext, fileSystem, internalState @*/;
 
 /** \ingroup rpmts
- * Process all package elements in a transaction set.
+ * Process all package elements in a transaction set.  Before calling
+ * rpmtsRun be sure to have:
+ *
+ *    - setup the rpm root dir via rpmtsRoot().
+ *    - setup the rpm notify callback via rpmtsSetNotifyCallback().
+ *    - setup the rpm transaction flags via rpmtsSetFlags().
+ *    - setup the rpm verify signature flags via rpmtsSetVSFlags().
  *
  * @param ts		transaction set
  * @param okProbs	previously known problems (or NULL)