From 8d8969672b24939726d4aa934d80abaa948f0954 Mon Sep 17 00:00:00 2001
From: William Yang <mscame@gmail.com>
Date: Thu, 7 Oct 2021 16:03:54 +0200
Subject: [PATCH] feat(olp): add desc in schema

---
 apps/emqx/src/emqx_schema.erl | 17 ++++++++++++-----
 1 file changed, 12 insertions(+), 5 deletions(-)

diff --git a/apps/emqx/src/emqx_schema.erl b/apps/emqx/src/emqx_schema.erl
index bbb9fd67c..0a1df16b4 100644
--- a/apps/emqx/src/emqx_schema.erl
+++ b/apps/emqx/src/emqx_schema.erl
@@ -399,22 +399,29 @@ fields("force_shutdown") ->
 fields("overload_protection") ->
     [ {"enable",
        sc(boolean(),
-          #{ default => false})}
+          #{ desc => "React on system overload or not"
+           , default => false
+           })}
     , {"backoff_delay",
        sc(range(0, inf),
-          #{ default => 1
+          #{ desc => "Some unimporant tasks could be delayed"
+                     "for execution, here set the delays in ms"
+           , default => 1
            })}
     , {"backoff_gc",
        sc(boolean(),
-          #{ default => false
+          #{ desc => "Skip forceful GC if necessary"
+           , default => false
            })}
     , {"backoff_hibernation",
        sc(boolean(),
-          #{ default => true
+          #{ desc => "Skip process hibernation if necessary"
+           , default => true
            })}
     , {"backoff_new_conn",
        sc(boolean(),
-          #{ default => true
+          #{ desc => "Close new incoming connections if necessary"
+           , default => true
            })}
     ];