-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
doc: intra-doc links and doc comments for build script #12133
Conversation
r? @epage (rustbot has picked a reviewer for you, use r? to override) |
5ffb807
to
762531d
Compare
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.
Feel free to merge on my behalf whether you end up fixing it or not
@@ -1,3 +1,36 @@ | |||
//! A module about how to execute a custom build script and parse its output. |
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.
Side note: If custom_build.rs
is really about build scripts, should we make that more obvious, whether thats renaming this to build_script.rs
or build_rs.rs
?
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.
Had the same thought. I could see custom build/build script/build.rs co-exist everywhere. build_script.rs
gets my vote and I can send a PR fixing all occurrences then.
762531d
to
227b2e5
Compare
@bors r=epage |
☀️ Test successful - checks-actions |
Update cargo 8 commits in 13413c64ff88dd6c2824e9eb9374fc5f10895d28..09276c703a473ab33daaeb94917232e80eefd628 2023-05-10 13:46:18 +0000 to 2023-05-16 21:43:35 +0000 - docs: Clarify that crates.io doesn't link to docs.rs right away. (rust-lang/cargo#12146) - docs(ref): Clarify MSRV is generally minor (rust-lang/cargo#12122) - Fix `check_for_file_and_add`'s check for conflict file (rust-lang/cargo#12135) - Fixes: Incorrect document link (rust-lang/cargo#12143) - doc: intra-doc links and doc comments for build script (rust-lang/cargo#12133) - Add Cargo team charter. (rust-lang/cargo#12010) - Remove useless drop of copy type (rust-lang/cargo#12136) - Fix dep/feat syntax with hidden implicit optional dependencies (rust-lang/cargo#12130) r? ghost
What does this PR try to resolve?
More docs and intra-doc links for
src/cargo/core/compiler/custom_build.rs
How should we test and review this PR?
Then proofread it!