Skip to content

Fix 2.13.13 regression in Scaladoc compilation when using Scala 3 definitions #10700

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
Merged
lrytz merged 3 commits into from
Feb 26, 2024
Merged

Fix 2.13.13 regression in Scaladoc compilation when using Scala 3 definitions #10700

lrytz merged 3 commits into from
Feb 26, 2024

Conversation

@bishabosha
Copy link
Member

@bishabosha bishabosha commented Feb 23, 2024 •
edited by SethTisue
Loading

.tasty files are no longer considered source files of a symbol.

Specifically the behavior observed in scala/bug#12955 is caused by the top level class scala.deriving.Mirror not being filtered out from generating a doc page, because the sourceFile property on the Symbol wasn't null (i.e. it returned a ".tasty" file)

fixes scala/bug#12955

@scala-jenkins scala-jenkins added this to the 2.13.14 milestone Feb 23, 2024
@bishabosha bishabosha marked this pull request as ready for review February 23, 2024 19:19
@bishabosha bishabosha requested a review from SethTisue February 23, 2024 19:19
@bishabosha bishabosha requested a review from lrytz February 23, 2024 19:19
@bishabosha
Copy link
Member Author

bishabosha commented Feb 23, 2024

not sure what's the best regression test for this, a sbt scripted test? or I can try to add a scaladoc invoker to the tasty test stuff

@SethTisue SethTisue added the prio:blocker release blocker (used only by core team, only near release time) label Feb 23, 2024
@SethTisue
Copy link
Member

SethTisue commented Feb 24, 2024

Hmm, I'm not sure either. Off the top of my head ,though: invoking Scaladoc directly rather than going through sbt seems simpler and more efficient. Maybe try that first and fall back to scripting sbt if you run into too many obstacles on the other path?

@SethTisue
Copy link
Member

SethTisue commented Feb 24, 2024 •
edited
Loading

Note that I do think that it's important to do one or the other and not simply leave it untested.

Converting to draft for now until some testing is in place.

@SethTisue SethTisue marked this pull request as draft February 24, 2024 19:55
@bishabosha
Copy link
Member Author

bishabosha commented Feb 26, 2024

@SethTisue I have added the regression test

@bishabosha bishabosha marked this pull request as ready for review February 26, 2024 14:39
@lrytz
Copy link
Member

lrytz commented Feb 26, 2024 

[error] (tastytest / Compile / headerCheck) There are files without headers!
[error]   /home/travis/build/scala/scala/src/tastytest/scala/tools/tastytest/Scaladoc.scala
[error]   /home/travis/build/scala/scala/src/tastytest/scala/tools/tastytest/Scaladoc.scala

lrytz
lrytz previously approved these changes Feb 26, 2024
View reviewed changes
Copy link
Member

@lrytz lrytz left a comment

Choose a reason for hiding this comment

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

LGTM otherwise, thank you.

@lrytz lrytz self-requested a review February 26, 2024 15:52
@lrytz lrytz dismissed their stale review February 26, 2024 15:52

header fix

@lrytz lrytz removed request for SethTisue and lrytz February 26, 2024 15:52
@bishabosha
Copy link
Member Author

bishabosha commented Feb 26, 2024

should be fixed now

@bishabosha bishabosha requested a review from lrytz February 26, 2024 16:53
@lrytz lrytz merged commit 577ab8e into scala:2.13.x Feb 26, 2024
@sjrd sjrd deleted the fix-classpath-issue branch February 26, 2024 19:38
@SethTisue SethTisue added release-notes worth highlighting in next release notes and removed prio:blocker release blocker (used only by core team, only near release time) labels Feb 26, 2024
@SethTisue SethTisue changed the title ".tasty" files are no longer considered source files of a symbol. Fix 2.13.13 regression in Scaladoc compilation when using Scala 3 definitions Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lrytz lrytz Awaiting requested review from lrytz

Assignees

@SethTisue SethTisue

Labels

release-notes worth highlighting in next release notes

Projects

None yet

Milestone

2.13.14

Development

Successfully merging this pull request may close these issues.

Regression in scaladoc compilation when using Scala 3 definitions

4 participants

@bishabosha @SethTisue @lrytz @scala-jenkins