-
Notifications
You must be signed in to change notification settings - Fork 196
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.
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
docs: better bootstrapping xp #11124
Merged
davidwengier
merged 5 commits into
dotnet:main
from
earloc:docs/better-bootstrapping-xp
Oct 31, 2024
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
ee96fe7
doc: mention need for 'long-path'-support
earloc e6ce7ae
docs: format to better spot command-lines to execute while bootstrappin'
earloc 165d416
docs: explain how to potentially get rid of `path-too-long`-errors
earloc 191e62e
fix: duplicate newline as error
earloc f40133a
Update docs/contributing/BuildFromSource.md
earloc File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if instead we should add a reg file like roslyn has https://github.com/dotnet/roslyn/blob/main/eng/enable-long-paths.reg
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, this variant just got me starting to be actually be able to work with this repo.
Might as well not "fix" the issue, if pathes got any longer - but did the trick in the meantime (as only two files exceded the path-length for me).
Relying on a registry setting might put some additional burden on potential contributors, even if this "seems" to be safely applicable on modern-ish versions of the OS, though. But then, having someone need to apply an (unknown) registry-key import might not benefit overall acceptancy when starting to contribute...so maybe we could just leave a hint to the link you provided? Maybe the roslyn-project has some notes on that in their docs, which we could refer to...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems logical to me that if we tell people to enable long paths in git, we should tell them to do it for Windows too. Roslyn also has this to detect and warn on build, which we should crib:
https://github.com/dotnet/roslyn/blob/9e862f15fc4d57a479ac45724748a41c87a7d0b6/eng/targets/Imports.targets#L164-L170
BUT I don't see any reason that any of that should hold up a docs update
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As far as I understand, roslyn "needs" long-paths to be enabled at build time:
https://github.com/dotnet/roslyn/blob/697989601cb5319af38ca7c36d8727875c4f49c4/eng/targets/Imports.targets#L164C2-L170C13
I´ve got the feeling that this
warning
might get easily overlooked...but seems more straight forward / error-proof than relying on s.th. likesubst
.I'll revisit this part, stay tuned...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Roslyn recommends it and checks in their builds https://github.com/dotnet/roslyn/blob/9e862f15fc4d57a479ac45724748a41c87a7d0b6/eng/targets/Imports.targets#L169
@jaredpar have you heard of any potential burden for contributors?
I'm fine with recommending both as an option since it's to unblock people in a way that they're comfortable with. Alternative to a reg file we could add the powershell equivalent
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "burden" is just anticipated, as I personally faced it while trying to contribute ;)
I`ll think about how this could be integrated in a way, which would ease up the first-time experience when working with the repo, cool?