nixos/nix
1
1
Fork 0
mirror of https://github.com/NixOS/nix.git synced 2025-11-16 15:32:43 +01:00
Code Activity

Apply documentation suggestions from code review

Browse source 
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
This commit is contained in:
Yorick 2023-08-28 16:20:46 +02:00 • committed by José Luis Lafuente
parent 3b41830a96
commit 40f5d48d3c
No known key found for this signature in database
GPG key ID: 8A3455EBE455489A
8 changed files with 65 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/libstore/c/nix-store-c.pc.in
View file

@ -3,7 +3,7 @@ libdir=@libdir@
includedir=@includedir@
Name: Nix
Description: Nix Package Manager - C API
Description: Nix Store - C API
Version: @PACKAGE_VERSION@
Libs: -L${libdir} -lnixstorec -lnixutilc
Cflags: -I${includedir}/nix

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

@ -19,9 +19,9 @@ extern "C" {
#endif
// cffi start
/** @brief reference to a nix store */
/** @brief Reference to a Nix store */
typedef struct Store Store;
/** @brief nix store path */
/** @brief Nix store path */
typedef struct StorePath StorePath;
/**
@ -79,9 +79,9 @@ nix_err nix_store_get_uri(nix_c_context *context, Store *store, char *dest,
// returns: owned StorePath*
/**
* @brief parse a nix store path into a StorePath
* @brief Parse a Nix store path into a StorePath
*
* Don't forget to free this path using nix_store_path_free
* @note Don't forget to free this path using nix_store_path_free()!
* @param[out] context Optional, stores error information
* @param[in] store nix store reference
* @param[in] path Path string to parse, copied
@ -90,7 +90,7 @@ nix_err nix_store_get_uri(nix_c_context *context, Store *store, char *dest,
StorePath *nix_store_parse_path(nix_c_context *context, Store *store,
const char *path);
/** @brief Deallocate a nix StorePath
/** @brief Deallocate a StorePath
*
* Does not fail.
* @param[in] p the path to free
@ -98,9 +98,9 @@ StorePath *nix_store_parse_path(nix_c_context *context, Store *store,
void nix_store_path_free(StorePath *p);
/**
* @brief check if a storepath is valid (exists in the store)
* @brief Check if a StorePath is valid (i.e. that corresponding store object and its closure of references exists in the store)
* @param[out] context Optional, stores error information
* @param[in] store nix store reference
* @param[in] store Nix Store reference
* @param[in] path Path to check
* @return true or false, error info in context
*/
@ -109,12 +109,12 @@ bool nix_store_is_valid_path(nix_c_context *context, Store *store,
// nix_err nix_store_ensure(Store*, const char*);
// nix_err nix_store_build_paths(Store*);
/**
* @brief Build a nix store path
* @brief Realise a Nix store path
*
* Blocking, calls cb once for each built output
*
* @param[out] context Optional, stores error information
* @param[in] store nix store reference
* @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