Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

made the complete dependencies paragraph in features.tt a lot clearer for new users #615

Merged
merged 2 commits into from Oct 14, 2020

Conversation

@makoConstruct
Copy link
Contributor

@makoConstruct makoConstruct commented Oct 11, 2020

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?"

@nixos-discourse
Copy link

@nixos-discourse nixos-discourse commented Oct 11, 2020

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/site-intro-to-nixs-repeatable-builds-point-has-some-clarity-issues/9154/15

features.tt Outdated Show resolved Hide resolved
garbas
garbas approved these changes Oct 14, 2020
Copy link
Contributor

@garbas garbas left a 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.

@garbas garbas merged commit fb2a2d5 into NixOS:master Oct 14, 2020
1 check passed
1 check passed
@github-actions[bot]
build-and-deploy build-and-deploy
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants