summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2018-08-31 08:10:58 -0400
committerMatthias Clasen <mclasen@redhat.com>2018-08-31 08:10:58 -0400
commitef2fb488b063368792b878ef3d0852207542a6d5 (patch)
treee6fb274b95ca8a3afe94dcf786e6818eeb78e439
parent90d5af5ee39bcde6bc660e6e0de2f3e029258afc (diff)
downloadflatpak-api-docs.tar.gz
fixup! Add more api docs for libflatpakapi-docs
-rw-r--r--common/flatpak-transaction.c17
1 files changed, 11 insertions, 6 deletions
diff --git a/common/flatpak-transaction.c b/common/flatpak-transaction.c
index e4be9460..e1a9bd15 100644
--- a/common/flatpak-transaction.c
+++ b/common/flatpak-transaction.c
@@ -614,6 +614,10 @@ flatpak_transaction_operation_get_commit (FlatpakTransactionOperation *self)
* Gets the metadata that will be applicable when the
* operation is done.
*
+ * This can be compared to the current metadata returned
+ * by flatpak_transaction_operation_get_old_metadata()
+ * to find new required permissions and similar changes.
+ *
* This information is available when the transaction is resolved,
* i.e. when #FlatpakTransaction::ready is emitted.
*
@@ -629,8 +633,8 @@ flatpak_transaction_operation_get_metadata (FlatpakTransactionOperation *self)
* flatpak_transaction_operation_get_old_metadata:
* @self: a #FlatpakTransactionOperation
*
- * Gets the metadata that will is applicable before the
- * operation is done.
+ * Gets the metadata current metadata for the ref that @self works on.
+ * Also see flatpak_transaction_operation_get_metadata().
*
* This information is available when the transaction is resolved,
* i.e. when #FlatpakTransaction::ready is emitted.
@@ -1058,10 +1062,10 @@ flatpak_transaction_set_disable_prune (FlatpakTransaction *self,
/**
* flatpak_transaction_set_disable_dependencies:
* @self: a #FlatpakTransaction
- * @disable_dependencies: whether to disable dependencies
+ * @disable_dependencies: whether to disable runtime dependencies
*
- * Sets whether the transaction should ignore dependencies when resolving
- * operations.
+ * Sets whether the transaction should ignore runtime dependencies
+ * when resolving operations for applications.
*/
void
flatpak_transaction_set_disable_dependencies (FlatpakTransaction *self,
@@ -1078,7 +1082,8 @@ flatpak_transaction_set_disable_dependencies (FlatpakTransaction *self,
* @disable_related: whether to avoid adding related refs
*
* Sets whether the transaction should avoid adding related refs
- * when resolving operations.
+ * when resolving operations. Related refs are extensions that are
+ * suggested by apps, such as locales.
*/
void
flatpak_transaction_set_disable_related (FlatpakTransaction *self,