Improve API documentation round 1.
This commit is contained in:
@ -35,38 +35,6 @@
|
||||
|
||||
#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
|
||||
set_extract_flags(void)
|
||||
{
|
||||
|
Reference in New Issue
Block a user