Allow sysimage build without the doc system #53533
Merged
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
The earliest bootstrapping code has a definition of `atdoc` that is just supposed to ignore the doc string and pass the defining code through. This function is then replaced by the actual docsystem once that is available. For testing, I wanted to build the whole system image without the doc system using this boostrap definition. However, this turns out not to be possible, because there's a few doc syntax semantics that do not actually just ignore the doc string. In particular: ``` """ I am a doc for a particular signature """ foo(x::Int, y::Float64) ``` Does not acutally result in a call to `foo`. And similarly ``` """ I am a doc for a global binding """ MyModule.foo ``` Does not require `MyModule.foo` to actually have a value, since it only documents the binding. This PR allows both of those cases in the boostrap version of `atdoc` so that we can bootstrap without the doc system if we wanted to.
vtjnash
approved these changes
Feb 29, 2024
|
Yeah, I considered that, but it seems annoying to duplicate all that logic and this makes the system image build at least, which I think is a reasonable position to be in for now. |
tecosaur
pushed a commit
to tecosaur/julia
that referenced
this pull request
Mar 4, 2024
The earliest bootstrapping code has a definition of `atdoc` that is just supposed to ignore the doc string and pass the defining code through. This function is then replaced by the actual docsystem once that is available. For testing, I wanted to build the whole system image without the doc system using this boostrap definition. However, this turns out not to be possible, because there's a few doc syntax semantics that do not actually just ignore the doc string. In particular: ``` """ I am a doc for a particular signature """ foo(x::Int, y::Float64) ``` Does not acutally result in a call to `foo`. And similarly ``` """ I am a doc for a global binding """ MyModule.foo ``` Does not require `MyModule.foo` to actually have a value, since it only documents the binding. This PR allows both of those cases in the boostrap version of `atdoc` so that we can bootstrap without the doc system if we wanted to.
mkitti
pushed a commit
to mkitti/julia
that referenced
this pull request
Apr 13, 2024
The earliest bootstrapping code has a definition of `atdoc` that is just supposed to ignore the doc string and pass the defining code through. This function is then replaced by the actual docsystem once that is available. For testing, I wanted to build the whole system image without the doc system using this boostrap definition. However, this turns out not to be possible, because there's a few doc syntax semantics that do not actually just ignore the doc string. In particular: ``` """ I am a doc for a particular signature """ foo(x::Int, y::Float64) ``` Does not acutally result in a call to `foo`. And similarly ``` """ I am a doc for a global binding """ MyModule.foo ``` Does not require `MyModule.foo` to actually have a value, since it only documents the binding. This PR allows both of those cases in the boostrap version of `atdoc` so that we can bootstrap without the doc system if we wanted to.
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.
The earliest bootstrapping code has a definition of
atdocthat is just supposed to ignore the doc string and pass the defining code through. This function is then replaced by the actual docsystem once that is available. For testing, I wanted to build the whole system image without the doc system using this boostrap definition. However, this turns out not to be possible, because there's a few doc syntax semantics that do not actually just ignore the doc string.In particular:
Does not acutally result in a call to
foo.And similarly
Does not require
MyModule.footo actually have a value, since it only documents the binding.This PR allows both of those cases in the boostrap version of
atdocso that we can bootstrap without the doc system if we wanted to.