Skip to content
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

Document how x.py works #248

Closed
mark-i-m opened this issue Dec 3, 2018 · 7 comments
Closed

Document how x.py works #248

mark-i-m opened this issue Dec 3, 2018 · 7 comments
Labels
E-help-wanted Call for participation: extra help is wanted E-medium Difficulty: might require some prior knowledge or code reading

Comments

@mark-i-m
Copy link
Member

mark-i-m commented Dec 3, 2018

https://internals.rust-lang.org/t/compiling-rustc-with-non-standard-flags/8950/3

@mark-i-m mark-i-m added E-help-wanted Call for participation: extra help is wanted E-medium Difficulty: might require some prior knowledge or code reading labels Jan 23, 2019
@jyn514
Copy link
Member

jyn514 commented Apr 3, 2021

@mark-i-m do you think https://rustc-dev-guide.rust-lang.org/building/bootstrapping.html answers this well enough? Or was there something more you wanted to document?

@mark-i-m
Copy link
Member Author

mark-i-m commented Apr 6, 2021

I think my intent was more related to how x.py is implemented and how to hack on it...

@mark-i-m
Copy link
Member Author

mark-i-m commented Apr 7, 2021

Perhaps? Or else move that readme to a short chapter in the guide. Not sure...

@jyn514
Copy link
Member

jyn514 commented Apr 7, 2021

@Mark-Simulacrum do you have opinions on whether this should be documented in the dev-guide or in-tree?

@Mark-Simulacrum
Copy link
Member

Open to either; rustc-dev-guide is somewhat less likely to receive updates. x.py is not that complicated itself, just is incredibly stateful (filesystem), so that pretty significantly increases complexity of changing it. Not sure what kind of docs are intended here.

@jyn514
Copy link
Member

jyn514 commented Mar 26, 2023

This looks roughly the same as rust-lang/rust#90686 to me; I'm going to close it since the other issue was also closed (the documentation now lives in-tree in src/bootstrap/README.md).

Happy to add more docs but I think we should use a more specific issue for that.

@jyn514 jyn514 closed this as completed Mar 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E-help-wanted Call for participation: extra help is wanted E-medium Difficulty: might require some prior knowledge or code reading
Projects
None yet
Development

No branches or pull requests

3 participants