Skip to content

Commit f639d38

Browse files
alexcrichtonalexcrichton
committed
Add support for RUSTDOCFLAGS
Like with RUSTFLAGS, parse this variable to pass along extra arguments to invocations of `rustdoc`.
1 parent 4ba8264 commit f639d38

File tree

4 files changed

+112
-12
lines changed

4 files changed

+112
-12
lines changed

‎src/cargo/ops/cargo_rustc/context.rs

+18-7
Original file line numberDiff line numberDiff line change
@@ -160,11 +160,15 @@ impl<'a, 'cfg> Context<'a, 'cfg> {
160160
crate_types: &BTreeSet<String>,
161161
kind: Kind)
162162
-> CargoResult<()> {
163+
let rustflags = try!(env_args(self.config,
164+
&self.build_config,
165+
kind,
166+
"RUSTFLAGS"));
163167
let mut process = util::process(self.config.rustc());
164168
process.arg("-")
165169
.arg("--crate-name").arg("_")
166170
.arg("--print=file-names")
167-
.args(&try!(rustflags_args(self.config, &self.build_config, kind)))
171+
.args(&rustflags)
168172
.env_remove("RUST_LOG");
169173

170174
for crate_type in crate_types {
@@ -644,7 +648,11 @@ impl<'a, 'cfg> Context<'a, 'cfg> {
644648
}
645649

646650
pub fn rustflags_args(&self, unit: &Unit) -> CargoResult<Vec<String>> {
647-
rustflags_args(self.config, &self.build_config, unit.kind)
651+
env_args(self.config, &self.build_config, unit.kind, "RUSTFLAGS")
652+
}
653+
654+
pub fn rustdocflags_args(&self, unit: &Unit) -> CargoResult<Vec<String>> {
655+
env_args(self.config, &self.build_config, unit.kind, "RUSTDOCFLAGS")
648656
}
649657

650658
pub fn show_warnings(&self, pkg: &PackageId) -> bool {
@@ -655,9 +663,10 @@ impl<'a, 'cfg> Context<'a, 'cfg> {
655663

656664
// Acquire extra flags to pass to the compiler from the
657665
// RUSTFLAGS environment variable and similar config values
658-
fn rustflags_args(config: &Config,
659-
build_config: &BuildConfig,
660-
kind: Kind) -> CargoResult<Vec<String>> {
666+
fn env_args(config: &Config,
667+
build_config: &BuildConfig,
668+
kind: Kind,
669+
name: &str) -> CargoResult<Vec<String>> {
661670
// We *want* to apply RUSTFLAGS only to builds for the
662671
// requested target architecture, and not to things like build
663672
// scripts and plugins, which may be for an entirely different
@@ -688,7 +697,7 @@ fn rustflags_args(config: &Config,
688697
}
689698

690699
// First try RUSTFLAGS from the environment
691-
if let Some(a) = env::var("RUSTFLAGS").ok() {
700+
if let Some(a) = env::var(name).ok() {
692701
let args = a.split(" ")
693702
.map(str::trim)
694703
.filter(|s| !s.is_empty())
@@ -697,7 +706,9 @@ fn rustflags_args(config: &Config,
697706
}
698707

699708
// Then the build.rustflags value
700-
if let Some(args) = try!(config.get_list("build.rustflags")) {
709+
let name = name.chars().flat_map(|c| c.to_lowercase()).collect::<String>();
710+
let key = format!("build.{}", name);
711+
if let Some(args) = try!(config.get_list(&key)) {
701712
let args = args.val.into_iter().map(|a| a.0);
702713
return Ok(args.collect());
703714
}

‎src/cargo/ops/cargo_rustc/fingerprint.rs

+6-1
Original file line numberDiff line numberDiff line change
@@ -346,6 +346,11 @@ fn calculate<'a, 'cfg>(cx: &mut Context<'a, 'cfg>, unit: &Unit<'a>)
346346
};
347347
let mut deps = deps;
348348
deps.sort_by(|&(ref a, _), &(ref b, _)| a.cmp(b));
349+
let extra_flags = if unit.profile.doc {
350+
try!(cx.rustdocflags_args(unit))
351+
} else {
352+
try!(cx.rustflags_args(unit))
353+
};
349354
let fingerprint = Arc::new(Fingerprint {
350355
rustc: util::hash_u64(&cx.config.rustc_info().verbose_version),
351356
target: util::hash_u64(&unit.target),
@@ -354,7 +359,7 @@ fn calculate<'a, 'cfg>(cx: &mut Context<'a, 'cfg>, unit: &Unit<'a>)
354359
deps: deps,
355360
local: local,
356361
memoized_hash: Mutex::new(None),
357-
rustflags: try!(cx.rustflags_args(unit)),
362+
rustflags: extra_flags,
358363
});
359364
cx.fingerprints.insert(*unit, fingerprint.clone());
360365
Ok(fingerprint)

‎src/cargo/ops/cargo_rustc/mod.rs

+3-4
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ fn rustc(cx: &mut Context, unit: &Unit) -> CargoResult<Work> {
245245
let dep_info_loc = fingerprint::dep_info_loc(cx, unit);
246246
let cwd = cx.config.cwd().to_path_buf();
247247

248-
let rustflags = try!(cx.rustflags_args(unit));
248+
rustc.args(&try!(cx.rustflags_args(unit)));
249249

250250
return Ok(Work::new(move |state| {
251251
// Only at runtime have we discovered what the extra -L and -l
@@ -269,9 +269,6 @@ fn rustc(cx: &mut Context, unit: &Unit) -> CargoResult<Work> {
269269
}
270270
}
271271

272-
// Add the arguments from RUSTFLAGS
273-
rustc.args(&rustflags);
274-
275272
state.running(&rustc);
276273
try!(exec_engine.exec(rustc).chain_error(|| {
277274
human(format!("Could not compile `{}`.", name))
@@ -405,6 +402,8 @@ fn rustdoc(cx: &mut Context, unit: &Unit) -> CargoResult<Work> {
405402
.build_out(unit.pkg));
406403
}
407404

405+
rustdoc.args(&try!(cx.rustdocflags_args(unit)));
406+
408407
let name = unit.pkg.name().to_string();
409408
let build_state = cx.build_state.clone();
410409
let key = (unit.pkg.package_id().clone(), unit.kind);

‎tests/rustdocflags.rs

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
extern crate cargotest;
2+
extern crate hamcrest;
3+
4+
use cargotest::support::{project, execs};
5+
use hamcrest::assert_that;
6+
7+
#[test]
8+
fn parses_env() {
9+
let p = project("foo")
10+
.file("Cargo.toml", r#"
11+
[package]
12+
name = "foo"
13+
version = "0.0.1"
14+
authors = []
15+
"#)
16+
.file("src/lib.rs", "");
17+
p.build();
18+
19+
assert_that(p.cargo("doc").env("RUSTDOCFLAGS", "--cfg=foo").arg("-v"),
20+
execs().with_status(0)
21+
.with_stderr_contains("\
22+
[RUNNING] `rustdoc [..] --cfg=foo[..]`
23+
"));
24+
}
25+
26+
#[test]
27+
fn parses_config() {
28+
let p = project("foo")
29+
.file("Cargo.toml", r#"
30+
[package]
31+
name = "foo"
32+
version = "0.0.1"
33+
authors = []
34+
"#)
35+
.file("src/lib.rs", "")
36+
.file(".cargo/config", r#"
37+
[build]
38+
rustdocflags = ["--cfg", "foo"]
39+
"#);
40+
p.build();
41+
42+
assert_that(p.cargo("doc").arg("-v"),
43+
execs().with_status(0)
44+
.with_stderr_contains("\
45+
[RUNNING] `rustdoc [..] --cfg foo[..]`
46+
"));
47+
}
48+
49+
#[test]
50+
fn bad_flags() {
51+
let p = project("foo")
52+
.file("Cargo.toml", r#"
53+
[package]
54+
name = "foo"
55+
version = "0.0.1"
56+
authors = []
57+
"#)
58+
.file("src/lib.rs", "");
59+
p.build();
60+
61+
assert_that(p.cargo("doc").env("RUSTDOCFLAGS", "--bogus"),
62+
execs().with_status(101));
63+
}
64+
65+
#[test]
66+
fn rerun() {
67+
let p = project("foo")
68+
.file("Cargo.toml", r#"
69+
[package]
70+
name = "foo"
71+
version = "0.0.1"
72+
authors = []
73+
"#)
74+
.file("src/lib.rs", "");
75+
p.build();
76+
77+
assert_that(p.cargo("doc").env("RUSTDOCFLAGS", "--cfg=foo"),
78+
execs().with_status(0));
79+
assert_that(p.cargo("doc").env("RUSTDOCFLAGS", "--cfg=foo"),
80+
execs().with_status(0).with_stderr(""));
81+
assert_that(p.cargo("doc").env("RUSTDOCFLAGS", "--cfg=bar"),
82+
execs().with_status(0).with_stderr("\
83+
[DOCUMENTING] foo v0.0.1 ([..])
84+
"));
85+
}

0 commit comments

Comments
 (0)