From 0db1f4cd16f3d127a6da7166ade795cc5d2d0d13 Mon Sep 17 00:00:00 2001
From: Jerome Humbert <djeedai@gmail.com>
Date: Thu, 11 Nov 2021 01:43:51 +0000
Subject: [PATCH] Clarify `RUST_LOG` override over `LogSettings` (#3095)

# Objective

Clarify the fact that setting the `RUST_LOG` environment variable
overrides any setting from the `LogSettings` resource.

## Solution

Update docstring comment for `LogSettings`.
---
 crates/bevy_log/src/lib.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/crates/bevy_log/src/lib.rs b/crates/bevy_log/src/lib.rs
index 3578ad3d57..b4c1760b5c 100644
--- a/crates/bevy_log/src/lib.rs
+++ b/crates/bevy_log/src/lib.rs
@@ -45,6 +45,8 @@ use tracing_subscriber::{prelude::*, registry::Registry, EnvFilter};
 ///
 /// Log level can also be changed using the `RUST_LOG` environment variable.
 /// It has the same syntax has the field [`LogSettings::filter`], see [`EnvFilter`].
+/// If you define the `RUST_LOG` environment variable, the [`LogSettings`] resource
+/// will be ignored.
 ///
 /// If you want to setup your own tracing collector, you should disable this
 /// plugin from `DefaultPlugins` with [`App::add_plugins_with`]: