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

doc: document logging

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

17
lib/libalpm/alpm.h
View file

@ -1411,13 +1411,27 @@ typedef enum _alpm_pkgvalidation_t {
/** Logging Levels */ /** Logging Levels */
typedef enum _alpm_loglevel_t { typedef enum _alpm_loglevel_t {
/** Error */
ALPM_LOG_ERROR = 1, ALPM_LOG_ERROR = 1,
/** Warning */
ALPM_LOG_WARNING = (1 << 1), ALPM_LOG_WARNING = (1 << 1),
/** Debug */
ALPM_LOG_DEBUG = (1 << 2), ALPM_LOG_DEBUG = (1 << 2),
/** Function */
ALPM_LOG_FUNCTION = (1 << 3) ALPM_LOG_FUNCTION = (1 << 3)
} alpm_loglevel_t; } alpm_loglevel_t;
typedef void (*alpm_cb_log)(alpm_loglevel_t, const char *, va_list);
/** The callback type for logging.
*
* libalpm will call this function whenever something is to be logged.
* many libalpm will produce log output. Additionally any calls to \link alpm_logaction
* \endlink will also call this callback.
* @param level the currently set loglevel
* @param fmt the printf like format string
* @param args printf like arguments
*/
typedef void (*alpm_cb_log)(alpm_loglevel_t level, const char *fmt, va_list args);
/** A printf-like function for logging. /** A printf-like function for logging.
* @param handle the context handle * @param handle the context handle
@ -1428,6 +1442,7 @@ typedef void (*alpm_cb_log)(alpm_loglevel_t, const char *, va_list);
int alpm_logaction(alpm_handle_t *handle, const char *prefix, int alpm_logaction(alpm_handle_t *handle, const char *prefix,
const char *fmt, ...) __attribute__((format(printf, 3, 4))); const char *fmt, ...) __attribute__((format(printf, 3, 4)));
/* End of alpm_log */
/** @} */ /** @} */
/** Fetch a list of remote packages. /** Fetch a list of remote packages.