ariadne
/
pkgconf
3
6
Fork 4
Code Issues 6 Pull Requests 2 Projects Releases 2 Wiki Activity

libpkgconf: document audit module

pull/100/head
William Pitcock 2016-12-10 19:28:34 -06:00
parent 828c290207
commit 74fbf4e5dc
3 changed files with 84 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
doc/libpkgconf-audit.rst Normal file
View File

@ -0,0 +1,35 @@
libpkgconf `audit` module
=========================
The libpkgconf `audit` module contains the functions related to attaching an audit log file
to a ``pkgconf_client_t`` object.
The audit log format is the same as the output generated by the ``PKG_CONFIG_LOG`` environment
variable.
.. c:function:: void pkgconf_audit_set_log(pkgconf_client_t *client, FILE *auditf)
Sets the audit log file pointer on `client` to `auditf`.
The callee is responsible for closing any previous log files.
:param pkgconf_client_t* client: The client object to modify.
:param FILE* auditf: The file pointer for the already open log file.
:return: nothing
.. c:function:: void pkgconf_audit_log(pkgconf_client_t *client, const char *format, ...)
Logs a message to the opened audit log (if any).
:param pkgconf_client_t* client: The client object the log message is for.
:param char* format: The format string to use for the log messages.
:return: nothing
.. c:function:: void pkgconf_audit_log_dependency(pkgconf_client_t *client, const pkgconf_pkg_t *dep, const pkgconf_dependency_t *depnode)
Convenience function which logs a dependency node to the opened audit log (if any).
:param pkgconf_client_t* client: The client object the log message is for.
:param pkgconf_pkg_t* dep: The dependency package object being logged.
:param pkgconf_dependency_t* depnode: The dependency object itself being logged.
:return: nothing

1
doc/libpkgconf.rst
View File

@ -5,4 +5,5 @@ libpkgconf - an API for managing `pkg-config` modules
:maxdepth: 2
libpkgconf-argvsplit
libpkgconf-audit
libpkgconf-client

48
libpkgconf/audit.c
View File

@ -15,12 +15,48 @@
#include <libpkgconf/libpkgconf.h>
/*
* !doc
*
* libpkgconf `audit` module
* =========================
*
* The libpkgconf `audit` module contains the functions related to attaching an audit log file
* to a ``pkgconf_client_t`` object.
*
* The audit log format is the same as the output generated by the ``PKG_CONFIG_LOG`` environment
* variable.
*/
/*
* !doc
*
* .. c:function:: void pkgconf_audit_set_log(pkgconf_client_t *client, FILE *auditf)
*
* Sets the audit log file pointer on `client` to `auditf`.
* The callee is responsible for closing any previous log files.
*
* :param pkgconf_client_t* client: The client object to modify.
* :param FILE* auditf: The file pointer for the already open log file.
* :return: nothing
*/
void
pkgconf_audit_set_log(pkgconf_client_t *client, FILE *auditf)
{
client->auditf = auditf;
}
/*
* !doc
*
* .. c:function:: void pkgconf_audit_log(pkgconf_client_t *client, const char *format, ...)
*
* Logs a message to the opened audit log (if any).
*
* :param pkgconf_client_t* client: The client object the log message is for.
* :param char* format: The format string to use for the log messages.
* :return: nothing
*/
void
pkgconf_audit_log(pkgconf_client_t *client, const char *format, ...)
{
@ -34,6 +70,18 @@ pkgconf_audit_log(pkgconf_client_t *client, const char *format, ...)
va_end(va);
}
/*
* !doc
*
* .. c:function:: void pkgconf_audit_log_dependency(pkgconf_client_t *client, const pkgconf_pkg_t *dep, const pkgconf_dependency_t *depnode)
*
* Convenience function which logs a dependency node to the opened audit log (if any).
*
* :param pkgconf_client_t* client: The client object the log message is for.
* :param pkgconf_pkg_t* dep: The dependency package object being logged.
* :param pkgconf_dependency_t* depnode: The dependency object itself being logged.
* :return: nothing
*/
void
pkgconf_audit_log_dependency(pkgconf_client_t *client, const pkgconf_pkg_t *dep, const pkgconf_dependency_t *depnode)
{