itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-09-28 11:20:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(build-rs): Correct documentation for manifest_links

Browse Source
This commit is contained in:
Ed Page 2024-11-13 12:43:26 -06:00
parent eef4b30d31
commit e4e7a36eaa
1 changed files with 1 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
crates/build-rs/src/input.rs
View File

@ -106,16 +106,7 @@ pub fn cargo_manifest_dir() -> PathBuf {
get_path("CARGO_MANIFEST_DIR")
}
/// Contains parameters needed for Cargo’s [jobserver] implementation to parallelize
/// subprocesses.
///
/// Rustc or cargo invocations from build.rs can already read
/// `CARGO_MAKEFLAGS`, but GNU Make requires the flags to be specified either
/// directly as arguments, or through the `MAKEFLAGS` environment variable.
/// Currently Cargo doesn’t set the `MAKEFLAGS` variable, but it’s free for build
/// scripts invoking GNU Make to set it to the contents of `CARGO_MAKEFLAGS`.
///
/// [jobserver]: https://www.gnu.org/software/make/manual/html_node/Job-Slots.html
/// The manifest `links` value.
#[track_caller]
pub fn cargo_manifest_links() -> Option<String> {
get_opt_str("CARGO_MANIFEST_LINKS")