diff options
| author | Chris Martin <ch.martin@gmail.com> | 2016-09-18 05:20:53 -0400 |
|---|---|---|
| committer | Domen Kožar <domen@dev.si> | 2016-09-18 11:20:53 +0200 |
| commit | 10f2befa5875469c39a63049f5c47269d669d4d8 (patch) | |
| tree | 82b75a87823c350207466de1e60c3f00f0aad37d /pkgs/stdenv | |
| parent | d5e24d3f8091ac04cccb1a34205fd0e93d9fa113 (diff) | |
| download | nixlib-10f2befa5875469c39a63049f5c47269d669d4d8.tar nixlib-10f2befa5875469c39a63049f5c47269d669d4d8.tar.gz nixlib-10f2befa5875469c39a63049f5c47269d669d4d8.tar.bz2 nixlib-10f2befa5875469c39a63049f5c47269d669d4d8.tar.lz nixlib-10f2befa5875469c39a63049f5c47269d669d4d8.tar.xz nixlib-10f2befa5875469c39a63049f5c47269d669d4d8.tar.zst nixlib-10f2befa5875469c39a63049f5c47269d669d4d8.zip | |
stdenv.mkDerivation: add comments w/ manual links (#18707)
Diffstat (limited to 'pkgs/stdenv')
| -rw-r--r-- | pkgs/stdenv/generic/default.nix | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/pkgs/stdenv/generic/default.nix b/pkgs/stdenv/generic/default.nix index e71c2f770b9b..372fd3cfa526 100644 --- a/pkgs/stdenv/generic/default.nix +++ b/pkgs/stdenv/generic/default.nix @@ -89,8 +89,16 @@ let cc ]; - # Add a utility function to produce derivations that use this - # stdenv and its shell. + # `mkDerivation` wraps the builtin `derivation` function to + # produce derivations that use this stdenv and its shell. + # + # See also: + # + # * https://nixos.org/nixpkgs/manual/#sec-using-stdenv + # Details on how to use this mkDerivation function + # + # * https://nixos.org/nix/manual/#ssec-derivation + # Explanation about derivations in general mkDerivation = { buildInputs ? [] , nativeBuildInputs ? [] |