emo/xbps
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve API documentation round 1.

Browse Source
This commit is contained in:
Juan RP 2012-01-20 12:17:27 +01:00
parent 6057bd83b3
commit d075411049
7 changed files with 216 additions and 216 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/xbps_api_doxyfile.in
View File

@ -338,12 +338,12 @@ SYMBOL_CACHE_SIZE = 0
# Private class members and static file members will be hidden unless # Private class members and static file members will be hidden unless
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
EXTRACT_ALL = YES EXTRACT_ALL = NO
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation. # will be included in the documentation.
EXTRACT_PRIVATE = YES EXTRACT_PRIVATE = NO
# If the EXTRACT_STATIC tag is set to YES all static members of a file # If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation. # will be included in the documentation.
@ -530,7 +530,7 @@ MAX_INITIALIZER_LINES = 30
# at the bottom of the documentation of classes and structs. If set to YES the # at the bottom of the documentation of classes and structs. If set to YES the
# list will mention the files that were used to generate the documentation. # list will mention the files that were used to generate the documentation.
SHOW_USED_FILES = YES SHOW_USED_FILES = NO
# If the sources in your project are distributed over multiple directories # If the sources in your project are distributed over multiple directories
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
@ -542,7 +542,7 @@ SHOW_DIRECTORIES = NO
# This will remove the Files entry from the Quick Index and from the # This will remove the Files entry from the Quick Index and from the
# Folder Tree View (if specified). The default is YES. # Folder Tree View (if specified). The default is YES.
SHOW_FILES = YES SHOW_FILES = NO
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
# Namespaces page. # Namespaces page.
@ -773,7 +773,7 @@ FILTER_SOURCE_PATTERNS =
# Note: To get rid of all source code in the generated output, make sure also # Note: To get rid of all source code in the generated output, make sure also
# VERBATIM_HEADERS is set to NO. # VERBATIM_HEADERS is set to NO.
SOURCE_BROWSER = NO SOURCE_BROWSER = YES
# Setting the INLINE_SOURCES tag to YES will include the body # Setting the INLINE_SOURCES tag to YES will include the body
# of functions and classes directly in the documentation. # of functions and classes directly in the documentation.

340
include/xbps_api.h
View File

