From 8f4bd5f8ad51d51a6a085c7ed825d95a9cc90d4a Mon Sep 17 00:00:00 2001
From: Delyan Angelov <delian66@gmail.com>
Date: Tue, 21 Jan 2025 15:39:57 +0200
Subject: [PATCH] log: add a notice on first logged message, about the
 stdout->stderr change

---
 vlib/log/log.v | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/vlib/log/log.v b/vlib/log/log.v
index d8a2ebdcaa5ae9..3cc0f4b7d0b00e 100644
--- a/vlib/log/log.v
+++ b/vlib/log/log.v
@@ -31,7 +31,7 @@ const stderr = os.stderr()
 // Log represents a logging object
 pub struct Log {
 mut:
-	level              Level
+	level              Level = .debug
 	output_label       string
 	ofile              os.File
 	output_target      LogTarget // output to console (stdout/stderr) or file or both.
@@ -40,6 +40,8 @@ mut:
 	short_tag          bool
 	always_flush       bool // flush after every single .fatal(), .error(), .warn(), .info(), .debug() call
 	output_stream      io.Writer = stderr
+	//
+	show_notice_about_stdout_to_stderr_change bool = true // this field is temporary, and should be deleted after 2025-03-01
 pub mut:
 	output_file_name string // log output to this file
 }
@@ -83,6 +85,7 @@ pub fn (mut l Log) set_output_path(output_file_path string) {
 
 // set_output_stream sets the output stream to write log e.g. stderr, stdout, etc.
 pub fn (mut l Log) set_output_stream(stream io.Writer) {
+	l.show_notice_about_stdout_to_stderr_change = false
 	l.output_stream = stream
 }
 
@@ -142,6 +145,15 @@ fn (mut l Log) log_file(s string, level Level) {
 
 // log_stream writes log line `s` with `level` to stderr or stderr depending on set output stream.
 fn (mut l Log) log_stream(s string, level Level) {
+	if l.show_notice_about_stdout_to_stderr_change {
+		l.show_notice_about_stdout_to_stderr_change = false
+		// Show a warning at runtime, once, before the first logged message, that describes the stdout -> stderr change,
+		// and how to opt in explicitly for the old behaviour:
+		println('   NOTE: the `log.Log` output goes to stderr now by default, not to stdout.')
+		println('      Call `l.set_output_stream(os.stdout())` explicitly, to opt in for the previous behavior.')
+		println('      Call `l.set_output_stream(os.stderr())` explicitly, if you want to silence this message (it will be removed after 2025-03-01 .')
+		flush_stdout()
+	}
 	timestamp := l.time_format(time.utc())
 	tag := tag_to_console(level, l.short_tag)
 	msg := '${timestamp} [${tag}] ${s}\n'