Avoid unnecessary recompilation due to -haddock #4596
+24
−16
Conversation
This file contains hidden or 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
|
I would love to implement a regression test for this, but I am currently unsure how. |
fendor
force-pushed
the
fix/haddock-recompilation
branch
2 times, most recently
from
3f84a3d to
16d4457
Compare
fendor
force-pushed
the
fix/haddock-recompilation
branch
from
16d4457 to
2606976
Compare
|
I manually tested it on GHC and think I can confirm this fixes the recompilation issue but I struggle to come up with a test case in HLS itself. |
|
possible issue with this PR -- the haddocks for definitions in the local module don't appear to be available in the completion details. I instead see: in the lsp server's log output. non-local details DO appear to be resolvable, however, and that warning isn't printed. if I just use master instead of applying this PR, this warning is never printed for either local or non-local bindings. |
|
Thank you for testing this change! I will look into it. |
fendor
force-pushed
the
fix/haddock-recompilation
branch
2 times, most recently
from
af7a56d to
e66c922
Compare
|
Can't reproduce, with GHC 9.6.7, I get: and the logs are clear. |
fendor
force-pushed
the
fix/haddock-recompilation
branch
from
e66c922 to
c8ac7f8
Compare
Due to unprincipled adding and removing the `-haddock` flag during compilation and recompilation checking, we were performing more work than necessary. We avoid this by compiling everything with `-haddock` by default. This is safe nowadays, we have essentially been doing this for many releases, and know this is fine. For the occasion where we actually want to parse without the `-haddock` flag, we keep explicitly disabling it. We enable `-haddock` flag during session loading, since we already perform a number of DynFlags tweaks. This behaviour is dependent on the `OptHaddockParse` opton, which can, currently, only be modified at compile-time.
fendor
force-pushed
the
fix/haddock-recompilation
branch
from
fd3ee2d to
d3d1869
Compare
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.
Due to unprincipled adding and removing the
-haddockflag during compilation and recompilation checking, we were performing more work than necessary.We avoid this by compiling everything with
-haddockby default. This is safe nowadays, we have essentially been doing this for many releases, and know this is fine.For the occasion where we actually want to parse without the
-haddockflag, we keep explicitly disabling it.We enable
-haddockflag during session loading, since we already perform a number of DynFlags tweaks.This behaviour is dependent on the
OptHaddockParseoption, which can, currently, only be modified at compile-time.Closes #4511