Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changed RUST_LOG usage to CARGO_LOG to avoid confusion. #6605

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,17 +131,18 @@ to nightly rustc).

## Logging


Cargo uses [`env_logger`], so you can set
`RUST_LOG` environment variable to get the logs. This is useful both for diagnosing
`CARGO_LOG` environment variable to get the logs. This is useful both for diagnosing
bugs in stable Cargo and for local development. Cargo also has internal hierarchical
profiling infrastructure, which is activated via `CARGO_PROFILE` variable

```
# Outputs all logs with levels debug and higher
$ RUST_LOG=debug cargo generate-lockfile
$ CARGO_LOG=debug cargo generate-lockfile

# Don't forget that you can filter by module as well
$ RUST_LOG=cargo::core::resolver=trace cargo generate-lockfile
$ CARGO_LOG=cargo::core::resolver=trace cargo generate-lockfile

# Output first three levels of profiling info
$ CARGO_PROFILE=3 cargo generate-lockfile
Expand Down
4 changes: 2 additions & 2 deletions src/bin/cargo/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ use crate::command_prelude::*;

fn main() {
#[cfg(feature = "pretty-env-logger")]
pretty_env_logger::init();
pretty_env_logger::init_custom_env("CARGO_LOG");
#[cfg(not(feature = "pretty-env-logger"))]
env_logger::init();
env_logger::init_from_env("CARGO_LOG");
cargo::core::maybe_allow_nightly_features();

let mut config = match Config::default() {
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ multiplexing = true # whether or not to use HTTP/2 multiplexing where possible
# This setting can be used to help debug what's going on with HTTP requests made
# by Cargo. When set to `true` then Cargo's normal debug logging will be filled
# in with HTTP information, which you can extract with
# `RUST_LOG=cargo::ops::registry=debug` (and `trace` may print more).
# `CARGO_LOG=cargo::ops::registry=debug` (and `trace` may print more).
#
# Be wary when posting these logs elsewhere though, it may be the case that a
# header has an authentication token in it you don't want leaked! Be sure to
Expand Down
2 changes: 1 addition & 1 deletion tests/testsuite/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2267,7 +2267,7 @@ fn simple_staticlib() {
.build();

// env var is a test for #1381
p.cargo("build").env("RUST_LOG", "nekoneko=trace").run();
p.cargo("build").env("CARGO_LOG", "nekoneko=trace").run();
}

#[test]
Expand Down
8 changes: 4 additions & 4 deletions tests/testsuite/build_script.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1547,13 +1547,13 @@ fn build_script_with_dynamic_native_dependency() {

build
.cargo("build -v")
.env("RUST_LOG", "cargo::ops::cargo_rustc")
.env("CARGO_LOG", "cargo::ops::cargo_rustc")
.run();

let root = build.root().join("target").join("debug");
foo.cargo("build -v")
.env("BUILDER_ROOT", root)
.env("RUST_LOG", "cargo::ops::cargo_rustc")
.env("CARGO_LOG", "cargo::ops::cargo_rustc")
.run();
}

Expand Down Expand Up @@ -2406,7 +2406,7 @@ fn fresh_builds_possible_with_link_libs() {
.run();

p.cargo("build -v")
.env("RUST_LOG", "cargo::ops::cargo_rustc::fingerprint=info")
.env("CARGO_LOG", "cargo::ops::cargo_rustc::fingerprint=info")
.with_stderr(
"\
[FRESH] foo v0.5.0 ([..])
Expand Down Expand Up @@ -2461,7 +2461,7 @@ fn fresh_builds_possible_with_multiple_metadata_overrides() {
.run();

p.cargo("build -v")
.env("RUST_LOG", "cargo::ops::cargo_rustc::fingerprint=info")
.env("CARGO_LOG", "cargo::ops::cargo_rustc::fingerprint=info")
.with_stderr(
"\
[FRESH] foo v0.5.0 ([..])
Expand Down
2 changes: 1 addition & 1 deletion tests/testsuite/check.rs
Original file line number Diff line number Diff line change
Expand Up @@ -740,7 +740,7 @@ fn proc_macro() {
"#,
)
.build();
p.cargo("check -v").env("RUST_LOG", "cargo=trace").run();
p.cargo("check -v").env("CARGO_LOG", "cargo=trace").run();
}

#[test]
Expand Down
8 changes: 4 additions & 4 deletions tests/testsuite/corrupt_git.rs
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ fn deleting_database_files() {
}
println!("deleting {}", file.display());
cargopaths::remove_file(&file).unwrap();
project.cargo("build -v").env("RUST_LOG", log).run();
project.cargo("build -v").env("CARGO_LOG", log).run();

if !file.exists() {
continue;
Expand All @@ -60,7 +60,7 @@ fn deleting_database_files() {
.unwrap()
.set_len(2)
.unwrap();
project.cargo("build -v").env("RUST_LOG", log).run();
project.cargo("build -v").env("CARGO_LOG", log).run();
}
}

Expand Down Expand Up @@ -124,7 +124,7 @@ fn deleting_checkout_files() {
}
println!("deleting {}", file.display());
cargopaths::remove_file(&file).unwrap();
project.cargo("build -v").env("RUST_LOG", log).run();
project.cargo("build -v").env("CARGO_LOG", log).run();

if !file.exists() {
continue;
Expand All @@ -137,7 +137,7 @@ fn deleting_checkout_files() {
.unwrap()
.set_len(2)
.unwrap();
project.cargo("build -v").env("RUST_LOG", log).run();
project.cargo("build -v").env("CARGO_LOG", log).run();
}
}

Expand Down
2 changes: 1 addition & 1 deletion tests/testsuite/doc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ fn doc_deps() {
);

p.cargo("doc")
.env("RUST_LOG", "cargo::ops::cargo_rustc::fingerprint")
.env("CARGO_LOG", "cargo::ops::cargo_rustc::fingerprint")
.with_stdout("")
.run();

Expand Down
2 changes: 1 addition & 1 deletion tests/testsuite/freshness.rs
Original file line number Diff line number Diff line change
Expand Up @@ -759,7 +759,7 @@ fn rebuild_if_build_artifacts_move_forward_in_time() {
p.root().move_into_the_future();

p.cargo("build")
.env("RUST_LOG", "")
.env("CARGO_LOG", "")
.with_stdout("")
.with_stderr(
"\
Expand Down
14 changes: 7 additions & 7 deletions tests/testsuite/rustc_info_cache.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,23 @@ fn rustc_info_cache() {
let update = "[..]updated rustc info cache[..]";

p.cargo("build")
.env("RUST_LOG", "cargo::util::rustc=info")
.env("CARGO_LOG", "cargo::util::rustc=info")
.with_stderr_contains("[..]failed to read rustc info cache[..]")
.with_stderr_contains(miss)
.with_stderr_does_not_contain(hit)
.with_stderr_contains(update)
.run();

p.cargo("build")
.env("RUST_LOG", "cargo::util::rustc=info")
.env("CARGO_LOG", "cargo::util::rustc=info")
.with_stderr_contains("[..]reusing existing rustc info cache[..]")
.with_stderr_contains(hit)
.with_stderr_does_not_contain(miss)
.with_stderr_does_not_contain(update)
.run();

p.cargo("build")
.env("RUST_LOG", "cargo::util::rustc=info")
.env("CARGO_LOG", "cargo::util::rustc=info")
.env("CARGO_CACHE_RUSTC_INFO", "0")
.with_stderr_contains("[..]rustc info cache disabled[..]")
.with_stderr_does_not_contain(update)
Expand Down Expand Up @@ -63,7 +63,7 @@ fn rustc_info_cache() {
};

p.cargo("build")
.env("RUST_LOG", "cargo::util::rustc=info")
.env("CARGO_LOG", "cargo::util::rustc=info")
.env("RUSTC", other_rustc.display().to_string())
.with_stderr_contains("[..]different compiler, creating new rustc info cache[..]")
.with_stderr_contains(miss)
Expand All @@ -72,7 +72,7 @@ fn rustc_info_cache() {
.run();

p.cargo("build")
.env("RUST_LOG", "cargo::util::rustc=info")
.env("CARGO_LOG", "cargo::util::rustc=info")
.env("RUSTC", other_rustc.display().to_string())
.with_stderr_contains("[..]reusing existing rustc info cache[..]")
.with_stderr_contains(hit)
Expand All @@ -83,7 +83,7 @@ fn rustc_info_cache() {
other_rustc.move_into_the_future();

p.cargo("build")
.env("RUST_LOG", "cargo::util::rustc=info")
.env("CARGO_LOG", "cargo::util::rustc=info")
.env("RUSTC", other_rustc.display().to_string())
.with_stderr_contains("[..]different compiler, creating new rustc info cache[..]")
.with_stderr_contains(miss)
Expand All @@ -92,7 +92,7 @@ fn rustc_info_cache() {
.run();

p.cargo("build")
.env("RUST_LOG", "cargo::util::rustc=info")
.env("CARGO_LOG", "cargo::util::rustc=info")
.env("RUSTC", other_rustc.display().to_string())
.with_stderr_contains("[..]reusing existing rustc info cache[..]")
.with_stderr_contains(hit)
Expand Down
2 changes: 1 addition & 1 deletion tests/testsuite/small_fd_limits.rs
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ fn run_test(path_env: Option<&OsStr>) {
if let Some(path) = path_env {
cmd.env("PATH", path);
}
cmd.env("RUST_LOG", "trace");
cmd.env("CARGO_LOG", "trace");
cmd.run();
let after = find_index()
.join(".git/objects/pack")
Expand Down
2 changes: 1 addition & 1 deletion tests/testsuite/update.rs
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ fn update_via_new_dep() {
Package::new("log", "0.1.1").publish();

p.uncomment_root_manifest();
p.cargo("build").env("RUST_LOG", "cargo=trace").run();
p.cargo("build").env("CARGO_LOG", "cargo=trace").run();
}

#[test]
Expand Down