kc3-lang/pkgconf/doc/libpkgconf-client.rst

Branch : - branch - master - tag - pkgconf-0.1 pkgconf-0.1.1 pkgconf-0.2 pkgconf-0.3 pkgconf-0.4 pkgconf-0.5 pkgconf-0.5.1 pkgconf-0.5.2 pkgconf-0.5.3 pkgconf-0.6 pkgconf-0.7 pkgconf-0.8 pkgconf-0.8.1 pkgconf-0.8.10 pkgconf-0.8.11 pkgconf-0.8.12 pkgconf-0.8.2 pkgconf-0.8.3 pkgconf-0.8.4 pkgconf-0.8.7 pkgconf-0.8.8 pkgconf-0.8.9 pkgconf-0.9.0 pkgconf-0.9.1 pkgconf-0.9.10 pkgconf-0.9.11 pkgconf-0.9.12 pkgconf-0.9.2 pkgconf-0.9.3 pkgconf-0.9.4 pkgconf-0.9.5 pkgconf-0.9.6 pkgconf-0.9.7 pkgconf-0.9.8 pkgconf-0.9.9 pkgconf-1 pkgconf-1.0.1 pkgconf-1.1.0 pkgconf-1.2.0 pkgconf-1.3.0 pkgconf-1.3.1 pkgconf-1.3.2 pkgconf-1.3.3 pkgconf-1.3.4 pkgconf-1.3.5 pkgconf-1.3.6 pkgconf-1.3.7 pkgconf-1.3.90 pkgconf-1.4.0 pkgconf-1.4.1 pkgconf-1.4.2 pkgconf-1.5.1 pkgconf-1.5.2 pkgconf-1.5.3 pkgconf-1.5.4 pkgconf-1.6.0 pkgconf-1.6.1 pkgconf-1.6.2 pkgconf-1.6.3 pkgconf-1.7.0 pkgconf-1.7.1 pkgconf-1.7.2 pkgconf-1.7.3 pkgconf-1.7.4 pkgconf-1.8.0 pkgconf-1.9.0 pkgconf-1.9.1 pkgconf-1.9.2 pkgconf-1.9.3 pkgconf-1.9.4 pkgconf-1.9.5 pkgconf-2.0.0 pkgconf-2.0.1 pkgconf-2.0.2 pkgconf-2.0.3 pkgconf-2.1.0 pkgconf-2.1.1 pkgconf-2.2.0 pkgconf-2.3.0 pkgconf-2.4.0 pkgconf-2.4.1 pkgconf-2.4.2 pkgconf-2.4.3 pkgconf-2.5.0 pkgconf-2.5.1

• Show log

  Commit

• Author : William Pitcock
  Date : 2016-12-13 12:06:49
  Hash : 3c6fe6b1
  Message : doc: rebuild client docs

• doc/libpkgconf-client.rst

• libpkgconf `client` module
  ==========================
  
  The libpkgconf `client` module implements the `pkgconf_client_t` "client" object.
  Client objects store all necessary state for libpkgconf allowing for multiple instances to run
  in parallel.
  
  Client objects are not thread safe, in other words, a client object should not be shared across
  thread boundaries.
  
  .. c:function:: void pkgconf_client_init(pkgconf_client_t *client, pkgconf_error_handler_func_t error_handler)
  
     Initialise a pkgconf client object.
  
     :param pkgconf_client_t* client: The client to initialise.
     :param pkgconf_error_handler_func_t error_handler: An optional error handler to use for logging errors.
     :param void* error_handler_data: user data passed to optional error handler
     :return: nothing
  
  .. c:function:: pkgconf_client_t* pkgconf_client_new(pkgconf_error_handler_func_t error_handler)
  
     Allocate and initialise a pkgconf client object.
  
     :param pkgconf_error_handler_func_t error_handler: An optional error handler to use for logging errors.
     :param void* error_handler_data: user data passed to optional error handler
     :return: A pkgconf client object.
     :rtype: pkgconf_client_t*
  
  .. c:function:: void pkgconf_client_deinit(pkgconf_client_t *client)
  
     Release resources belonging to a pkgconf client object.
  
     :param pkgconf_client_t* client: The client to deinitialise.
     :return: nothing
  
  .. c:function:: void pkgconf_client_free(pkgconf_client_t *client)
  
     Release resources belonging to a pkgconf client object and then free the client object itself.
  
     :param pkgconf_client_t* client: The client to deinitialise and free.
     :return: nothing
  
  .. c:function:: const char *pkgconf_client_get_sysroot_dir(const pkgconf_client_t *client)
  
     Retrieves the client's sysroot directory (if any).
  
     :param pkgconf_client_t* client: The client object being accessed.
     :return: A string containing the sysroot directory or NULL.
     :rtype: const char *
  
  .. c:function:: void pkgconf_client_set_sysroot_dir(pkgconf_client_t *client, const char *sysroot_dir)
  
     Sets or clears the sysroot directory on a client object.  Any previous sysroot directory setting is
     automatically released if one was previously set.
  
     Additionally, the global tuple ``$(pc_sysrootdir)`` is set as appropriate based on the new setting.
  
     :param pkgconf_client_t* client: The client object being modified.
     :param char* sysroot_dir: The sysroot directory to set or NULL to unset.
     :return: nothing
  
  .. c:function:: const char *pkgconf_client_get_buildroot_dir(const pkgconf_client_t *client)
  
     Retrieves the client's buildroot directory (if any).
  
     :param pkgconf_client_t* client: The client object being accessed.
     :return: A string containing the buildroot directory or NULL.
     :rtype: const char *
  
  .. c:function:: void pkgconf_client_set_buildroot_dir(pkgconf_client_t *client, const char *buildroot_dir)
  
     Sets or clears the buildroot directory on a client object.  Any previous buildroot directory setting is
     automatically released if one was previously set.
  
     Additionally, the global tuple ``$(pc_top_builddir)`` is set as appropriate based on the new setting.
  
     :param pkgconf_client_t* client: The client object being modified.
     :param char* buildroot_dir: The buildroot directory to set or NULL to unset.
     :return: nothing