[K2] Add a check that source roots do not intersect #3465
Conversation
ff0688b to
18a0479
Compare
18a0479 to
bfdc31f
Compare
There was a problem hiding this comment.
LGTM.
I think, that it should be still an error, because if not, we will anyway fail during execution with K2, so error log message doesn't make sense to me, or do you have a reason why it could be better?
But, may be we need to add checker in K1 which will show warning message if something like this happens, to prepare users, that after switching to K2 current setup will not work? Or warning in KGP (from some version) will be enough?
There was a problem hiding this comment.
👍 👍
I also believe it makes sense to throw an exception in this case, so that it fails with a user-understandable error instead of a very technical compiler error
And Oleg's idea also seems very useful: to log a warning in K1 that in K2 it will be an error, and to ask users who see this log warning in K1 to report their use case. Something like
Source sets X and Y have common source roots: Z. Every Kotlin source file should belong to only one source set (module). This will become an error when Dokka migrates to K2-based code analysis. If you cannot fix this and you think you have a valid use case, please report it:
https://github.com/Kotlin/dokka/issues/3239
| } | ||
| } | ||
| } | ||
| return PreGenerationCheckerOutput(messages.isEmpty(), messages) |
There was a problem hiding this comment.
Took me a while to figure out if / how / why Dokka would throw an exception in K2, but not in K1 (because the code looks the same), so leaving a message for Oleg in case he also doesn't see it right away: the first parameter of PreGenerationCheckerOutput is basically a isSuccess boolean, so Dokka fails if it's false.
The pre-generation check throws
DokkaExceptionhere. Probably it could be a logging error messages instead of an exception. Need to discuss.