Extend the build directive syntax with `cargo::` #12201

hi-rustin · 2023-05-30T00:23:10Z

What does this PR try to resolve?

close #11461

Extend the build directive syntax with cargo:: and update tests and docs.

How should we test and review this PR?

Check out the unit tests.

rustbot · 2023-05-30T00:23:15Z

r? @weihanglo

(rustbot has picked a reviewer for you, use r? to override)

src/doc/src/reference/build-scripts.md

hi-rustin

A lot of code and docs need to update. I will update it later.

tests/testsuite/build_script.rs

src/cargo/core/compiler/custom_build.rs

hi-rustin

update other error messages
update other docs
add more tests

src/cargo/core/compiler/custom_build.rs

Signed-off-by: hi-rustin <rustin.liu@gmail.com>

epage · 2023-12-24T03:05:35Z

Thanks!

@bors r+

bors · 2023-12-24T03:05:38Z

📌 Commit dec9e8c has been approved by epage

It is now in the queue for this repository.

bors · 2023-12-24T03:06:45Z

⌛ Testing commit dec9e8c with merge d45969a...

bors · 2023-12-24T03:34:00Z

☀️ Test successful - checks-actions
Approved by: epage
Pushing d45969a to master...

hi-rustin · 2023-12-24T14:27:30Z

Thanks for your review! 💚 💙 💜 💛 ❤️

weihanglo · 2023-12-24T15:14:27Z

Just thought of target.<triple>.<links>. The TOML table accepts arbitrary keys as metadata keys. Should we also extend the format?

cargo/src/cargo/util/config/target.rs

Lines 225 to 228 in 74ef21b

    
           _ => { 
        
               let val = value.string(key)?.0; 
        
               output.metadata.push((key.clone(), val.to_string())); 
        
           }

hi-rustin · 2023-12-25T01:56:57Z

Should we also extend the format?

Do you mean we should add a prefix to those metadata keys? For instance: metadata-KEY = VALUE.

It seems that the purpose of this is just to override rustc configurations. Therefore, I'm unsure if we need to support it here.

cargo/src/cargo/util/config/target.rs

Line 223 in 74ef21b

anyhow::bail!("`{}` is not supported in build script overrides", key);

weihanglo · 2023-12-25T02:30:44Z

I mean, it is definitely a breaking change if we want to extend more keys to override from build scripts. Actually #10274 may break stuff if people already used key like rustc-link-arg-tests as a metadata key (which is rare).

Huh… maybe it's too hard and not worthy of a transition.

