diff options
author | Phaedrus Leeds <mwleeds@endlessos.org> | 2020-11-04 12:16:05 -0800 |
---|---|---|
committer | Phaedrus Leeds <mwleeds@endlessos.org> | 2020-11-04 12:17:46 -0800 |
commit | 18a5d984a1a4b1b64bfa1f59c7e6da520d8e0b16 (patch) | |
tree | a090f69b416237c3c45d6f37f2e25d8f2b5cde6e | |
parent | 97740ab3f6d8133653330752c5fe7cde38aaf6db (diff) | |
download | flatpak-eolr-docs-tweak.tar.gz |
transaction: Tweak docs around eol-rebaseeolr-docs-tweak
-rw-r--r-- | common/flatpak-transaction.c | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/common/flatpak-transaction.c b/common/flatpak-transaction.c index 8fc5dda9..96e6a8b6 100644 --- a/common/flatpak-transaction.c +++ b/common/flatpak-transaction.c @@ -1207,8 +1207,14 @@ flatpak_transaction_class_init (FlatpakTransactionClass *klass) * transaction to be modified in order to e.g. install the rebased * ref. * + * If the caller wants to install the rebased ref, they should call + * flatpak_transaction_add_uninstall() on @ref, + * flatpak_transaction_add_rebase() on @rebased_to_ref, and return %TRUE. + * Otherwise %FALSE may be returned. + * * Returns: %TRUE if the operation on this end-of-lifed ref should - * be skipped, %FALSE if it should remain. + * be skipped (e.g. because the rebased ref has been added to the + * transaction), %FALSE if it should remain. */ signals[END_OF_LIFED_WITH_REBASE] = g_signal_new ("end-of-lifed-with-rebase", @@ -2545,9 +2551,9 @@ flatpak_transaction_add_install (FlatpakTransaction *self, * @error: return location for a #GError * * Adds updating the @previous_ids of the given ref to this transaction, via either - * installing the @ref if it was not already present. The will treat @ref as the - * result of following an eol-rebase, and data migration from the refs in - * @previous_ids will be set up. + * installing the @ref if it was not already present or updating it. This will + * treat @ref as the result of following an eol-rebase, and data migration from + * the refs in @previous_ids will be set up. * * See flatpak_transaction_add_install() for a description of @remote. * |