Allow crates to opt-in to building a single target #632

jyn514 · 2020-03-07T07:23:36Z

Based off of #532, but backwards compatible.

Closes #627.

Motivation: If crates are only built on one target, I'd be much more comfortable raising limits on a case-by-case basis (e.g. #608, #616). I would also be more comfortable adding more targets (i.e. not tier 1: #563), since specifying those targets would require setting extra-targets and thereby opting out of all others.

~~Waiting on me to test that this actually works since we don't have unit tests for builds.~~ Done.

Can build from a clean cache (no .rustwide-docker directory)
Can add essential files (build add-essential-files)
Does not pass --target for proc-macros (and in general, for the default build unless default-target is explicitly set) (build crate rstest 0.4.0, testing for Missing docs for procedural macro crate #422)
Builds for cross-compiled targets work
Builds for host target work
targets behaves as documented (I only tested targets = ["x86_64-pc-windows-msvc"] and unset default-target; others are tested with unit tests)
Passing a duplicate default-target still only builds the default target once

as a side effect, only calculate metadata once instead of for each target

jyn514 · 2020-03-07T08:16:38Z

r? @pietroalbini

src/docbuilder/metadata.rs

src/docbuilder/rustwide_builder.rs

pietroalbini · 2020-03-07T10:57:45Z

src/docbuilder/metadata.rs

@@ -111,6 +120,8 @@ impl Metadata {
                        .and_then(|v| v.as_bool()).unwrap_or(metadata.all_features);
                    metadata.default_target = table.get("default-target")
                        .and_then(|v| v.as_str()).map(|v| v.to_owned());
+                    metadata.extra_targets = table.get("extra-targets").and_then(|f| f.as_array())
+                        .and_then(|f| f.iter().map(|v| v.as_str().map(|v| v.to_owned())).collect());


You don't have to do it in this PR, but it would be nice to just use #[derive(Deserialize)].

pietroalbini · 2020-03-07T10:59:27Z

Oh, also, at least for now we need to filter the targets to make sure someone doesn't use an unsupported target, and fail the build in that case.

jyn514 · 2020-03-07T12:52:35Z

Oh, also, at least for now we need to filter the targets to make sure someone doesn't use an unsupported target, and fail the build in that case.

This is our current behavior for an unsupported default-target:

2020/03/07 12:51:25 [INFO] rustwide::cmd: [stderr] error[E0463]: can't find crate for `std`
2020/03/07 12:51:25 [INFO] rustwide::cmd: [stderr]   |
2020/03/07 12:51:25 [INFO] rustwide::cmd: [stderr]   = note: the `x86_64-pc-windows-gnu` target may not be installed
2020/03/07 12:51:25 [INFO] rustwide::cmd: [stderr] 
2020/03/07 12:51:25 [INFO] rustwide::cmd: [stderr] error: aborting due to previous error
2020/03/07 12:51:25 [INFO] rustwide::cmd: [stderr] 
2020/03/07 12:51:25 [INFO] rustwide::cmd: [stderr] For more information about this error, try `rustc --explain E0463`.
2020/03/07 12:51:25 [INFO] rustwide::cmd: [stderr] error: Could not document `hexponent`.

Our behavior for an unsupported extra-target is the same, I think it doesn't need to be handled explicitly.

jyn514 · 2020-03-07T13:50:16Z

Addressed review comments.

pietroalbini · 2020-03-07T15:27:23Z

Our behavior for an unsupported extra-target is the same, I think it doesn't need to be handled explicitly.

Keep in mind that we only show the build log of the default target, so users wouldn't be able to see those errors.

jyn514 · 2020-03-07T15:32:41Z

Keep in mind that we only show the build log of the default target, so users wouldn't be able to see those errors.

Hmm, that does make it harder ... I don't want to fail the default build if one of the targets isn't installed, since that would require publishing a full point release. Maybe we could show a popup on the /crate page that says the target doesn't exist?

jyn514 · 2020-03-07T15:33:20Z

Also I plan to make a follow-up PR very shortly which will install targets dynamically so I'm not sure it's worth worrying about.

This is almost entirely untested.

jyn514 · 2020-03-10T23:59:15Z

This is ready for review.

src/docbuilder/metadata.rs

pietroalbini · 2020-03-11T17:40:31Z

Other than these two comments this looks good to be merged!

jyn514 · 2020-03-11T18:28:17Z

Addressed review comments.

QuietMisdreavus and others added 6 commits March 7, 2020 02:01

Add extra-targets to package metadata

095e673

give build_package access to metadata

0e9246c

as a side effect, only calculate metadata once instead of for each target

If env-var is set, don't build all targets

edba858

Add opt-in way to only build for specific targets

da02d0e

clean up code style

b09eb7a

Remove duplicate docs

6bc3f92

jyn514 mentioned this pull request Mar 7, 2020

Add support for more targets #563

Closed

Fix tests (and new test)

82d0f84

This comment has been minimized.

Sign in to view

jyn514 changed the title ~~[WIP] Allow crates to opt-in to building a single target~~ Allow crates to opt-in to building a single target Mar 7, 2020

pietroalbini requested changes Mar 7, 2020

View reviewed changes

jyn514 added 3 commits March 7, 2020 08:02

Separate target selection into a separate function

263a05f

select_extra_targets -> Metadata::select_extra_targets

bc88ac6

Add test for select_extra_targets

9eae896

jyn514 added 5 commits March 8, 2020 21:49

Use first target in extra-targets if default-target is unset

8a3ed3c

This is almost entirely untested.

DEFAULT_TARGET -> HOST_TARGET

01f159e

Fix up tests

cb8cac4

cleanup

18e1046

Add more tests

c9bffa8

jyn514 changed the title ~~Allow crates to opt-in to building a single target~~ [WIP] Allow crates to opt-in to building a single target Mar 9, 2020

jyn514 force-pushed the opt-in-single-target branch from 802e4c0 to 591eaf2 Compare March 9, 2020 02:35

extra-targets -> targets and add documentation

e06990b

jyn514 force-pushed the opt-in-single-target branch from 591eaf2 to e06990b Compare March 9, 2020 02:36

jyn514 added 2 commits March 8, 2020 22:37

Fix reading wrong key in manifest

2761acb

formatting

ff96849

jyn514 force-pushed the opt-in-single-target branch from c89044e to ff96849 Compare March 9, 2020 02:42

extra targets -> targets in comments

43c24c7

jyn514 changed the title ~~[WIP] Allow crates to opt-in to building a single target~~ Allow crates to opt-in to building a single target Mar 10, 2020

jyn514 mentioned this pull request Mar 11, 2020

Allow non-tier-one targets to be built #633

Merged

pietroalbini reviewed Mar 11, 2020

View reviewed changes

src/docbuilder/metadata.rs Outdated Show resolved Hide resolved

src/docbuilder/metadata.rs Outdated Show resolved Hide resolved

Use BuildTargets and simplify implementation

f4ff030

Remove out-of-date comment

3a41224

pietroalbini approved these changes Mar 14, 2020

View reviewed changes

jyn514 merged commit e30c54b into rust-lang:master Mar 14, 2020

jyn514 deleted the opt-in-single-target branch March 14, 2020 19:12

jyn514 mentioned this pull request Mar 14, 2020

stop building crates on all targets #343

Closed

This was referenced Mar 15, 2020

Sandbox limits increase request for stm32 family crates #608

Closed

Sandbox limits increase request for stm32ral #616

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow crates to opt-in to building a single target #632

Allow crates to opt-in to building a single target #632

jyn514 commented Mar 7, 2020 •

edited

Loading

This comment has been minimized.

jyn514 commented Mar 7, 2020

pietroalbini Mar 7, 2020

pietroalbini commented Mar 7, 2020

jyn514 commented Mar 7, 2020

jyn514 commented Mar 7, 2020

pietroalbini commented Mar 7, 2020

jyn514 commented Mar 7, 2020

jyn514 commented Mar 7, 2020

jyn514 commented Mar 10, 2020

pietroalbini commented Mar 11, 2020

jyn514 commented Mar 11, 2020

Allow crates to opt-in to building a single target #632

Allow crates to opt-in to building a single target #632

Conversation

jyn514 commented Mar 7, 2020 • edited Loading

This comment has been minimized.

jyn514 commented Mar 7, 2020

pietroalbini Mar 7, 2020

Choose a reason for hiding this comment

pietroalbini commented Mar 7, 2020

jyn514 commented Mar 7, 2020

jyn514 commented Mar 7, 2020

pietroalbini commented Mar 7, 2020

jyn514 commented Mar 7, 2020

jyn514 commented Mar 7, 2020

jyn514 commented Mar 10, 2020

pietroalbini commented Mar 11, 2020

jyn514 commented Mar 11, 2020

jyn514 commented Mar 7, 2020 •

edited

Loading