xref: /freebsd/contrib/pkgconf/doc/libpkgconf-audit.rst (revision a3cefe7f2b4df0f70ff92d4570ce18e517af43ec)
1*a3cefe7fSPierre Pronchery
2*a3cefe7fSPierre Proncherylibpkgconf `audit` module
3*a3cefe7fSPierre Pronchery=========================
4*a3cefe7fSPierre Pronchery
5*a3cefe7fSPierre ProncheryThe libpkgconf `audit` module contains the functions related to attaching an audit log file
6*a3cefe7fSPierre Proncheryto a ``pkgconf_client_t`` object.
7*a3cefe7fSPierre Pronchery
8*a3cefe7fSPierre ProncheryThe audit log format is the same as the output generated by the ``PKG_CONFIG_LOG`` environment
9*a3cefe7fSPierre Proncheryvariable.
10*a3cefe7fSPierre Pronchery
11*a3cefe7fSPierre Pronchery.. c:function:: void pkgconf_audit_set_log(pkgconf_client_t *client, FILE *auditf)
12*a3cefe7fSPierre Pronchery
13*a3cefe7fSPierre Pronchery   Sets the audit log file pointer on `client` to `auditf`.
14*a3cefe7fSPierre Pronchery   The callee is responsible for closing any previous log files.
15*a3cefe7fSPierre Pronchery
16*a3cefe7fSPierre Pronchery   :param pkgconf_client_t* client: The client object to modify.
17*a3cefe7fSPierre Pronchery   :param FILE* auditf: The file pointer for the already open log file.
18*a3cefe7fSPierre Pronchery   :return: nothing
19*a3cefe7fSPierre Pronchery
20*a3cefe7fSPierre Pronchery.. c:function:: void pkgconf_audit_log(pkgconf_client_t *client, const char *format, ...)
21*a3cefe7fSPierre Pronchery
22*a3cefe7fSPierre Pronchery   Logs a message to the opened audit log (if any).
23*a3cefe7fSPierre Pronchery
24*a3cefe7fSPierre Pronchery   :param pkgconf_client_t* client: The client object the log message is for.
25*a3cefe7fSPierre Pronchery   :param char* format: The format string to use for the log messages.
26*a3cefe7fSPierre Pronchery   :return: nothing
27*a3cefe7fSPierre Pronchery
28*a3cefe7fSPierre Pronchery.. c:function:: void pkgconf_audit_log_dependency(pkgconf_client_t *client, const pkgconf_pkg_t *dep, const pkgconf_dependency_t *depnode)
29*a3cefe7fSPierre Pronchery
30*a3cefe7fSPierre Pronchery   Convenience function which logs a dependency node to the opened audit log (if any).
31*a3cefe7fSPierre Pronchery
32*a3cefe7fSPierre Pronchery   :param pkgconf_client_t* client: The client object the log message is for.
33*a3cefe7fSPierre Pronchery   :param pkgconf_pkg_t* dep: The dependency package object being logged.
34*a3cefe7fSPierre Pronchery   :param pkgconf_dependency_t* depnode: The dependency object itself being logged.
35*a3cefe7fSPierre Pronchery   :return: nothing
36