Add infrastructure changes to build the API documentation.

doxygen and graphviz are required. It's disabled by default, use
the BUILD_API_DOCS make(1) argument to enable it.

--HG--
extra : convert_revision : xtraeme%40gmail.com-20100123013719-pkk3a3823cx09v8l
This commit is contained in:
Juan RP
2010-01-23 02:37:19 +01:00
parent dac80a3fa2
commit 31f821669f
17 changed files with 536 additions and 105 deletions

View File

@@ -39,22 +39,22 @@
*
* These functions will remove a package or only a subset of its
* files. Package removal steps:
* - Its <b>pre-remove</b> target specified in the REMOVE script
* will be executed.
* - Its files, dirs and links will be removed. Modified files (not
* matching its sha256 hash) will always be preserved.
* - Its <b>post-remove</b> target specified in the REMOVE script
* will be executed.
* - Its requiredby objects will be removed from the installed packages
* database.
* - Its state will be changed to <b>config-files</b>.
* -# Its <b>pre-remove</b> target specified in the REMOVE script
* will be executed.
* -# Its files, dirs and links will be removed. Modified files (not
* matching its sha256 hash) will always be preserved.
* -# Its <b>post-remove</b> target specified in the REMOVE script
* will be executed.
* -# Its requiredby objects will be removed from the installed packages
* database.
* -# Its state will be changed to XBPS_PKG_STATE_CONFIG_FILES.
*
* @note
* - If a package is going to be updated and it's an essential package,
* only steps <b>1</b> and <b>4</b> will be executed.
* - If a package is going to be updated and it's <b>NOT</b> an essential
* package, only steps <b>1</b>, <b>2</b> and <b>4</b> will be executed.
* - If a package is going to be removed, all steps will be executed.
* -# If a package is going to be updated and it's an essential package,
* only steps <b>1</b> and <b>4</b> will be executed.
* -# If a package is going to be updated and it's <b>NOT</b> an essential
* package, only steps <b>1</b>, <b>2</b> and <b>4</b> will be executed.
* -# If a package is going to be removed, all steps will be executed.
*
* The following image shows the structure of an internalized package's
* files.plist dictionary: