diff options
| author | Philip Withnall <withnall@endlessm.com> | 2020-04-21 16:23:10 +0100 |
|---|---|---|
| committer | Alexander Larsson <alexander.larsson@gmail.com> | 2020-04-23 10:13:19 +0200 |
| commit | b743ca64780bb308eaa8cc765c4723b80f1b0bb3 (patch) | |
| tree | 540a964de2c1c4c70fc90ad7afc9e790d4f1bb20 | |
| parent | 58246684184b7cf9af535dd2f77da168348b6692 (diff) | |
| download | flatpak-b743ca64780bb308eaa8cc765c4723b80f1b0bb3.tar.gz | |
flatpak-transaction: Clarify some documentation around skipped ops
Make it explicit that skipped ops are excluded when returning the ops in
a transaction, or when working out whether it’s empty.
Signed-off-by: Philip Withnall <withnall@endlessm.com>
| -rw-r--r-- | common/flatpak-transaction.c | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/common/flatpak-transaction.c b/common/flatpak-transaction.c index f22d5149..56cca6eb 100644 --- a/common/flatpak-transaction.c +++ b/common/flatpak-transaction.c @@ -685,6 +685,10 @@ flatpak_transaction_operation_get_ref (FlatpakTransactionOperation *self) * runtime. In the case of a main app or something added to the transaction by * flatpak_transaction_add_ref(), %NULL will be returned. * + * Note that an op will be returned even if it’s marked as to be skipped when + * the transaction is run. Check that using + * flatpak_transaction_operation_get_is_skipped(). + * * Returns: (transfer none) (nullable): the #FlatpakTransactionOperation this * one is related to, or %NULL * Since: 1.7.3 @@ -875,7 +879,7 @@ flatpak_transaction_operation_get_old_metadata (FlatpakTransactionOperation *sel * flatpak_transaction_is_empty: * @self: a #FlatpakTransaction * - * Returns whether the transaction contains any operations. + * Returns whether the transaction contains any non-skipped operations. * * Returns: %TRUE if the transaction is empty */ @@ -3271,7 +3275,7 @@ sort_ops (FlatpakTransaction *self) * flatpak_transaction_get_operations: * @self: a #FlatpakTransaction * - * Gets the list of operations. + * Gets the list of operations. Skipped operations are not included. * * Returns: (transfer full) (element-type FlatpakTransactionOperation): a #GList of operations */ |