Make scaladoc a bootstrapped-only project #12315
Merged
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
smarter
commented
May 3, 2021
Comment on lines
+34
to
+53
| def makeDocScalaInstance( | ||
| state: State, | ||
| base: ScalaInstance, | ||
| docJars: Array[File] | ||
| ): ScalaInstance = { | ||
| val cache = state.extendedClassLoaderCache | ||
|
|
||
| val fullLoader = cache(docJars.toList, base.loaderCompilerOnly) | ||
|
|
||
| new ScalaInstance( | ||
| version = base.version, | ||
| loader = fullLoader, | ||
| loaderCompilerOnly = base.loaderCompilerOnly, | ||
| loaderLibraryOnly = base.loaderLibraryOnly, | ||
| libraryJars = base.libraryJars, | ||
| compilerJars = base.compilerJars, | ||
| allJars = base.allJars ++ docJars, | ||
| explicitActual = base.explicitActual | ||
| ) |
There was a problem hiding this comment.
@adpi2 It'd be nice to have a withAllJars method in ScalaInstance to simplify that I think.
Previously, we had both a non-bootstrapped and bootstrapped version of that project as well as its dependencies (scala3-library-js, scala3-tasty-inspector, scaladoc-testcases, scaladoc-js), the main reason for this is that it allowed the non-boostrapped scaladoc to be part of the `scalaInstance` of all bootstrapped projects, allowing us to run `scala3-library-bootstrapped/doc` for example. But this also meant that simply trying to run the compiler would compiler scaladoc as well as its dependencies even if no documentation needed to be generated, and since `scaladoc-js` runs the Scala.js optimizer this could be quite slow. This commit fixes that by using a separate `scalaInstance` for the `doc` task, which means the regular `scalaInstance` no longer needs to depend on scaladoc and also allows us to remove all the non-bootstrapped projects related to scaladoc (thus simplifying the build a lot) since we can safely use the bootstrapped version in `doc / scalaInstance` without running into a loop.
smarter
force-pushed
the
scaladoc-bootstrapped-only
branch
from
cf467bc to
96c3957
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.
Previously, we had both a non-bootstrapped and bootstrapped version of
that project as well as its dependencies (scala3-library-js,
scala3-tasty-inspector, scaladoc-testcases, scaladoc-js), the main
reason for this is that it allowed the non-boostrapped scaladoc to be
part of the
scalaInstanceof all bootstrapped projects, allowing us torun
scala3-library-bootstrapped/docfor example. But this also meantthat simply trying to run the compiler would compiler scaladoc as well
as its dependencies even if no documentation needed to be generated, and
since
scaladoc-jsruns the Scala.js optimizer this could be quite slow.This commit fixes that by using a separate
scalaInstancefor thedoctask, which means the regular
scalaInstanceno longer needs to dependon scaladoc and also allows us to remove all the non-bootstrapped
projects related to scaladoc (thus simplifying the build a lot) since we
can safely use the bootstrapped version in
doc / scalaInstancewithoutrunning into a loop.