From 30364657608090625e9c7f861da53f42f8e913f2 Mon Sep 17 00:00:00 2001 From: Sefa Eyeoglu Date: Sun, 13 Aug 2023 12:27:41 +0200 Subject: lib/meta.nix: introduce getExe' getExe' can be used to get a binary other than the mainProgram from a derivation. Signed-off-by: Sefa Eyeoglu --- lib/default.nix | 2 +- lib/meta.nix | 25 ++++++++++++++++++++----- 2 files changed, 21 insertions(+), 6 deletions(-) (limited to 'lib') diff --git a/lib/default.nix b/lib/default.nix index 73b8ad871544..124528c5f50c 100644 --- a/lib/default.nix +++ b/lib/default.nix @@ -116,7 +116,7 @@ let inherit (self.derivations) lazyDerivation; inherit (self.meta) addMetaAttrs dontDistribute setName updateName appendToName mapDerivationAttrset setPrio lowPrio lowPrioSet hiPrio - hiPrioSet getLicenseFromSpdxId getExe; + hiPrioSet getLicenseFromSpdxId getExe getExe'; inherit (self.filesystem) pathType pathIsDirectory pathIsRegularFile; inherit (self.sources) cleanSourceFilter cleanSource sourceByRegex sourceFilesBySuffices diff --git a/lib/meta.nix b/lib/meta.nix index d32a37fe61d7..50665c9513df 100644 --- a/lib/meta.nix +++ b/lib/meta.nix @@ -144,9 +144,24 @@ rec { => "/nix/store/am9ml4f4ywvivxnkiaqwr0hyxka1xjsf-mustache-go-1.3.0/bin/mustache" */ getExe = x: - "${lib.getBin x}/bin/${x.meta.mainProgram or ( - # This could be turned into an error when 23.05 is at end of life - lib.warn "getExe: Package ${lib.strings.escapeNixIdentifier x.meta.name or x.pname or x.name} does not have the meta.mainProgram attribute. We'll assume that the main program has the same name for now, but this behavior is deprecated, because it leads to surprising errors when the assumption does not hold. If the package has a main program, please set `meta.mainProgram` in its definition to make this warning go away. Otherwise, if the package does not have a main program, or if you don't control its definition, specify the full path to the program, such as \"\${lib.getBin foo}/bin/bar\"." - lib.getName x - )}"; + let + y = x.meta.mainProgram or ( + # This could be turned into an error when 23.05 is at end of life + lib.warn "getExe: Package ${lib.strings.escapeNixIdentifier x.meta.name or x.pname or x.name} does not have the meta.mainProgram attribute. We'll assume that the main program has the same name for now, but this behavior is deprecated, because it leads to surprising errors when the assumption does not hold. If the package has a main program, please set `meta.mainProgram` in its definition to make this warning go away. Otherwise, if the package does not have a main program, or if you don't control its definition, specify the full path to the program, such as \"\${lib.getBin foo}/bin/bar\"." + lib.getName + x + ); + in + getExe' x y; + + /* Get the path of a program of a derivation. + + Type: getExe' :: derivation -> string -> string + Example: + getExe' pkgs.hello "hello" + => "/nix/store/g124820p9hlv4lj8qplzxw1c44dxaw1k-hello-2.12/bin/hello" + getExe' pkgs.imagemagick "convert" + => "/nix/store/5rs48jamq7k6sal98ymj9l4k2bnwq515-imagemagick-7.1.1-15/bin/convert" + */ + getExe' = x: y: "${lib.getBin x}/bin/${y}"; } -- cgit 1.4.1 From a9a29b70590d95761044fb976b8135c9087ee24b Mon Sep 17 00:00:00 2001 From: Sefa Eyeoglu Date: Tue, 15 Aug 2023 08:57:31 +0200 Subject: lib/meta.nix: recommend use of getExe' in getExe warning Signed-off-by: Sefa Eyeoglu --- lib/meta.nix | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'lib') diff --git a/lib/meta.nix b/lib/meta.nix index 50665c9513df..89c78a9bc24e 100644 --- a/lib/meta.nix +++ b/lib/meta.nix @@ -147,7 +147,7 @@ rec { let y = x.meta.mainProgram or ( # This could be turned into an error when 23.05 is at end of life - lib.warn "getExe: Package ${lib.strings.escapeNixIdentifier x.meta.name or x.pname or x.name} does not have the meta.mainProgram attribute. We'll assume that the main program has the same name for now, but this behavior is deprecated, because it leads to surprising errors when the assumption does not hold. If the package has a main program, please set `meta.mainProgram` in its definition to make this warning go away. Otherwise, if the package does not have a main program, or if you don't control its definition, specify the full path to the program, such as \"\${lib.getBin foo}/bin/bar\"." + lib.warn "getExe: Package ${lib.strings.escapeNixIdentifier x.meta.name or x.pname or x.name} does not have the meta.mainProgram attribute. We'll assume that the main program has the same name for now, but this behavior is deprecated, because it leads to surprising errors when the assumption does not hold. If the package has a main program, please set `meta.mainProgram` in its definition to make this warning go away. Otherwise, if the package does not have a main program, or if you don't control its definition, use getExe' to specify the name to the program, such as lib.getExe' foo \"bar\"." lib.getName x ); -- cgit 1.4.1