fix(fluxdoc): use db when generating docs #5322
Merged
+46
−137
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
d099de5 to
f3ac1f7
Compare
Previously the fluxdoc gen would run a compilation step using `fluxc` to speed up compilation. Compilation is very fast now and we have the salsa db that does proper caching of intermediate steps. This change removes the `fluxc` binary and the left over unused code. Also we update the `fluxdoc` binary to use the salsa db only. Since this is potentially a perf change I tested how fast the docs generate, its dominated almost exclusively in running the examples. Compiling the stdlib is instantaneous in my system.
f3ac1f7 to
bed4547
Compare
wolffcm
approved these changes
Oct 31, 2022
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 the fluxdoc gen would run a compilation step using
fluxcto speed up compilation. Compilation is very fast now and we have the salsa db that does proper caching of intermediate steps. This change removes thefluxcbinary and the left over unused code. Also we update thefluxdocbinary to use the salsa db only.Since this is potentially a perf change I tested how fast the docs generate, its dominated almost exclusively in running the examples. Compiling the stdlib is instantaneous in my system.
Checklist
Dear Author 👋, the following checks should be completed (or explicitly dismissed) before merging.
experimental/docs/Spec.mdhas been updatedDear Reviewer(s) 👋, you are responsible (among others) for ensuring the completeness and quality of the above before approval.