Merge pull request #311902 from wamirez/nix-env-rm

doc: clarify consequences of `lib.meta.setName`
NixOS · May 22, 2024 · 1c91e55 · 1c91e55
2 parents 16d101c + 7acc08c
commit 1c91e55
Showing 1 changed file with 6 additions and 2 deletions.
diff --git 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;};