Update cargo 7 commits in 363a2d11320faf531f6aacd1ea067c6bc08343b9..ac6bbb33293d8d424c17ecdb42af3aac25fb7295 2023-12-22 03:12:42 +0000 to 2023-12-26 23:22:08 +0000 - docs: fix link to nightly doc of cargo-util-schemas (rust-lang/cargo#13209) - doc: improve word usage (rust-lang/cargo#13206) - fix: clarify `--path` is the installation source not destination (rust-lang/cargo#13205) - refactor: give some better examples for package ID spec (rust-lang/cargo#13202) - chore: fix a typo (rust-lang/cargo#13201) - Extend the build directive syntax with `cargo::` (rust-lang/cargo#12201) - Rework `--check-cfg` generation comment (rust-lang/cargo#13195) r? ghost

epage · 2023-12-27T18:42:14Z

I created #13211 to track this

Add cargo:rustc-cdylib-link-arg into RESERVED_PREFIXES list After #12201 was merged, the `cargo:rustc-cdylib-link-arg` in build script no longer works ```rs println!("cargo:rustc-cdylib-link-arg=-Wl"); println!("cargo:rustc-cdylib-link-arg=-undefined"); println!("cargo:rustc-cdylib-link-arg=dynamic_lookup"); ```

Pkgsrc changes: * Adapt checksums and patches. Upstream chnages: Version 1.77.0 (2024-03-21) ========================== - [Reveal opaque types within the defining body for exhaustiveness checking.] (rust-lang/rust#116821) - [Stabilize C-string literals.] (rust-lang/rust#117472) - [Stabilize THIR unsafeck.] (rust-lang/rust#117673) - [Add lint `static_mut_refs` to warn on references to mutable statics.] (rust-lang/rust#117556) - [Support async recursive calls (as long as they have indirection).] (rust-lang/rust#117703) - [Undeprecate lint `unstable_features` and make use of it in the compiler.] (rust-lang/rust#118639) - [Make inductive cycles in coherence ambiguous always.] (rust-lang/rust#118649) - [Get rid of type-driven traversal in const-eval interning] (rust-lang/rust#119044), only as a [future compatiblity lint] (rust-lang/rust#122204) for now. - [Deny braced macro invocations in let-else.] (rust-lang/rust#119062) Compiler -------- - [Include lint `soft_unstable` in future breakage reports.] (rust-lang/rust#116274) - [Make `i128` and `u128` 16-byte aligned on x86-based targets.] (rust-lang/rust#116672) - [Use `--verbose` in diagnostic output.] (rust-lang/rust#119129) - [Improve spacing between printed tokens.] (rust-lang/rust#120227) - [Merge the `unused_tuple_struct_fields` lint into `dead_code`.] (rust-lang/rust#118297) - [Error on incorrect implied bounds in well-formedness check] (rust-lang/rust#118553), with a temporary exception for Bevy. - [Fix coverage instrumentation/reports for non-ASCII source code.] (rust-lang/rust#119033) - [Fix `fn`/`const` items implied bounds and well-formedness check.] (rust-lang/rust#120019) - [Promote `riscv32{im|imafc}-unknown-none-elf` targets to tier 2.] (rust-lang/rust#118704) - Add several new tier 3 targets: - [`aarch64-unknown-illumos`] (rust-lang/rust#112936) - [`hexagon-unknown-none-elf`] (rust-lang/rust#117601) - [`riscv32imafc-esp-espidf`] (rust-lang/rust#119738) - [`riscv32im-risc0-zkvm-elf`] (rust-lang/rust#117958) Refer to Rust's [platform support page][platform-support-doc] for more information on Rust's tiered platform support. Libraries --------- - [Implement `From<&[T; N]>` for `Cow<[T]>`.] (rust-lang/rust#113489) - [Remove special-case handling of `vec.split_off (0)`.](rust-lang/rust#119917) Stabilized APIs --------------- - [`array::each_ref`] (https://doc.rust-lang.org/stable/std/primitive.array.html#method.each_ref) - [`array::each_mut`] (https://doc.rust-lang.org/stable/std/primitive.array.html#method.each_mut) - [`core::net`] (https://doc.rust-lang.org/stable/core/net/index.html) - [`f32::round_ties_even`] (https://doc.rust-lang.org/stable/std/primitive.f32.html#method.round_ties_even) - [`f64::round_ties_even`] (https://doc.rust-lang.org/stable/std/primitive.f64.html#method.round_ties_even) - [`mem::offset_of!`] (https://doc.rust-lang.org/stable/std/mem/macro.offset_of.html) - [`slice::first_chunk`] (https://doc.rust-lang.org/stable/std/primitive.slice.html#method.first_chunk) - [`slice::first_chunk_mut`] (https://doc.rust-lang.org/stable/std/primitive.slice.html#method.first_chunk_mut) - [`slice::split_first_chunk`] (https://doc.rust-lang.org/stable/std/primitive.slice.html#method.split_first_chunk) - [`slice::split_first_chunk_mut`] (https://doc.rust-lang.org/stable/std/primitive.slice.html#method.split_first_chunk_mut) - [`slice::last_chunk`] (https://doc.rust-lang.org/stable/std/primitive.slice.html#method.last_chunk) - [`slice::last_chunk_mut`] (https://doc.rust-lang.org/stable/std/primitive.slice.html#method.last_chunk_mut) - [`slice::split_last_chunk`] (https://doc.rust-lang.org/stable/std/primitive.slice.html#method.split_last_chunk) - [`slice::split_last_chunk_mut`] (https://doc.rust-lang.org/stable/std/primitive.slice.html#method.split_last_chunk_mut) - [`slice::chunk_by`] (https://doc.rust-lang.org/stable/std/primitive.slice.html#method.chunk_by) - [`slice::chunk_by_mut`] (https://doc.rust-lang.org/stable/std/primitive.slice.html#method.chunk_by_mut) - [`Bound::map`] (https://doc.rust-lang.org/stable/std/ops/enum.Bound.html#method.map) - [`File::create_new`] (https://doc.rust-lang.org/stable/std/fs/struct.File.html#method.create_new) - [`Mutex::clear_poison`] (https://doc.rust-lang.org/stable/std/sync/struct.Mutex.html#method.clear_poison) - [`RwLock::clear_poison`] (https://doc.rust-lang.org/stable/std/sync/struct.RwLock.html#method.clear_poison) Cargo ----- - [Extend the build directive syntax with `cargo::`.] (rust-lang/cargo#12201) - [Stabilize metadata `id` format as `PackageIDSpec`.] (rust-lang/cargo#12914) - [Pull out as `cargo-util-schemas` as a crate.] (rust-lang/cargo#13178) - [Strip all debuginfo when debuginfo is not requested.] (rust-lang/cargo#13257) - [Inherit jobserver from env for all kinds of runners.] (rust-lang/cargo#12776) - [Deprecate rustc plugin support in cargo.] (rust-lang/cargo#13248) Rustdoc ----- - [Allows links in markdown headings.] (rust-lang/rust#117662) - [Search for tuples and unit by type with `()`.] (rust-lang/rust#118194) - [Clean up the source sidebar's hide button.] (rust-lang/rust#119066) - [Prevent JS injection from `localStorage`.] (rust-lang/rust#120250) Misc ---- - [Recommend version-sorting for all sorting in style guide.] (rust-lang/rust#115046) Internal Changes ---------------- These changes do not affect any public interfaces of Rust, but they represent significant improvements to the performance or internals of rustc and related tools. - [Add more weirdness to `weird-exprs.rs`.] (rust-lang/rust#119028)

rustbot assigned weihanglo May 30, 2023

rustbot added A-build-scripts Area: build.rs scripts S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. A-documenting-cargo-itself Area: Cargo's documentation labels May 30, 2023

hi-rustin marked this pull request as draft May 30, 2023 00:43

epage reviewed May 30, 2023

View reviewed changes

src/doc/src/reference/build-scripts.md Outdated Show resolved Hide resolved

hi-rustin commented May 30, 2023

View reviewed changes

epage reviewed May 30, 2023

View reviewed changes

tests/testsuite/build_script.rs Show resolved Hide resolved

epage reviewed May 30, 2023

View reviewed changes

src/cargo/core/compiler/custom_build.rs Outdated Show resolved Hide resolved

hi-rustin force-pushed the rustin-patch-build-script branch 5 times, most recently from 4ea02bb to 9ad93ad Compare May 31, 2023 01:29

hi-rustin changed the title ~~Extend the build directive syntax with cargo::~~ WIP: Extend the build directive syntax with cargo:: May 31, 2023

hi-rustin force-pushed the rustin-patch-build-script branch 4 times, most recently from b8adc79 to 1d703a0 Compare June 2, 2023 01:41

hi-rustin commented Jun 2, 2023

View reviewed changes

epage reviewed Jun 2, 2023

View reviewed changes

src/cargo/core/compiler/custom_build.rs Outdated Show resolved Hide resolved

hi-rustin force-pushed the rustin-patch-build-script branch 6 times, most recently from 83ae1a8 to eabea47 Compare June 4, 2023 03:53

hi-rustin force-pushed the rustin-patch-build-script branch 2 times, most recently from b8fd7b3 to 8f917ce Compare June 11, 2023 07:31

hi-rustin added 3 commits December 23, 2023 13:17

Update other tests to use cargo:: syntax

ed9dc44

Signed-off-by: hi-rustin <rustin.liu@gmail.com>

Update other docs to use cargo:: syntax

eac79ec

Signed-off-by: hi-rustin <rustin.liu@gmail.com>

Update the dirty reason message

a76564b

Signed-off-by: hi-rustin <rustin.liu@gmail.com>

hi-rustin force-pushed the rustin-patch-build-script branch from bd9b7ab to 5597407 Compare December 23, 2023 05:18

hi-rustin added 2 commits December 23, 2023 13:24

Add msrv check for new syntax

0e42a8a

Signed-off-by: hi-rustin <rustin.liu@gmail.com>

Add tests for msrv check

dec9e8c

Signed-off-by: hi-rustin <rustin.liu@gmail.com>

hi-rustin force-pushed the rustin-patch-build-script branch from 5597407 to dec9e8c Compare December 23, 2023 05:25

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 24, 2023

epage mentioned this pull request Dec 24, 2023

Presentation of build script errors is noisy, difficult to understand #10159

Open

bors merged commit d45969a into rust-lang:master Dec 24, 2023
20 checks passed

hi-rustin deleted the rustin-patch-build-script branch December 24, 2023 14:27

weihanglo mentioned this pull request Dec 27, 2023

Update cargo rust-lang/rust#119334

Merged

rustbot added this to the 1.77.0 milestone Dec 27, 2023

epage mentioned this pull request Dec 27, 2023

Extend config to use metadata keys, like build script directives #13211

Open

Brooooooklyn mentioned this pull request Dec 28, 2023

Add cargo:rustc-cdylib-link-arg into RESERVED_PREFIXES list #13212

Merged

weihanglo mentioned this pull request Mar 11, 2024

fix(doc): syntax of rustc-check-cfg instruction #13573

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extend the build directive syntax with `cargo::` #12201

Extend the build directive syntax with `cargo::` #12201

hi-rustin commented May 30, 2023

rustbot commented May 30, 2023

hi-rustin left a comment

hi-rustin left a comment •

edited

epage commented Dec 24, 2023

bors commented Dec 24, 2023

bors commented Dec 24, 2023

bors commented Dec 24, 2023

hi-rustin commented Dec 24, 2023

weihanglo commented Dec 24, 2023 •

edited

hi-rustin commented Dec 25, 2023

weihanglo commented Dec 25, 2023

epage commented Dec 27, 2023

Extend the build directive syntax with cargo:: #12201

Extend the build directive syntax with cargo:: #12201

Conversation

hi-rustin commented May 30, 2023

What does this PR try to resolve?

How should we test and review this PR?

rustbot commented May 30, 2023

hi-rustin left a comment

Choose a reason for hiding this comment

hi-rustin left a comment • edited

Choose a reason for hiding this comment

epage commented Dec 24, 2023

bors commented Dec 24, 2023

bors commented Dec 24, 2023

bors commented Dec 24, 2023

hi-rustin commented Dec 24, 2023

weihanglo commented Dec 24, 2023 • edited

hi-rustin commented Dec 25, 2023

weihanglo commented Dec 25, 2023

epage commented Dec 27, 2023

Extend the build directive syntax with `cargo::` #12201

Extend the build directive syntax with `cargo::` #12201

hi-rustin left a comment •

edited

weihanglo commented Dec 24, 2023 •

edited