stdenv.mkDerivation: add comments w/ manual links (#18707)

This commit is contained in:
Chris Martin 2016-09-18 05:20:53 -04:00 committed by Domen Kožar
parent d5e24d3f80
commit 10f2befa58
1 changed files with 10 additions and 2 deletions

View File

@ -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 ? []