made the complete dependencies paragraph in features.tt a lot clearer for new users #615
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
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: |
7c6f434c
reviewed
Oct 14, 2020
garbas
approved these changes
Oct 14, 2020
There was a problem hiding this comment.
@makoConstruct I think you are pointing a valid concern. Thank you.
I have added few changes, but overall it is an improvement over previous version.
Major rework on content of this page is coming together with the redesign sometimes next week.
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.
When trying to learn how nix works through the features page, I had a lot of trouble understanding this section. We discussed it here https://discourse.nixos.org/t/site-intro-to-nixs-repeatable-builds-point-has-some-clarity-issues/9154/4 , and eventually things were explained to me. Accordingly, I have changed the section so that it will be more clear for new users.
In short, saying "compilers don’t search in per-packages
directories such as
/nix/store/5lbfaxb722zp…-openssl-0.9.8d/include,"
Is very confusing for a new user, because they are trying to understand how compilers actually do find their way into nix's store when they're allowed to, and this comes across as if it's saying that they don't. It is in fact a regular occurrence for compilers to "search" those directories, and they need to see this acknowledged, so it's very hard for them to find the intended meaning.
"Runtime dependencies are found by scanning binaries" is also somewhat confusing, as the result files of a build might not always be binaries. A new user would be led to ask "why just the binaries?"