treewide: update mainProgram docs #247130
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
8.has: documentation
6.topic: nodejs
6.topic: lib
Artturin
commented
Aug 4, 2023
lib/meta.nix
Outdated
| @@ -132,8 +132,7 @@ rec { | |||
| { shortName = licstr; } | |||
| ); | |||
|
|
|||
| /* Get the path to the main program of a derivation with either | |||
| meta.mainProgram or pname or name | |||
| /* Get the path to the main program of a derivation meta.mainProgram | |||
There was a problem hiding this comment.
I don't think the doc should include deprecated behaviour?
There was a problem hiding this comment.
Suggested change
| /* Get the path to the main program of a derivation meta.mainProgram | |
| /* Get the path to the main program of a package based on meta.mainProgram |
- added "based on"
- derivation -> package, because the builder is also a main program
Derivations are just how we build packages, and the attrset returned by mkDerivation is a representation of the package in context.
ofborg
bot
added
10.rebuild-darwin: 1-10
10.rebuild-darwin: 1
10.rebuild-linux: 1-10
labels
roberth
reviewed
Aug 4, 2023
lib/meta.nix
Outdated
| @@ -132,8 +132,7 @@ rec { | |||
| { shortName = licstr; } | |||
| ); | |||
|
|
|||
| /* Get the path to the main program of a derivation with either | |||
| meta.mainProgram or pname or name | |||
| /* Get the path to the main program of a derivation meta.mainProgram | |||
There was a problem hiding this comment.
Suggested change
| /* Get the path to the main program of a derivation meta.mainProgram | |
| /* Get the path to the main program of a package based on meta.mainProgram |
- added "based on"
- derivation -> package, because the builder is also a main program
Derivations are just how we build packages, and the attrset returned by mkDerivation is a representation of the package in context.
``` nix-repl> lib.getExe (pass.withExtensions(_: [])) "/nix/store/rvc4ambjr8jsvm5n757icfl3j7gv1jxh-pass-env/bin/pass" ```
Artturin
commented
Aug 4, 2023
|
|
||
| Type: getExe :: derivation -> string | ||
| Type: getExe :: package -> string |
There was a problem hiding this comment.
@roberth changed the type too
AndersonTorres
approved these changes
Aug 4, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes
Things done
sandbox = trueset innix.conf? (See Nix manual)nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage./result/bin/)