From bcce98990605eb33f93adca3600b8abd8025cbba Mon Sep 17 00:00:00 2001
From: zhongwencool <zhongwencool@gmail.com>
Date: Fri, 14 Apr 2023 22:30:11 +0800
Subject: [PATCH] chore: update has_deprecated_file doc

Co-authored-by: Zaiming (Stone) Shi <zmstone@gmail.com>
---
 apps/emqx/src/emqx_config.erl | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/apps/emqx/src/emqx_config.erl b/apps/emqx/src/emqx_config.erl
index 75396d779..c73fdbc72 100644
--- a/apps/emqx/src/emqx_config.erl
+++ b/apps/emqx/src/emqx_config.erl
@@ -514,6 +514,8 @@ read_override_conf(#{} = Opts) ->
         end,
     load_hocon_file(File, map).
 
+%% @doc Return `true' if this node is upgraded from older version which used cluster-override.conf for
+%% cluster-wide config persistence.
 has_deprecated_file() ->
     DeprecatedFile = deprecated_conf_file(#{override_to => cluster}),
     filelib:is_regular(DeprecatedFile).