1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
//! Tests for setting custom rustdoc flags.
use cargo_test_support::project;
#[cargo_test]
fn parses_env() {
let p = project().file("src/lib.rs", "").build();
p.cargo("doc -v")
.env("RUSTDOCFLAGS", "--cfg=foo")
.with_stderr_contains("[RUNNING] `rustdoc [..] --cfg=foo[..]`")
.run();
}
#[cargo_test]
fn parses_config() {
let p = project()
.file("src/lib.rs", "")
.file(
".cargo/config",
r#"
[build]
rustdocflags = ["--cfg", "foo"]
"#,
)
.build();
p.cargo("doc -v")
.with_stderr_contains("[RUNNING] `rustdoc [..] --cfg foo[..]`")
.run();
}
#[cargo_test]
fn bad_flags() {
let p = project().file("src/lib.rs", "").build();
p.cargo("doc")
.env("RUSTDOCFLAGS", "--bogus")
.with_status(101)
.with_stderr_contains("[..]bogus[..]")
.run();
}
#[cargo_test]
fn rerun() {
let p = project().file("src/lib.rs", "").build();
p.cargo("doc").env("RUSTDOCFLAGS", "--cfg=foo").run();
p.cargo("doc")
.env("RUSTDOCFLAGS", "--cfg=foo")
.with_stderr("[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]")
.run();
p.cargo("doc")
.env("RUSTDOCFLAGS", "--cfg=bar")
.with_stderr(
"\
[DOCUMENTING] foo v0.0.1 ([..])
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]
",
)
.run();
}
#[cargo_test]
fn rustdocflags_passed_to_rustdoc_through_cargo_test() {
let p = project()
.file(
"src/lib.rs",
r#"
//! ```
//! assert!(cfg!(do_not_choke));
//! ```
"#,
)
.build();
p.cargo("test --doc")
.env("RUSTDOCFLAGS", "--cfg do_not_choke")
.run();
}
#[cargo_test]
fn rustdocflags_passed_to_rustdoc_through_cargo_test_only_once() {
let p = project().file("src/lib.rs", "").build();
p.cargo("test --doc")
.env("RUSTDOCFLAGS", "--markdown-no-toc")
.run();
}
#[cargo_test]
fn rustdocflags_misspelled() {
let p = project().file("src/main.rs", "fn main() { }").build();
p.cargo("doc")
.env("RUSTDOC_FLAGS", "foo")
.with_stderr_contains("[WARNING] Cargo does not read `RUSTDOC_FLAGS` environment variable. Did you mean `RUSTDOCFLAGS`?")
.run();
}
#[cargo_test]
fn whitespace() {
// Checks behavior of different whitespace characters.
let p = project().file("src/lib.rs", "").build();
// "too many operands"
p.cargo("doc")
.env("RUSTDOCFLAGS", "--crate-version this has spaces")
.with_stderr_contains("[ERROR] could not document `foo`")
.with_status(101)
.run();
const SPACED_VERSION: &str = "a\nb\tc\u{00a0}d";
p.cargo("doc")
.env_remove("__CARGO_TEST_FORCE_ARGFILE") // Not applicable for argfile.
.env(
"RUSTDOCFLAGS",
format!("--crate-version {}", SPACED_VERSION),
)
.run();
let contents = p.read_file("target/doc/foo/index.html");
assert!(contents.contains(SPACED_VERSION));
}
#[cargo_test]
fn not_affected_by_target_rustflags() {
let cfg = if cfg!(windows) { "windows" } else { "unix" };
let p = project()
.file("src/lib.rs", "")
.file(
".cargo/config",
&format!(
r#"
[target.'cfg({cfg})']
rustflags = ["-D", "missing-docs"]
[build]
rustdocflags = ["--cfg", "foo"]
"#,
),
)
.build();
// `cargo build` should fail due to missing docs.
p.cargo("build -v")
.with_status(101)
.with_stderr_contains("[RUNNING] `rustc [..] -D missing-docs[..]`")
.run();
// `cargo doc` shouldn't fail.
p.cargo("doc -v")
.with_stderr_contains("[RUNNING] `rustdoc [..] --cfg foo[..]`")
.run();
}
|
