nixos/nix
1
1
Fork 0
mirror of https://github.com/NixOS/nix.git synced 2025-12-03 07:31:00 +01:00
Code Activity

C API: clarify some documentation

Browse source
This commit is contained in:
Yorick van Pelt 2023-08-28 16:42:59 +02:00 • committed by José Luis Lafuente
parent 5d82d6e733
commit 9d380c0f76
No known key found for this signature in database
GPG key ID: 8A3455EBE455489A
5 changed files with 22 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/libstore/c/nix_api_store.h
View file

@ -36,7 +36,7 @@ typedef struct StorePath StorePath;
nix_err nix_libstore_init(nix_c_context *context);
/**
* @brief Loads plugins specified in the settings
* @brief Loads the plugins specified in Nix's plugin-files setting.
*
* Call this once, after calling your desired init functions and setting
* relevant settings.
@ -111,17 +111,17 @@ bool nix_store_is_valid_path(nix_c_context *context, Store *store,
/**
* @brief Realise a Nix store path
*
* Blocking, calls cb once for each built output
* Blocking, calls callback once for each realisedoutput
*
* @param[out] context Optional, stores error information
* @param[in] store Nix Store reference
* @param[in] path Path to build
* @param[in] userdata data to pass to every callback invocation
* @param[in] cb called for every built output
* @param[in] callback called for every realised output
*/
nix_err nix_store_build(nix_c_context *context, Store *store, StorePath *path,
void *userdata,
void (*cb)(void *userdata, const char *outname,
void (*callback)(void *userdata, const char *outname,
const char *out));
/**