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

Simplify code and output of skipped_examples warning

Browse Source
This commit is contained in:
Will Crichton 2022-12-22 12:37:11 -08:00
parent 6b9a28eb21
commit 1c4065c52e
2 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/cargo/ops/cargo_compile/unit_generator.rs
View File

@ -459,7 +459,7 @@ impl<'a> UnitGenerator<'a, '_> {
.map(|u| &u.pkg)
.collect::<HashSet<_>>();
let skipped_examples: RefCell<Vec<Target>> = RefCell::new(Vec::new());
let skipped_examples = RefCell::new(Vec::new());
let can_scrape = |target: &Target| {
match (target.doc_scrape_examples(), target.is_example()) {
// Targets configured by the user to not be scraped should never be scraped
@ -470,7 +470,9 @@ impl<'a> UnitGenerator<'a, '_> {
// it's guaranteed not to break the build
(RustdocScrapeExamples::Unset, true) => {
if !safe_to_scrape_example_targets {
skipped_examples.borrow_mut().push(target.clone());
skipped_examples
.borrow_mut()
.push(target.name().to_string());
}
safe_to_scrape_example_targets
}
@ -485,11 +487,7 @@ impl<'a> UnitGenerator<'a, '_> {
let skipped_examples = skipped_examples.into_inner();
if !skipped_examples.is_empty() {
let mut shell = self.ws.config().shell();
let example_str = skipped_examples
.into_iter()
.map(|t| t.description_named())
.collect::<Vec<_>>()
.join(", ");
let example_str = skipped_examples.join(", ");
shell.warn(format!(
"\
Rustdoc did not scrape the following examples because they require dev-dependencies: {example_str}

2
tests/testsuite/docscrape.rs
View File

@ -464,7 +464,7 @@ fn no_scrape_with_dev_deps() {
.masquerade_as_nightly_cargo(&["rustdoc-scrape-examples"])
.with_stderr(
"\
warning: Rustdoc did not scrape the following examples because they require dev-dependencies: example \"ex\"
warning: Rustdoc did not scrape the following examples because they require dev-dependencies: ex
If you want Rustdoc to scrape these examples, then add `doc-scrape-examples = true`
to the [[example]] target configuration of at least one example.
[DOCUMENTING] foo v0.0.1 ([CWD])