From 002249a89a996a173597de6c9f061a16d42d8806 Mon Sep 17 00:00:00 2001
From: "Zaiming (Stone) Shi" <zmstone@gmail.com>
Date: Fri, 13 May 2022 08:35:33 +0200
Subject: [PATCH] docs: water mark -> watermark

---
 apps/emqx/i18n/emqx_limiter_i18n.conf                  | 4 ++--
 apps/emqx/src/emqx_limiter/src/emqx_htb_limiter.erl    | 8 ++++----
 apps/emqx/src/emqx_limiter/src/emqx_limiter_schema.erl | 6 +++---
 apps/emqx/test/emqx_channel_SUITE.erl                  | 4 ++--
 apps/emqx/test/emqx_ratelimiter_SUITE.erl              | 4 ++--
 5 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/apps/emqx/i18n/emqx_limiter_i18n.conf b/apps/emqx/i18n/emqx_limiter_i18n.conf
index 7e5181ea0..6fbc923b7 100644
--- a/apps/emqx/i18n/emqx_limiter_i18n.conf
+++ b/apps/emqx/i18n/emqx_limiter_i18n.conf
@@ -55,14 +55,14 @@ emqx_limiter_schema {
     }
   }
 
-  low_water_mark {
+  low_watermark {
     desc {
       en: """If the remaining tokens are lower than this value,
 the check/consume will succeed, but it will be forced to wait for a short period of time."""
       zh: """当桶中剩余的令牌数低于这个值，即使令牌申请成功了，也会被强制暂停一会儿"""
     }
     label: {
-      en: """Low Water Mark"""
+      en: """Low Watermark"""
       zh: """低水位线"""
     }
   }
diff --git a/apps/emqx/src/emqx_limiter/src/emqx_htb_limiter.erl b/apps/emqx/src/emqx_limiter/src/emqx_htb_limiter.erl
index 9ae27fba5..a1115ad3a 100644
--- a/apps/emqx/src/emqx_limiter/src/emqx_htb_limiter.erl
+++ b/apps/emqx/src/emqx_limiter/src/emqx_htb_limiter.erl
@@ -49,7 +49,7 @@
     %% @see emqx_limiter_schema
     divisible := boolean(),
     %% @see emqx_limiter_schema
-    low_water_mark := non_neg_integer(),
+    low_watermark := non_neg_integer(),
     %% the limiter server's bucket
     bucket := bucket(),
 
@@ -68,7 +68,7 @@
     max_retry_time := non_neg_integer(),
     failure_strategy := failure_strategy(),
     divisible := boolean(),
-    low_water_mark := non_neg_integer(),
+    low_watermark := non_neg_integer(),
     bucket := bucket(),
 
     retry_ctx => undefined | retry_context(ref_limiter()),
@@ -115,7 +115,7 @@
 -type limiter_bucket_cfg() :: #{
     rate := decimal(),
     initial := non_neg_integer(),
-    low_water_mark := non_neg_integer(),
+    low_watermark := non_neg_integer(),
     capacity := decimal(),
     divisible := boolean(),
     max_retry_time := non_neg_integer(),
@@ -401,7 +401,7 @@ try_restore(#{need := Need, diff := Diff}, #{bucket := Bucket} = Limiter) ->
 
 -spec may_return_or_pause(non_neg_integer(), Limiter) -> check_result(Limiter) when
     Limiter :: limiter().
-may_return_or_pause(Left, #{low_water_mark := Mark} = Limiter) when Left >= Mark ->
+may_return_or_pause(Left, #{low_watermark := Mark} = Limiter) when Left >= Mark ->
     {ok, Limiter};
 may_return_or_pause(_, Limiter) ->
     {pause, ?MINIMUM_PAUSE, make_retry_context(undefined, 0), Limiter}.
diff --git a/apps/emqx/src/emqx_limiter/src/emqx_limiter_schema.erl b/apps/emqx/src/emqx_limiter/src/emqx_limiter_schema.erl
index 7856f836a..da16c9f50 100644
--- a/apps/emqx/src/emqx_limiter/src/emqx_limiter_schema.erl
+++ b/apps/emqx/src/emqx_limiter/src/emqx_limiter_schema.erl
@@ -123,15 +123,15 @@ fields(client_bucket) ->
     [
         {rate, sc(rate(), #{default => "infinity", desc => ?DESC(rate)})},
         {initial, sc(initial(), #{default => "0", desc => ?DESC(initial)})},
-        %% low_water_mark add for emqx_channel and emqx_session
+        %% low_watermark add for emqx_channel and emqx_session
         %% both modules consume first and then check
         %% so we need to use this value to prevent excessive consumption
         %% (e.g, consumption from an empty bucket)
-        {low_water_mark,
+        {low_watermark,
             sc(
                 initial(),
                 #{
-                    desc => ?DESC(low_water_mark),
+                    desc => ?DESC(low_watermark),
                     default => "0"
                 }
             )},
diff --git a/apps/emqx/test/emqx_channel_SUITE.erl b/apps/emqx/test/emqx_channel_SUITE.erl
index 8b1940a30..3383b1ee5 100644
--- a/apps/emqx/test/emqx_channel_SUITE.erl
+++ b/apps/emqx/test/emqx_channel_SUITE.erl
@@ -185,7 +185,7 @@ limiter_conf() ->
                                     divisible => false,
                                     failure_strategy => force,
                                     initial => 0,
-                                    low_water_mark => 0,
+                                    low_watermark => 0,
                                     max_retry_time => 5000,
                                     rate => infinity
                                 }
@@ -303,7 +303,7 @@ modify_limiter() ->
         rate := 5,
         initial := 0,
         capacity := 5,
-        low_water_mark := 1
+        low_watermark := 1
     },
     Default2 = Default#{
         per_client := Client2,
diff --git a/apps/emqx/test/emqx_ratelimiter_SUITE.erl b/apps/emqx/test/emqx_ratelimiter_SUITE.erl
index 665ca8ba1..9ceaa7c36 100644
--- a/apps/emqx/test/emqx_ratelimiter_SUITE.erl
+++ b/apps/emqx/test/emqx_ratelimiter_SUITE.erl
@@ -206,10 +206,10 @@ t_divisible(_) ->
     end,
     with_per_client(default, Cfg, Case).
 
-t_low_water_mark(_) ->
+t_low_watermark(_) ->
     Cfg = fun(Cfg) ->
         Cfg#{
-            low_water_mark := 400,
+            low_watermark := 400,
             rate := ?RATE("1000/1s"),
             initial := 1000,
             capacity := 1000