diff options
author | wamirez <wamirez@protonmail.com> | 2024-05-15 05:26:35 -0400 |
---|---|---|
committer | wamirez <wamirez@protonmail.com> | 2024-05-15 06:32:23 -0400 |
commit | 7acc08c9833e876447675f2a89e1a154e22fa6bc (patch) | |
tree | 3c9d61de86114c3986608efcc9772cb74e3d7dcc /lib/meta.nix | |
parent | bceda8911e7386a3843cfeb673b581799ca782ef (diff) |
doc: clarify consequences of `lib.meta.setName`
And remove unnecessary mention of `nix-env`
Diffstat (limited to 'lib/meta.nix')
-rw-r--r-- | lib/meta.nix | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/lib/meta.nix b/lib/meta.nix index 675e1912d4be9..9a97afb1aa9b0 100644 --- a/lib/meta.nix +++ b/lib/meta.nix @@ -26,8 +26,12 @@ rec { dontDistribute = drv: addMetaAttrs { hydraPlatforms = []; } drv; - /* Change the symbolic name of a package for presentation purposes - (i.e., so that nix-env users can tell them apart). + /* + Change the [symbolic name of a derivation](https://nixos.org/manual/nix/stable/language/derivations.html#attr-name). + + :::{.warning} + Dependent derivations will be rebuilt when the symbolic name is changed. + ::: */ setName = name: drv: drv // {inherit name;}; |