@ -119,7 +119,7 @@
#endif #endif
/** /**
* @def XBPS_CONF_PLIST * @def XBPS_CONF_DEF
* Filename for the XBPS plist configuration file. * Filename for the XBPS plist configuration file.
*/ */
#define XBPS_CONF_DEF XBPS_SYSCONF_PATH "/xbps.conf" #define XBPS_CONF_DEF XBPS_SYSCONF_PATH "/xbps.conf"
@ -187,47 +187,47 @@ void xbps_warn_printf(const char *, ...);
* *
* Integer representing the xbps callback returned state. Possible values: * Integer representing the xbps callback returned state. Possible values:
* *
* XBPS_STATE_UKKNOWN: state hasn't been prepared or unknown error. * - XBPS_STATE_UKKNOWN: state hasn't been prepared or unknown error.
* XBPS_STATE_TRANS_DOWNLOAD: transaction is downloading binary packages. * - XBPS_STATE_TRANS_DOWNLOAD: transaction is downloading binary packages.
* XBPS_STATE_TRANS_VERIFY: transaction is verifying binary package integrity. * - XBPS_STATE_TRANS_VERIFY: transaction is verifying binary package integrity.
* XBPS_STATE_TRANS_RUN: transaction is performing operations: * - XBPS_STATE_TRANS_RUN: transaction is performing operations:
* install, update, remove and replace. * install, update, remove and replace.
* XBPS_STATE_TRANS_CONFIGURE: transaction is configuring all * - XBPS_STATE_TRANS_CONFIGURE: transaction is configuring all
* unpacked packages. * unpacked packages.
* XBPS_STATE_DOWNLOAD: a binary package is being downloaded. * - XBPS_STATE_DOWNLOAD: a binary package is being downloaded.
* XBPS_STATE_VERIFY: a binary package is being verified. * - XBPS_STATE_VERIFY: a binary package is being verified.
* XBPS_STATE_REMOVE: a package is being removed. * - XBPS_STATE_REMOVE: a package is being removed.
* XBPS_STATE_REMOVE_DONE: a package has been removed successfully. * - XBPS_STATE_REMOVE_DONE: a package has been removed successfully.
* XBPS_STATE_REMOVE_FILE: a package file is being removed. * - XBPS_STATE_REMOVE_FILE: a package file is being removed.
* XBPS_STATE_REMOVE_OBSOLETE: an obsolete package file is being removed. * - XBPS_STATE_REMOVE_OBSOLETE: an obsolete package file is being removed.
* XBPS_STATE_REPLACE: a package is being replaced. * - XBPS_STATE_REPLACE: a package is being replaced.
* XBPS_STATE_INSTALL: a package is being installed. * - XBPS_STATE_INSTALL: a package is being installed.
* XBPS_STATE_INSTALL_DONE: a package has been installed successfully. * - XBPS_STATE_INSTALL_DONE: a package has been installed successfully.
* XBPS_STATE_UPDATE: a package is being updated. * - XBPS_STATE_UPDATE: a package is being updated.
* XBPS_STATE_UPDATE_DONE: a package has been updated successfully. * - XBPS_STATE_UPDATE_DONE: a package has been updated successfully.
* XBPS_STATE_UNPACK: a package is being unpacked. * - XBPS_STATE_UNPACK: a package is being unpacked.
* XBPS_STATE_CONFIGURE: a package is being configured. * - XBPS_STATE_CONFIGURE: a package is being configured.
* XBPS_STATE_CONFIG_FILE: a package configuration file is being processed. * - XBPS_STATE_CONFIG_FILE: a package configuration file is being processed.
* XBPS_STATE_REGISTER: a package is being registered. * - XBPS_STATE_REGISTER: a package is being registered.
* XBPS_STATE_UNREGISTER: a package is being unregistered. * - XBPS_STATE_UNREGISTER: a package is being unregistered.
* XBPS_STATE_REPOSYNC: a remote repository's package index is being * - XBPS_STATE_REPOSYNC: a remote repository's package index is being
* synchronized. * synchronized.
* XBPS_STATE_VERIFY_FAIL: binary package integrity has failed. * - XBPS_STATE_VERIFY_FAIL: binary package integrity has failed.
* XBPS_STATE_DOWNLOAD_FAIL: binary package download has failed. * - XBPS_STATE_DOWNLOAD_FAIL: binary package download has failed.
* XBPS_STATE_REMOVE_FAIL: a package removal has failed. * - XBPS_STATE_REMOVE_FAIL: a package removal has failed.
* XBPS_STATE_REMOVE_FILE_FAIL: a package file removal has failed. * - XBPS_STATE_REMOVE_FILE_FAIL: a package file removal has failed.
* XBPS_STATE_REMOVE_FILE_HASH_FAIL: a package file removal due to * - XBPS_STATE_REMOVE_FILE_HASH_FAIL: a package file removal due to
* its hash has failed. * its hash has failed.
* XBPS_STATE_REMOVE_FILE_OBSOLETE_FAIL: an obsolete package file * - XBPS_STATE_REMOVE_FILE_OBSOLETE_FAIL: an obsolete package file
* removal has failed. * removal has failed.
* XBPS_STATE_CONFIGURE_FAIL: package configure has failed. * - XBPS_STATE_CONFIGURE_FAIL: package configure has failed.
* XBPS_STATE_CONFIG_FILE_FAIL: package configuration file operation * - XBPS_STATE_CONFIG_FILE_FAIL: package configuration file operation
* has failed. * has failed.
* XBPS_STATE_UPDATE_FAIL: package update has failed. * - XBPS_STATE_UPDATE_FAIL: package update has failed.
* XBPS_STATE_UNPACK_FAIL: package unpack has failed. * - XBPS_STATE_UNPACK_FAIL: package unpack has failed.
* XBPS_STATE_REGISTER_FAIL: package register has failed. * - XBPS_STATE_REGISTER_FAIL: package register has failed.
* XBPS_STATE_UNREGISTER_FAIL: package unregister has failed. * - XBPS_STATE_UNREGISTER_FAIL: package unregister has failed.
* XBPS_STATE_REPOSYNC_FAIL: syncing remote repositories has failed. * - XBPS_STATE_REPOSYNC_FAIL: syncing remote repositories has failed.
*/ */
typedef enum xbps_state { typedef enum xbps_state {
XBPS_STATE_UNKNOWN = 0, XBPS_STATE_UNKNOWN = 0,
@ -271,9 +271,8 @@ typedef enum xbps_state {
} xbps_state_t; } xbps_state_t;
/** /**
* @struct xbps_cb_data xbps_api.h "xbps_api.h" * @struct xbps_state_cb_data xbps_api.h "xbps_api.h"
* @brief Structure to be passed as argument to the state * @brief Structure to be passed as argument to the state function callback.
* function callbacks.
*/ */
struct xbps_state_cb_data { struct xbps_state_cb_data {
/** /**
@ -442,36 +441,26 @@ struct xbps_handle {
*/ */
prop_array_t pkgdb; prop_array_t pkgdb;
/** /**
* @var xbps_state_cb
*
* Pointer to the supplifed function callback to be used * Pointer to the supplifed function callback to be used
* in the XBPS possible states. * in the XBPS possible states.
*/ */
void (*state_cb)(const struct xbps_state_cb_data *, void *); void (*state_cb)(const struct xbps_state_cb_data *, void *);
/** /**
* @var state_cb_data
*
* Pointer to user supplied data to be passed as argument to * Pointer to user supplied data to be passed as argument to
* the \a xbps_state_cb function callback. * the \a xbps_state_cb function callback.
*/ */
void *state_cb_data; void *state_cb_data;
/** /**
* @var xbps_unpack_cb
*
* Pointer to the supplied function callback to be used in * Pointer to the supplied function callback to be used in
* xbps_unpack_binary_pkg(). * xbps_unpack_binary_pkg().
*/ */
void (*unpack_cb)(const struct xbps_unpack_cb_data *, void *); void (*unpack_cb)(const struct xbps_unpack_cb_data *, void *);
/** /**
* @var unpack_cb_data
*
* Pointer to user supplied data to be passed as argument to * Pointer to user supplied data to be passed as argument to
* the \a xbps_unpack_cb function callback. * the \a xbps_unpack_cb function callback.
*/ */
void *unpack_cb_data; void *unpack_cb_data;
/** /**
* @var xbps_fetch_cb
*
* Pointer to the supplied function callback to be used in * Pointer to the supplied function callback to be used in
* xbps_fetch_file(). * xbps_fetch_file().
*/ */
@ -502,9 +491,9 @@ struct xbps_handle {
*/ */
char *cachedir_priv; char *cachedir_priv;
/** /**
* @var confdir * @var conffile
* *
* Full path to the XBPS_SYSCONF_PATH directory. * Full path to the xbps configuration file.
*/ */
const char *conffile; const char *conffile;
/** /**
@ -585,6 +574,8 @@ void xbps_end(void);
/** /**
* Returns a pointer to the xbps_handle structure passed to xbps_init(). * Returns a pointer to the xbps_handle structure passed to xbps_init().
*
* @return A pointer the struct xbps_handle passed to xbps_init().
*/ */
struct xbps_handle *xbps_handle_get(void); struct xbps_handle *xbps_handle_get(void);
@ -621,23 +612,6 @@ int xbps_configure_packages(bool flush);
/*@}*/ /*@}*/
/**
* @ingroup vermatch
*
* Compares package version strings.
*
* The package version is defined by:
* ${VERSION}[_${REVISION}].
*
* @param[in] pkg1 a package version string.
* @param[in] pkg2 a package version string.
*
* @return -1, 0 or 1 depending if pkg1 is less than, equal to or
* greater than pkg2.
*/
int xbps_cmpver(const char *pkg1, const char *pkg2);
/** @addtogroup download */ /** @addtogroup download */
/*@{*/ /*@{*/
@ -681,18 +655,96 @@ const char *xbps_fetch_error_string(void);
*/ */
prop_array_t xbps_find_pkg_orphans(prop_array_t orphans); prop_array_t xbps_find_pkg_orphans(prop_array_t orphans);
/** @addtogroup pkgdb */
/*@{*/
/** /**
* @ingroup vermatch * Executes a function callback per a package dictionary registered
* in master package database (pkgdb) plist (downwards).
* *
* Package pattern matching. * @param[in] fn Function callback to run for any pkg dictionary.
* @param[in] arg Argument to be passed to the function callback.
* *
* @param[in] pkgver Package name/version, i.e `foo-1.0'. * @return 0 on success (all objects were processed), otherwise
* @param[in] pattern Package pattern to match against \a pkgver, i.e * the value returned by the function callback.
* `foo>=0' or `foo<1'.
*
* @return 1 if \a pkgver is matched against \a pattern, 0 if no match.
*/ */
int xbps_pkgpattern_match(const char *pkgver, const char *pattern); int xbps_pkgdb_foreach_pkg_cb(int (*fn)(prop_object_t, void *, bool *),
void *arg);
/**
* Executes a function callback per a package dictionary registered
* in master package database (pkgdb) plist, in reverse order (upwards).
*
* @param[in] fn Function callback to run for any pkg dictionary.
* @param[in] arg Argument to be passed to the function callback.
*
* @return 0 on success (all objects were processed), otherwise
* the value returned by the funcion callback.
*/
int xbps_pkgdb_foreach_reverse_pkg_cb(
int (*fn)(prop_object_t, void *, bool *),
void *arg);
/**
* Returns a package dictionary from master package database (pkgdb) plist,
* matching pkgname or pkgver object in \a pkg.
*
* @param[in] pkg Package name or name-version to match.
* @param[in] bypattern If false \a pkg must be a pkgname, otherwise a
* package pattern, i.e `foo>=0' or `foo<1'.
*
* @return The matching proplib package dictionary from kgdb copied
* with \a prop_dictionary_copy() so it must be released when not required
* anymore with prop_object_release(). NULL otherwise.
*/
prop_dictionary_t xbps_pkgdb_get_pkgd(const char *pkg, bool bypattern);
/**
* Removes a package dictionary from master package database (pkgdb) plist,
* matching pkgname or pkgver object in \a pkg.
*
* @param[in] pkg Package name or pattern to match in a package dictionary.
* @param[in] bypattern If false \a pkg must be a pkgname, otherwise a
* package pattern, i.e `foo>=0' or `foo<1'.
* @param[in] flush If true, after successful replace the pkgdb contents
* in memory will be flushed atomically to storage.
*
* @return true on success, false otherwise.
*/
bool xbps_pkgdb_remove_pkgd(const char *pkg, bool bypattern, bool flush);
/**
* Replaces a package dictionary with \a dict in the master package database
* (pkgdb) plist, matching pkgname or pkgver object.
*
* @param[in] pkgd Proplib dictionary to be added into pkgdb.
* @param[in] pkg Package name or pattern to match in a package dictionary.
* @param[in] bypattern If false \a pkg must be a pkgname, otherwise a
* package pattern, i.e `foo>=0' or `foo<1'.
* @param[in] flush If true, after successful replace the pkgdb contents in
* memory will be flushed atomically to storage.
*
* @return true on success, false otherwise.
*/
bool xbps_pkgdb_replace_pkgd(prop_dictionary_t pkgd,
const char *pkg,
bool bypattern,
bool flush);
/**
* Updates the master package database (pkgdb) plist with new contents from
* disk to the cached copy in memory.
*
* @param[in] xhp Pointer to our xbps_handle struct, as returned by
* \a xbps_handle_get().
* @param[in] flush If true the pkgdb plist contents in memory will
* be flushed atomically to storage.
*
* @return 0 on success, otherwise an errno value.
*/
int xbps_pkgdb_update(struct xbps_handle *xhp, bool flush);
/*@}*/
/** @addtogroup plist */ /** @addtogroup plist */
/*@{*/ /*@{*/
@ -795,93 +847,6 @@ int xbps_callback_array_iter_reverse_in_dict(prop_dictionary_t dict,
const char *key, const char *key,
int (*fn)(prop_object_t, void *, bool *), int (*fn)(prop_object_t, void *, bool *),
void *arg); void *arg);
/**
* Executes a function callback per a package dictionary registered
* in master package database (pkgdb) plist (downwards).
*
* @param[in] fn Function callback to run for any pkg dictionary.
* @param[in] arg Argument to be passed to the function callback.
*
* @return 0 on success (all objects were processed), otherwise
* the value returned by the function callback.
*/
int xbps_pkgdb_foreach_pkg_cb(int (*fn)(prop_object_t, void *, bool *),
void *arg);
/**
* Executes a function callback per a package dictionary registered
* in master package database (pkgdb) plist, in reverse order (upwards).
*
* @param[in] fn Function callback to run for any pkg dictionary.
* @param[in] arg Argument to be passed to the function callback.
*
* @return 0 on success (all objects were processed), otherwise
* the value returned by the funcion callback.
*/
int xbps_pkgdb_foreach_reverse_pkg_cb(
int (*fn)(prop_object_t, void *, bool *),
void *arg);
/**
* Returns a package dictionary from master package database (pkgdb) plist,
* matching pkgname or pkgver object in \a pkg.
*
* @param[in] pkg Package name or name-version to match.
* @param[in] bypattern If false \a pkg must be a pkgname, otherwise a
* package pattern, i.e `foo>=0' or `foo<1'.
*
* @return The matching proplib package dictionary from kgdb copied
* with \a prop_dictionary_copy() so it must be released when not required
* anymore with prop_object_release(). NULL otherwise.
*/
prop_dictionary_t xbps_pkgdb_get_pkgd(const char *pkg, bool bypattern);
/**
* Removes a package dictionary from master package database (pkgdb) plist,
* matching pkgname or pkgver object in \a pkg.
*
* @param[in] pkg Package name or pattern to match in a package dictionary.
* @param[in] bypattern If false \a pkg must be a pkgname, otherwise a
* package pattern, i.e `foo>=0' or `foo<1'.
* @param[in] flush If true, after successful replace the pkgdb contents
* in memory will be flushed atomically to storage.
*
* @return true on success, false otherwise.
*/
bool xbps_pkgdb_remove_pkgd(const char *pkg, bool bypattern, bool flush);
/**
* Replaces a package dictionary with \a dict in the master package database
* (pkgdb) plist, matching pkgname or pkgver object.
*
* @param[in] dict Proplib dictionary to be added into pkgdb.
* @param[in] pkg Package name or pattern to match in a package dictionary.
* @param[in] bypattern If false \a pkg must be a pkgname, otherwise a
* package pattern, i.e `foo>=0' or `foo<1'.
* @param[in] flush If true, after successful replace the pkgdb contents in
* memory will be flushed atomically to storage.
*
* @return true on success, false otherwise.
*/
bool xbps_pkgdb_replace_pkgd(prop_dictionary_t pkgd,
const char *pkg,
bool bypattern,
bool flush);
/**
* Updates the master package database (pkgdb) plist with new contents from
* disk to the cached copy in memory.
*
* @param[in] xhp Pointer to our xbps_handle struct, as returned by
* \a xbps_handle_get().
* @param[in] flush If true the pkgdb plist contents in memory will
* be flushed atomically to storage.
*
* @return 0 on success, otherwise an errno value.
*/
int xbps_pkgdb_update(struct xbps_handle *xhp, bool flush);
/** /**
* Finds the proplib's dictionary associated with a package, by looking * Finds the proplib's dictionary associated with a package, by looking
* it via its name in a proplib dictionary. * it via its name in a proplib dictionary.
@ -1232,7 +1197,7 @@ bool xbps_remove_pkgname_from_array(prop_array_t array, const char *name);
/** /**
* Replaces a dictionary with another dictionary in \a dict, in the * Replaces a dictionary with another dictionary in \a dict, in the
* array \array by matching its "pkgname" object with \a pkgname. * array \a array by matching its "pkgname" object with \a pkgname.
* *
* @param[in] array Proplib array where to look for. * @param[in] array Proplib array where to look for.
* @param[in] dict Proplib dictionary to be added in \a array. * @param[in] dict Proplib dictionary to be added in \a array.
@ -1328,7 +1293,7 @@ int xbps_remove_pkg_files(prop_dictionary_t dict,
/*@}*/ /*@}*/
/** @addtogroup transdict */ /** @addtogroup transaction */
/*@{*/ /*@{*/
/** /**
@ -1480,6 +1445,9 @@ struct repository_pool_index {
* Synchronizes the package index file for all remote repositories * Synchronizes the package index file for all remote repositories
* as specified in the configuration file, repositories.plist. * as specified in the configuration file, repositories.plist.
* *
* @param[in] xhp Pointer to a struct xbps_handle, as returned by
* xbps_handle_get().
*
* @return 0 on success, ENOTSUP if no repositories were found in * @return 0 on success, ENOTSUP if no repositories were found in
* the configuration file. * the configuration file.
*/ */
@ -1602,21 +1570,16 @@ int xbps_repository_sync_pkg_index(const char *uri, const char *plistf);
* Integer representing a state on which a package may be. Possible * Integer representing a state on which a package may be. Possible
* values for this are: * values for this are:
* *
* <b>XBPS_PKG_STATE_HALF_UNPACKED</b>: Package was being unpacked * - XBPS_PKG_STATE_HALF_UNPACKED: Package was being unpacked
* but didn't finish properly. * but didn't finish properly.
* * - XBPS_PKG_STATE_UNPACKED: Package has been unpacked correctly
* <b>XBPS_PKG_STATE_UNPACKED</b>: Package has been unpacked correctly
* but has not been configured due to unknown reasons. * but has not been configured due to unknown reasons.
* * - XBPS_PKG_STATE_INSTALLED: Package has been installed successfully.
* <b>XBPS_PKG_STATE_INSTALLED</b>: Package has been installed successfully. * - XBPS_PKG_STATE_BROKEN: not yet used.
* * - XBPS_PKG_STATE_HALF_REMOVED: Package has been removed but not
* <b>XBPS_PKG_STATE_BROKEN</b>: not yet used.
*
* <b>XBPS_PKG_STATE_HALF_REMOVED</b>: Package has been removed but not
* completely: the purge action in REMOVE script wasn't executed, pkg * completely: the purge action in REMOVE script wasn't executed, pkg
* metadata directory still exists and is registered in package database. * metadata directory still exists and is registered in package database.
* * - XBPS_PKG_STATE_NOT_INSTALLED: Package going to be installed in
* <b>XBPS_PKG_STATE_NOT_INSTALLED</b>: Package going to be installed in
* a transaction dictionary but that has not been yet unpacked. * a transaction dictionary but that has not been yet unpacked.
*/ */
typedef enum pkg_state { typedef enum pkg_state {
@ -1871,6 +1834,17 @@ const char *xbps_pkg_version(const char *pkg);
*/ */
const char *xbps_pkgpattern_version(const char *pattern); const char *xbps_pkgpattern_version(const char *pattern);
/**
* Package pattern matching.
*
* @param[in] pkgver Package name/version, i.e `foo-1.0'.
* @param[in] pattern Package pattern to match against \a pkgver, i.e
* `foo>=0' or `foo<1'.
*
* @return 1 if \a pkgver is matched against \a pattern, 0 if no match.
*/
int xbps_pkgpattern_match(const char *pkgver, const char *pattern);
/** /**
* Gets the package version revision in a package string. * Gets the package version revision in a package string.
* *
@ -1902,6 +1876,20 @@ bool xbps_pkg_has_rundeps(prop_dictionary_t dict);
*/ */
int xbps_humanize_number(char *buf, int64_t bytes); int xbps_humanize_number(char *buf, int64_t bytes);
/**
* Compares package version strings.
*
* The package version is defined by:
* ${VERSION}[_${REVISION}].
*
* @param[in] pkg1 a package version string.
* @param[in] pkg2 a package version string.
*
* @return -1, 0 or 1 depending if pkg1 is less than, equal to or
* greater than pkg2.
*/
int xbps_cmpver(const char *pkg1, const char *pkg2);
/*@}*/ /*@}*/
__END_DECLS __END_DECLS

32
lib/package_unpack.c
View File

@ -35,38 +35,6 @@
#include "xbps_api_impl.h" #include "xbps_api_impl.h"
/**
* @file lib/package_unpack.c
* @brief Binary package file unpacking routines
* @defgroup unpack Binary package file unpacking functions
*
* Unpacking a binary package involves the following steps:
* - Its <b>pre-install</b> target in the INSTALL script is executed
* (if available).
* - Metadata files are extracted.
* - All other kind of files on archive are extracted.
* - Handles configuration files by taking care of updating them with
* new versions if necessary and to not overwrite modified ones.
* - Files from installed package are compared with new package and
* obsolete files are removed.
* - Finally its state is set to XBPS_PKG_STATE_UNPACKED.
*
* The following image shown below represents a transaction dictionary
* returned by xbps_transaction_prepare():
*
* @image html images/xbps_transaction_dictionary.png
*
* Legend:
* - <b>Salmon filled box</b>: The transaction dictionary.
* - <b>White filled box</b>: mandatory objects.
* - <b>Grey filled box</b>: optional objects.
* - <b>Green filled box</b>: possible value set in the object, only one of
* them is set.
*
* Text inside of white boxes are the key associated with the object, its
* data type is specified on its edge, i.e string, array, integer, dictionary.
*/
static int static int
set_extract_flags(void) set_extract_flags(void)
{ {

23
lib/pkgdb.c
View File

@ -31,6 +31,29 @@
#include "xbps_api_impl.h" #include "xbps_api_impl.h"
/**
* @file lib/pkgdb.c
* @brief Package database handling routines
* @defgroup pkgdb Package database handling functions
*
* Functions to manipulate the main package database plist file (pkgdb).
*
* The following image shown below shows the proplib structure used
* by the main package database plist:
*
* @image html images/xbps_pkgdb_array.png
*
* Legend:
* - <b>Salmon filled box</b>: \a XBPS_PKGDB file internalized.
* - <b>White filled box</b>: mandatory objects.
* - <b>Grey filled box</b>: optional objects.
* - <b>Green filled box</b>: possible value set in the object, only one
* of them is set.
*
* Text inside of white boxes are the key associated with the object, its
* data type is specified on its edge, i.e array, bool, integer, string,
* dictionary.
*/
int HIDDEN int HIDDEN
xbps_pkgdb_init(struct xbps_handle *xhp) xbps_pkgdb_init(struct xbps_handle *xhp)
{ {

21
lib/transaction_commit.c
View File

@ -35,6 +35,27 @@
#include "xbps_api_impl.h" #include "xbps_api_impl.h"
/**
* @file lib/transaction_commit.c
* @brief Transaction handling routines
* @defgroup transaction Transaction handling functions
*
* The following image shows off the full transaction dictionary returned
* by xbps_transaction_prepare().
*
* @image html images/xbps_transaction_dictionary.png
*
* Legend:
* - <b>Salmon bg box</b>: The transaction dictionary.
* - <b>White bg box</b>: mandatory objects.
* - <b>Grey bg box</b>: optional objects.
* - <b>Green bg box</b>: possible value set in the object, only one of them
* will be set.
*
* Text inside of white boxes are the key associated with the object, its
* data type is specified on its edge, i.e string, array, integer, dictionary.
*/
static int static int
check_binpkgs_hash(prop_object_iterator_t iter) check_binpkgs_hash(prop_object_iterator_t iter)
{ {

2
lib/transaction_dictionary.c
View File

@ -34,7 +34,7 @@
/** /**
* @file lib/transaction_dictionary.c * @file lib/transaction_dictionary.c
* @brief Transaction handling routines * @brief Transaction handling routines
* @defgroup transdict Transaction handling functions * @defgroup transaction Transaction handling functions
* *
* The following image shows off the full transaction dictionary returned * The following image shows off the full transaction dictionary returned
* by xbps_transaction_prepare(). * by xbps_transaction_prepare().

4
lib/transaction_ops.c
View File

@ -33,8 +33,8 @@
/** /**
* @file lib/transaction_ops.c * @file lib/transaction_ops.c
* @brief Transaction package handling routines * @brief Transaction handling routines
* @defgroup repo_pkgs Transaction package handling functions * @defgroup transaction Transaction handling functions
* *
* The following image shows off the full transaction dictionary returned * The following image shows off the full transaction dictionary returned
* by xbps_transaction_prepare(). * by xbps_transaction_prepare().