mirror/flatpak
1
0
Fork 0
mirror of https://github.com/flatpak/flatpak.git synced 2026-03-17 06:29:21 -04:00
Code Issues Packages Projects Releases Wiki Activity

transaction: add docs & introspection annotations

Browse Source 
Without explicit annotation, all optional parameters are assumed to be
mandatory, and 'const gchar **locales' is assumed to be a scalar string
input parameter (rather than an array or an in/out) for some reason.

Closes: #1995
Approved by: alexlarsson
This commit is contained in:
Will Thompson
2018-08-21 14:11:27 +01:00
committed by Atomic Bot
parent ae269ba390
commit 6e270190c8
1 changed files with 48 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
common/flatpak-transaction.c
View File

@@ -1390,6 +1390,19 @@ flatpak_transaction_add_ref (FlatpakTransaction *self,
return TRUE;
}
/**
* flatpak_transaction_add_install:
* @self: a #FlatpakTransaction
* @remote: the name of the remote
* @ref: the ref
* @subpaths: (nullable) (array zero-terminated=1): subpaths to install, or the
* empty list or %NULL to pull all subpaths
* @error: return location for a #GError
*
* Adds installing the given ref to this transaction.
*
* Returns: %TRUE on success; %FALSE with @error set on failure.
*/
gboolean
flatpak_transaction_add_install (FlatpakTransaction *self,
const char *remote,
@@ -1409,6 +1422,18 @@ flatpak_transaction_add_install (FlatpakTransaction *self,
return flatpak_transaction_add_ref (self, remote, ref, subpaths, NULL, FLATPAK_TRANSACTION_OPERATION_INSTALL, NULL, NULL, error);
}
/**
* flatpak_transaction_add_install_bundle:
* @self: a #FlatpakTransaction
* @file: a #GFile that is an flatpak bundle
* @gpg_data: (nullable): GPG key with which to check bundle signatures, or
* %NULL to use the key embedded in the bundle (if any)
* @error: return location for a #GError
*
* Adds installing the given bundle to this transaction.
*
* Returns: %TRUE on success; %FALSE with @error set on failure.
*/
gboolean
flatpak_transaction_add_install_bundle (FlatpakTransaction *self,
GFile *file,
@@ -1444,6 +1469,19 @@ flatpak_transaction_add_install_flatpakref (FlatpakTransaction *self,
return TRUE;
}
/**
* flatpak_transaction_add_update:
* @self: a #FlatpakTransaction
* @ref: the ref
* @subpaths: (nullable) (array zero-terminated=1): subpaths to install; %NULL
* to use the current set, or `{ "", NULL }` to pull all subpaths.
* @commit: (nullable): the commit to update to, or %NULL to use the latest
* @error: return location for a #GError
*
* Adds updating the given ref to this transaction.
*
* Returns: %TRUE on success; %FALSE with @error set on failure.
*/
gboolean
flatpak_transaction_add_update (FlatpakTransaction *self,
const char *ref,
@@ -1462,6 +1500,16 @@ flatpak_transaction_add_update (FlatpakTransaction *self,
return flatpak_transaction_add_ref (self, NULL, ref, subpaths, commit, FLATPAK_TRANSACTION_OPERATION_UPDATE, NULL, NULL, error);
}
/**
* flatpak_transaction_add_uninstall:
* @self: a #FlatpakTransaction
* @ref: the ref
* @error: return location for a #GError
*
* Adds uninstalling the given ref to this transaction.
*
* Returns: %TRUE on success; %FALSE with @error set on failure.
*/
gboolean
flatpak_transaction_add_uninstall (FlatpakTransaction *self,
const char *ref,