From 1140750f6eff7ad09ea675cf48d66418a62bcdd5 Mon Sep 17 00:00:00 2001
From: onur-ozkan <work@onurozkan.dev>
Date: Sat, 27 Jul 2024 11:05:03 +0300
Subject: [PATCH] update `rust.channel` documentation

Signed-off-by: onur-ozkan <work@onurozkan.dev>
---
 config.example.toml | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/config.example.toml b/config.example.toml
index 8800c85db32..45faa66ec11 100644
--- a/config.example.toml
+++ b/config.example.toml
@@ -578,7 +578,10 @@
 # The "channel" for the Rust build to produce. The stable/beta channels only
 # allow using stable features, whereas the nightly and dev channels allow using
 # nightly features
-#channel = "dev"
+#
+# If using tarball sources, default value for `channel` is taken from the `src/ci/channel` file;
+# otherwise, it's "dev".
+#channel = if "is a tarball source" { content of `src/ci/channel` file } else { "dev" }
 
 # A descriptive string to be appended to `rustc --version` output, which is
 # also used in places like debuginfo `DW_AT_producer`. This may be useful for