doc: Update build script examples to use build-rs#16592
Open
hksama wants to merge 1 commit intorust-lang:masterfrom
Open
doc: Update build script examples to use build-rs#16592hksama wants to merge 1 commit intorust-lang:masterfrom
hksama wants to merge 1 commit intorust-lang:masterfrom
Conversation
rustbot
added
A-documenting-cargo-itself
Collaborator
epage
reviewed
Feb 5, 2026
epage
reviewed
Feb 5, 2026
epage
reviewed
Feb 5, 2026
epage
reviewed
Feb 5, 2026
| " | ||
| ).unwrap(); | ||
| println!("cargo::rerun-if-changed=build.rs"); | ||
| build_rs::output::rerun_if_changed("build.rs"); |
Contributor
There was a problem hiding this comment.
A couple lines above OUT_DIR is read and could instead use out_dir()
epage
reviewed
Feb 5, 2026
| edition = "2024" | ||
|
|
||
| [build-dependencies] | ||
| build-rs= "0.3.0" |
Contributor
There was a problem hiding this comment.
Suggested change
| build-rs= "0.3.0" | |
| build-rs = "0.3.0" |
epage
reviewed
Feb 5, 2026
| edition = "2024" | ||
|
|
||
| [build-dependencies] | ||
| build-rs= "0.3.0" |
Contributor
There was a problem hiding this comment.
With this being in the docs, how are we going to keep it up-to-date?
epage
reviewed
Feb 5, 2026
| println!("cargo::rustc-link-search=native={}", out_dir); | ||
| println!("cargo::rustc-link-lib=static=hello"); | ||
| println!("cargo::rerun-if-changed=src/hello.c"); | ||
| build_rs::output::rustc_link_search(out_dir); |
Contributor
There was a problem hiding this comment.
Shouldn't this be rustc_link_search_kind?
epage
reviewed
Feb 5, 2026
| ```toml | ||
| [build-dependencies] | ||
| cc = "1.0" | ||
| build-rs= "0.3.0" |
Contributor
There was a problem hiding this comment.
Suggested change
| build-rs= "0.3.0" | |
| build-rs = "0.3.0" |
epage
reviewed
Feb 5, 2026
| println!("cargo::rustc-link-search=native={}", out_dir); | ||
| println!("cargo::rustc-link-lib=static=hello"); | ||
| println!("cargo::rerun-if-changed=src/hello.c"); | ||
| build_rs::output::rustc_link_search(out_dir); |
epage
reviewed
Feb 5, 2026
| } | ||
| cfg.compile("z_user"); | ||
| println!("cargo::rerun-if-changed=src/z_user.c"); | ||
| build_rs::output::rerun_if_changed("src/z_user.c"); |
Contributor
There was a problem hiding this comment.
Shouldn't we use dep_metadata for DEP_Z_INCLUDE?
epage
reviewed
Feb 5, 2026
Comment on lines
+477
to
+478
| build_rs::output::rustc_check_cfgs(&["ossl101","ossl102",]); | ||
| build_rs::output::rustc_check_cfgs(&["ossl110","ossl110g","ossl111",]); |
Contributor
There was a problem hiding this comment.
Please clean up the code style
epage
reviewed
Feb 5, 2026
| For historical reasons, the `cargo::rustc-cdylib-link-arg` form is an alias | ||
| for `cargo::rustc-link-arg-cdylib`, and has the same meaning. | ||
|
|
||
| **Recommended:** Use [`build_rs::output::rustc_cdylib_link_arg`](https://docs.rs/build-rs/0.3.3/build_rs/output/fn.rustc_cdylib_link_arg.html) from the `build-rs` crate. |
Contributor
There was a problem hiding this comment.
We don't need to recommend this under every entry
epage
reviewed
Feb 5, 2026
Comment on lines
+27
to
+34
| > **Note** | ||
| > Build scripts communicate with Cargo by printing specially formatted lines to stdout. | ||
| > While you can print these lines manually (e.g., `println!("cargo::rerun-if-changed=build.rs")`), | ||
| > we recommend using the [`build-rs`](https://crates.io/crates/build-rs) crate. | ||
| > It provides a type-safe API that ensures your build instructions are formatted correctly. | ||
| > | ||
| > The examples in this reference guide use `build-rs` to demonstrate best practices, | ||
| > while the section headers preserve the raw protocol strings for specification purposes. |
Contributor
There was a problem hiding this comment.
This is partly covered under " Life Cycle of a Build Script". Seems like adding a note about build-rs being an API for this to that would be cleaner
epage
reviewed
Feb 5, 2026
| fn main() { | ||
| // Tell Cargo that if the given file changes, to rerun this build script. | ||
| println!("cargo::rerun-if-changed=src/hello.c"); | ||
| //recommended method(using the build_rs crate) |
Contributor
There was a problem hiding this comment.
This comment doesn't quite read correctly to me
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Title: doc: Update build script examples to use build-rs
Description:
Updates the build script documentation to recommend the build-rs crate, as discussed in #15567.
Changes
Added a Note recommending build-rs for type safety in build-scripts.md.
Updated examples in build-script-examples.md to use build_rs::output::... functions instead of raw println! macros.
Preserved raw protocol strings in section headers for specification reference.
Relates to #15567.
Ready for FCP review.