From e35957af0b06b1593a6cdc978cae0fc191ce260c Mon Sep 17 00:00:00 2001
From: Zhongwen Deng <zhongwencool@gmail.com>
Date: Mon, 5 Sep 2022 16:12:40 +0800
Subject: [PATCH] chore: add some warning to emqx_vars

---
 rel/emqx_vars | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/rel/emqx_vars b/rel/emqx_vars
index 9498fa73d..255777f9a 100644
--- a/rel/emqx_vars
+++ b/rel/emqx_vars
@@ -10,6 +10,8 @@ RUNNER_BIN_DIR="{{ runner_bin_dir }}"
 RUNNER_LIB_DIR="{{ runner_lib_dir }}"
 IS_ELIXIR="${IS_ELIXIR:-{{ is_elixir }}}"
 
+## Allow users to pre-set `RUNNER_LOG_DIR` because it only affects boot commands like `start` and `console`,
+## but not other commands such as `ping` and `ctl`.
 if [ -z "${RUNNER_LOG_DIR:-}" ]; then
     RUNNER_LOG_DIR="{{ runner_log_dir }}"
 fi