Skip to content

Commit 12293a8

Browse files
committed
C API: Document nix_store_copy_closure flags
1 parent 3fb943d commit 12293a8

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

src/libstore-c/nix_api_store.h

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -253,9 +253,14 @@ nix_err nix_store_copy_closure(nix_c_context * context, Store * srcStore, Store
253253
* @param[out] context Optional, stores error information
254254
* @param[in] store nix store reference
255255
* @param[in] store_path The path to compute from
256-
* @param[in] flip_direction
257-
* @param[in] include_outputs
258-
* @param[in] include_derivers
256+
* @param[in] flip_direction If false, compute the forward closure (paths referenced by any store path in the closure).
257+
* If true, compute the backward closure (paths that reference any store path in the closure).
258+
* @param[in] include_outputs If flip_direction is false: for any derivation in the closure, include its outputs.
259+
* If flip_direction is true: for any output in the closure, include derivations that produce
260+
* it.
261+
* @param[in] include_derivers If flip_direction is false: for any output in the closure, include the derivation that
262+
* produced it.
263+
* If flip_direction is true: for any derivation in the closure, include its outputs.
259264
* @param[in] callback The function to call for every store path, in no particular order
260265
* @param[in] userdata The userdata to pass to the callback
261266
*/

0 commit comments

Comments
 (0)