~mmach/netext73/pkgconf

« back to all changes in this revision

Viewing changes to doc/libpkgconf-audit.rst

  • Committer: mmach
  • Date: 2024-02-21 19:22:23 UTC
  • Revision ID: netbit73@gmail.com-20240221192223-5l809fiqh21udwrd
1.8.1

Show diffs side-by-side

added added

removed removed

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