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.

Sign up for GitHub

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

Jump to bottom

doc/cross-compilation: Remove confusing re-explanation #106958

Merged
merged 2 commits into from Dec 15, 2020
Merged

doc/cross-compilation: Remove confusing re-explanation #106958

merged 2 commits into from Dec 15, 2020

Conversation

roberth
Copy link
Member

@roberth roberth commented Dec 15, 2020 •
edited

Motivation for this change

Unconfuse the reader.

Closes #106950:

They way it's worded says buildInputs are for build-time and nativeBuildInputs are for run-time. The other documentation leads me to believe it is the other way around.

Perhaps the author's confusion was: buildInputs are for the build output and nativeBuildInputs are for running (during the build).

@Ericson2314 is this ok? Any other places that may have a similar confusion going?

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@roberth
doc/cross-compilation: Remove confusing re-explanation
c7e5c02 
See #106950

> They way it's worded says buildInputs are for build-time and nativeBuildInputs are for run-time. The other documentation leads me to believe it is the other way around.
Ericson2314
Ericson2314 approved these changes Dec 15, 2020
View reviewed changes
Copy link
Member

@Ericson2314 Ericson2314 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@roberth @Ericson2314
doc/stdenv/cross-compilation.chapter.md typo
3393e11 
Co-authored-by: John Ericson <git@JohnEricson.me>
@roberth roberth merged commit 408e703 into master Dec 15, 2020
@roberth
Copy link
Member Author

roberth commented Dec 15, 2020

Thanks!

@roberth roberth deleted the doc-cross-compilation-remove-confusing-reexplanation branch December 15, 2020 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Ericson2314 Ericson2314 Ericson2314 approved these changes

Assignees
No one assigned
Labels
8.has: documentation 10.rebuild-darwin: 0 10.rebuild-linux: 0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

buildInputs and nativeBuildInputs swapped in documentation
2 participants
@roberth @Ericson2314