Allow GHC bindists to set locale #1249
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
Some systems might not have the default locale: `C.UTF-8`. When this locale is not found, some tooling can fail when manipulating files. In particular, `haddock` can fail when reading files that might contain UTF-8 encoded values: ``` haddock: internal error: /tmp/tmputn68mya/doc/html/path-io/haddock-response300-1.txt: hGetContents: invalid argument (invalid byte sequence) ``` We have support for setting the locale with nixpkgs, but there was no support for setting the locale with GHC bindists. We allow overriding the default locale when using GHC bindists in case a system doesn't have the `C.UTF-8` locale. We also write up a little blurb about troubleshooting, in case anyone else runs into a similar issue.
aherrmann
approved these changes
Feb 21, 2020
There was a problem hiding this comment.
Thank you, that looks great! In particular thanks for the troubleshooting section!
I couldn't find any tests to extend for the changes I made here. Should a new test be created, or is this not an area to test?
This is a bit tricky to test, I think. Just setting locale = en_US.UTF-8 does not test this extensively, as the build would still pass in our test environment if we accidentally ignored that setting. Maybe @bazel_skylib//lib:unittest.bzl's action testing framework could be used to test that LANG=en_US.UTF-8 is really set for the build actions. Though I don't know how much effort that would be to implement.
|
Gotcha! Thanks for the quick review! |
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.
In #1248, it was discovered that the locale for GHC bindists was not able to be overridden. It would default to
C.UTF-8. If a system didn't have theC.UTF-8locale, it could lead to (unclear) encoding failures later on. In particular,haddockmight fail in an unclear way:This PR allows setting the locale for GHC bindists and also writes up a little bit in the troubleshooting section. I wasn't 100% sure how to make this happen, but this seems to allow my minimal reproduction to build. Lemme know if anything should change, or if this is not the right approach.
I couldn't find any tests to extend for the changes I made here. Should a new test be created, or is this not an area to test?