Make package names more similar to the rule name. #246
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
As of #222, both the package name and ID are z-encoded. However, GHC only needs the package *ID* to be unique, as long as you call `-package-id` instead of `-package`. As a result we can simplify how package-names are encoded: we can keep them the same as the rule name, other than fixing underscores. In addition to (I think) making error messages nicer, this paves the way for some improvements in Hazel (or similar tools), now that the rule and package names can be identical: - It helps support the PackageImports extension. - GHC >= 8.0 generates the Cabal macros (e.g., `MIN_VERSION_*`) automatically. Prebuilt dependencies are still passed with `-package` since their IDs are internal details of GHC.
judah
added a commit
to FormationAI/hazel
that referenced
this pull request
May 15, 2018
It turns out they're generated automatically by GHC since version 8.0, as long as we pass the right package name and version. That's now possible as of tweag/rules_haskell#246. I'll hold off merging this PR until that one goes in, then I'll rebase to `rules_haskell` master.
judah
added a commit
to FormationAI/hazel
that referenced
this pull request
May 15, 2018
It turns out they're generated automatically by GHC since version 8.0, as long as we pass the right package name and version. That's now possible as of tweag/rules_haskell#246. I'll hold off merging this PR until that one goes in, then I'll rebase to `rules_haskell` master.
judah
added a commit
to FormationAI/hazel
that referenced
this pull request
May 15, 2018
It turns out they're generated automatically by GHC since version 8.0, as long as we pass the right package name and version. That's now possible as of tweag/rules_haskell#246. I'll hold off merging this PR until that one goes in, then I'll rebase to `rules_haskell` master.
mboes
approved these changes
May 15, 2018
| @@ -866,35 +862,41 @@ def _zencode(s): | |||
| return s.replace("Z", "ZZ").replace("_", "ZU").replace("/", "ZS") | |||
|
|
|||
| def get_pkg_name(ctx): | |||
| """Get package name. Package name includes Bazel package and name of the | |||
There was a problem hiding this comment.
You point out that funny package names won't just be visible in documentation, but much worse, in source code too (if using -XPackageImports). Funny names in documentation is less bad because if the names change, nothing breaks. Fortunately, we can separate package-id from package-name, it's just that underscores are still illegal.
If so then I'd lean towards banning underscores outright. That way no encoding necessary, no funny names in package imports. Either that or s/_/-/, which yes, is technically a non-injective encoding, but since package names don't need to be unique (only package-id's), that should be ok. And it lets users keep to Bazel-conventional package naming style if desired (i.e. underscores everywhere, no hyphens).
mrkkrp
approved these changes
May 15, 2018
haskell/actions.bzl
Outdated
| """Get package name. | ||
|
|
||
| The name is not required to be unique/injective; however it must be a valid | ||
| GHC package name (i.e., no underscores). This encoding is not aims to |
haskell/cc.bzl
Outdated
| @@ -187,6 +187,7 @@ def _cc_haskell_import(ctx): | |||
| if dbin != None: | |||
| set.mutable_insert(dyn_libs, dbin) | |||
|
|
|||
| print(dyn_libs) | |||
haskell/providers.bzl
Outdated
| @@ -15,7 +15,7 @@ HaskellBuildInfo = provider( | |||
| HaskellLibraryInfo = provider( | |||
| doc = "Library-specific information.", | |||
| fields = { | |||
| "package_name": "Package name, usually of the form name-version.", | |||
| "package_id": "Package name, usually of the form name-version.", | |||
judah
added a commit
to FormationAI/hazel
that referenced
this pull request
May 17, 2018
It turns out they're generated automatically by GHC since version 8.0, as long as we pass the right package name and version. That's now possible as of tweag/rules_haskell#246. (So bump `rules_haskell` accordingly.) Also add network back since the new `rules_haskell` handles `cc_library` `defines` attributes better.
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.
As of #222, both the package name and ID are z-encoded. However,
GHC only needs the package ID to be unique, as long as you
call
-package-idinstead of-package. As a result we cansimplify how package-names are encoded: we can keep them the same
as the rule name, other than fixing underscores.
In addition to (I think) making error messages nicer, this paves the way for
some improvements in Hazel (or similar tools), now that the rule and package
names can be identical:
MIN_VERSION_*) automatically.Prebuilt dependencies are still passed with
-packagesince their IDs are internal details of GHC.