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

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

• Show log

  Commit

• Hash : 9efa991d
  Author :
  Date : 2016-12-10T19:40:51
  

  libpkgconf: update cache docs to new format
  

Download

• doc/libpkgconf-cache.rst

• 
  libpkgconf `cache` module
  =========================
  
  The libpkgconf `cache` module manages a package/module object cache, allowing it to
  avoid loading duplicate copies of a package/module.
  
  A cache is tied to a specific pkgconf client object, so package objects should not
  be shared across threads.
  
  .. c:function:: pkgconf_pkg_t *pkgconf_cache_lookup(const pkgconf_client_t *client, const char *id)
  
     Looks up a package in the cache given an `id` atom,
     such as ``gtk+-3.0`` and returns the already loaded version
     if present.
  
     :param pkgconf_client_t* client: The client object to access.
     :param char* id: The package atom to look up in the client object's cache.
     :return: A package object if present, else ``NULL``.
     :rtype: pkgconf_pkg_t *
  
  .. c:function:: void pkgconf_cache_add(pkgconf_client_t *client, pkgconf_pkg_t *pkg)
  
     Adds an entry for the package to the package cache.
     The cache entry must be removed if the package is freed.
  
     :param pkgconf_client_t* client: The client object to modify.
     :param pkgconf_pkg_t* pkg: The package object to add to the client object's cache.
     :return: nothing
  
  .. c:function:: void pkgconf_cache_remove(pkgconf_client_t *client, pkgconf_pkg_t *pkg)
  
     Deletes a package from the client object's package cache.
  
     :param pkgconf_client_t* client: The client object to modify.
     :param pkgconf_pkg_t* pkg: The package object to remove from the client object's cache.
     :return: nothing
  
  .. c:function:: void pkgconf_cache_free(pkgconf_client_t *client)
  
     Releases all resources related to a client object's package cache.
     This function should only be called to clear a client object's package cache,
     as it may release any package in the cache.
  
     :param pkgconf_client_t* client: The client object to modify.
  

Download