bryson/pacman
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: document transactions

Browse source 
Signed-off-by: Allan McRae <allan@archlinux.org>
This commit is contained in:
morganamilo 2020-12-07 22:19:45 +00:00 • committed by Allan McRae
parent 3d60a829e1
commit a321e1f8a5
1 changed files with 23 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
lib/libalpm/alpm.h
View file

@ -2067,18 +2067,26 @@ int alpm_pkg_mtree_close(const alpm_pkg_t *pkg, struct archive *archive);
/* End of alpm_packages */ /* End of alpm_packages */
/** @} */ /** @} */
/*
* Sync
*/
/** Check for new version of pkg in sync repos /** Check for new version of pkg in sync repos
* (only the first occurrence is considered in sync) * (only the first occurrence is considered in sync)
*/ */
alpm_pkg_t *alpm_sync_get_new_version(alpm_pkg_t *pkg, alpm_list_t *dbs_sync); alpm_pkg_t *alpm_sync_get_new_version(alpm_pkg_t *pkg, alpm_list_t *dbs_sync);
/** @addtogroup alpm_api_trans Transaction Functions /** @addtogroup alpm_trans Transaction
* Functions to manipulate libalpm transactions * @brief Functions to manipulate libalpm transactions
*
* Transactions are the way to add/remove packages to/from the system.
* Only one transaction can exist at a time.
*
* The basic workflow of a transaction is to:
*
* - Initialize with \link alpm_trans_init \endlink
* - Choose which packages to add with \link alpm_add_pkg \endlink and \link alpm_remove_pkg \endlink
* - Prepare the transaction with \link alpm_trans_prepare \endlink
* - Commit the transaction with \link alpm_trans_commit \endlink
* - Release the transaction with \link alpm_trans_release \endlink
*
* A transaction can be released at any time. A transaction does not have to be committed.
* @{ * @{
*/ */
@ -2171,10 +2179,11 @@ int alpm_trans_interrupt(alpm_handle_t *handle);
* @return 0 on success, -1 on error (pm_errno is set accordingly) * @return 0 on success, -1 on error (pm_errno is set accordingly)
*/ */
int alpm_trans_release(alpm_handle_t *handle); int alpm_trans_release(alpm_handle_t *handle);
/** @} */
/** @name Common Transactions */ /** @name Add/Remove packages
/** @{ */ * These functions remove/add packages to the transactions
* @{
* */
/** Search for packages to upgrade and add them to the transaction. /** Search for packages to upgrade and add them to the transaction.
* @param handle the context handle * @param handle the context handle
@ -2185,22 +2194,24 @@ int alpm_sync_sysupgrade(alpm_handle_t *handle, int enable_downgrade);
/** Add a package to the transaction. /** Add a package to the transaction.
* If the package was loaded by alpm_pkg_load(), it will be freed upon * If the package was loaded by alpm_pkg_load(), it will be freed upon
* alpm_trans_release() invocation. * \link alpm_trans_release \endlink invocation.
* @param handle the context handle * @param handle the context handle
* @param pkg the package to add * @param pkg the package to add
* @return 0 on success, -1 on error (pm_errno is set accordingly) * @return 0 on success, -1 on error (pm_errno is set accordingly)
*/ */
int alpm_add_pkg(alpm_handle_t *handle, alpm_pkg_t *pkg); int alpm_add_pkg(alpm_handle_t *handle, alpm_pkg_t *pkg);
/** Add a package removal action to the transaction. /** Add a package removal to the transaction.
* @param handle the context handle * @param handle the context handle
* @param pkg the package to uninstall * @param pkg the package to uninstall
* @return 0 on success, -1 on error (pm_errno is set accordingly) * @return 0 on success, -1 on error (pm_errno is set accordingly)
*/ */
int alpm_remove_pkg(alpm_handle_t *handle, alpm_pkg_t *pkg); int alpm_remove_pkg(alpm_handle_t *handle, alpm_pkg_t *pkg);
/* End of add/remove packages */
/** @} */ /** @} */
/* End of alpm_trans */
/** @} */ /** @} */
/* /*