From deac54c847fb01e1b55dd539193c3245cac5b5fa Mon Sep 17 00:00:00 2001 From: JimMoen Date: Thu, 16 Sep 2021 14:28:59 +0800 Subject: [PATCH] chore(for editor): Add comments for Emacs major mode. --- .ci/fvt_tests/http_server/src/http_server.app.src | 1 + apps/emqx/src/emqx.app.src | 1 + .../emqx_hocon_plugin/src/emqx_hocon_plugin.app.src | 1 + .../emqx_mini_plugin/src/emqx_mini_plugin.app.src | 1 + apps/emqx_authn/src/emqx_authn.app.src | 1 + apps/emqx_authz/src/emqx_authz.app.src | 1 + apps/emqx_auto_subscribe/src/emqx_auto_subscribe.app.src | 1 + apps/emqx_bridge/src/emqx_bridge.app.src | 1 + apps/emqx_connector/src/emqx_connector.app.src | 1 + apps/emqx_dashboard/src/emqx_dashboard.app.src | 1 + apps/emqx_exhook/src/emqx_exhook.app.src | 1 + apps/emqx_exhook/src/emqx_exhook.appup.src | 2 +- apps/emqx_gateway/src/emqx_gateway.app.src | 1 + apps/emqx_machine/src/emqx_machine.app.src | 1 + apps/emqx_management/src/emqx_management.app.src | 1 + apps/emqx_modules/src/emqx_modules.app.src | 1 + apps/emqx_plugin_libs/src/emqx_plugin_libs.app.src | 1 + apps/emqx_prometheus/src/emqx_prometheus.app.src | 1 + apps/emqx_resource/elvis.config | 1 + apps/emqx_resource/src/emqx_resource.app.src | 1 + apps/emqx_retainer/src/emqx_retainer.app.src | 1 + apps/emqx_rule_actions/src/emqx_rule_actions.app.src | 1 + apps/emqx_rule_engine/src/emqx_rule_engine.app.src | 1 + apps/emqx_statsd/src/emqx_statsd.app.src | 1 + elvis.config | 2 +- rebar.config | 2 +- 26 files changed, 26 insertions(+), 3 deletions(-) diff --git a/.ci/fvt_tests/http_server/src/http_server.app.src b/.ci/fvt_tests/http_server/src/http_server.app.src index f351bb349..420aff9d3 100644 --- a/.ci/fvt_tests/http_server/src/http_server.app.src +++ b/.ci/fvt_tests/http_server/src/http_server.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, http_server, [{description, "An OTP application"}, {vsn, "0.1.0"}, diff --git a/apps/emqx/src/emqx.app.src b/apps/emqx/src/emqx.app.src index 57f7cd57f..031e4f654 100644 --- a/apps/emqx/src/emqx.app.src +++ b/apps/emqx/src/emqx.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx, [{id, "emqx"}, {description, "EMQ X Core"}, diff --git a/apps/emqx/test/emqx_plugins_SUITE_data/emqx_hocon_plugin/src/emqx_hocon_plugin.app.src b/apps/emqx/test/emqx_plugins_SUITE_data/emqx_hocon_plugin/src/emqx_hocon_plugin.app.src index d09f01b1c..03cf8e69c 100644 --- a/apps/emqx/test/emqx_plugins_SUITE_data/emqx_hocon_plugin/src/emqx_hocon_plugin.app.src +++ b/apps/emqx/test/emqx_plugins_SUITE_data/emqx_hocon_plugin/src/emqx_hocon_plugin.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_hocon_plugin, [{description, "An EMQ X plugin for hocon testcase"}, {vsn, "0.1"}, diff --git a/apps/emqx/test/emqx_plugins_SUITE_data/emqx_mini_plugin/src/emqx_mini_plugin.app.src b/apps/emqx/test/emqx_plugins_SUITE_data/emqx_mini_plugin/src/emqx_mini_plugin.app.src index 413b4e1fd..0a1806f9c 100644 --- a/apps/emqx/test/emqx_plugins_SUITE_data/emqx_mini_plugin/src/emqx_mini_plugin.app.src +++ b/apps/emqx/test/emqx_plugins_SUITE_data/emqx_mini_plugin/src/emqx_mini_plugin.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_mini_plugin, [{description, "An EMQ X plugin for testcase"}, {vsn, "0.1"}, diff --git a/apps/emqx_authn/src/emqx_authn.app.src b/apps/emqx_authn/src/emqx_authn.app.src index 3b89d2a99..7aef92262 100644 --- a/apps/emqx_authn/src/emqx_authn.app.src +++ b/apps/emqx_authn/src/emqx_authn.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_authn, [{description, "EMQ X Authentication"}, {vsn, "0.1.0"}, diff --git a/apps/emqx_authz/src/emqx_authz.app.src b/apps/emqx_authz/src/emqx_authz.app.src index 0cb714b94..ff43b3536 100644 --- a/apps/emqx_authz/src/emqx_authz.app.src +++ b/apps/emqx_authz/src/emqx_authz.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_authz, [{description, "An OTP application"}, {vsn, "0.1.1"}, diff --git a/apps/emqx_auto_subscribe/src/emqx_auto_subscribe.app.src b/apps/emqx_auto_subscribe/src/emqx_auto_subscribe.app.src index 0d87af87a..92d6932ca 100644 --- a/apps/emqx_auto_subscribe/src/emqx_auto_subscribe.app.src +++ b/apps/emqx_auto_subscribe/src/emqx_auto_subscribe.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_auto_subscribe, [{description, "An OTP application"}, {vsn, "0.1.0"}, diff --git a/apps/emqx_bridge/src/emqx_bridge.app.src b/apps/emqx_bridge/src/emqx_bridge.app.src index 9c0f6b779..2a2f11603 100644 --- a/apps/emqx_bridge/src/emqx_bridge.app.src +++ b/apps/emqx_bridge/src/emqx_bridge.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_bridge, [{description, "An OTP application"}, {vsn, "0.1.0"}, diff --git a/apps/emqx_connector/src/emqx_connector.app.src b/apps/emqx_connector/src/emqx_connector.app.src index f4481dc2c..3e59d3528 100644 --- a/apps/emqx_connector/src/emqx_connector.app.src +++ b/apps/emqx_connector/src/emqx_connector.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_connector, [{description, "An OTP application"}, {vsn, "0.1.1"}, diff --git a/apps/emqx_dashboard/src/emqx_dashboard.app.src b/apps/emqx_dashboard/src/emqx_dashboard.app.src index 425180af4..5958d5f36 100644 --- a/apps/emqx_dashboard/src/emqx_dashboard.app.src +++ b/apps/emqx_dashboard/src/emqx_dashboard.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_dashboard, [{description, "EMQ X Web Dashboard"}, {vsn, "5.0.0"}, % strict semver, bump manually! diff --git a/apps/emqx_exhook/src/emqx_exhook.app.src b/apps/emqx_exhook/src/emqx_exhook.app.src index c306a5ea4..bfd33a661 100644 --- a/apps/emqx_exhook/src/emqx_exhook.app.src +++ b/apps/emqx_exhook/src/emqx_exhook.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_exhook, [{description, "EMQ X Extension for Hook"}, {vsn, "5.0.0"}, diff --git a/apps/emqx_exhook/src/emqx_exhook.appup.src b/apps/emqx_exhook/src/emqx_exhook.appup.src index 9e142d9e2..5ca8ba8da 100644 --- a/apps/emqx_exhook/src/emqx_exhook.appup.src +++ b/apps/emqx_exhook/src/emqx_exhook.appup.src @@ -1,4 +1,4 @@ -%% -*-: erlang -*- +%% -*- mode: erlang -*- {VSN, [ {<<".*">>, []} diff --git a/apps/emqx_gateway/src/emqx_gateway.app.src b/apps/emqx_gateway/src/emqx_gateway.app.src index 2fc329711..69aa9418e 100644 --- a/apps/emqx_gateway/src/emqx_gateway.app.src +++ b/apps/emqx_gateway/src/emqx_gateway.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_gateway, [{description, "The Gateway management application"}, {vsn, "0.1.0"}, diff --git a/apps/emqx_machine/src/emqx_machine.app.src b/apps/emqx_machine/src/emqx_machine.app.src index 21da4a4c8..8140c7b6a 100644 --- a/apps/emqx_machine/src/emqx_machine.app.src +++ b/apps/emqx_machine/src/emqx_machine.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_machine, [{id, "emqx_machine"}, {description, "The EMQ X Machine"}, diff --git a/apps/emqx_management/src/emqx_management.app.src b/apps/emqx_management/src/emqx_management.app.src index b859c2d55..1349f541c 100644 --- a/apps/emqx_management/src/emqx_management.app.src +++ b/apps/emqx_management/src/emqx_management.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_management, [{description, "EMQ X Management API and CLI"}, {vsn, "5.0.0"}, % strict semver, bump manually! diff --git a/apps/emqx_modules/src/emqx_modules.app.src b/apps/emqx_modules/src/emqx_modules.app.src index cfa315c9b..06e8ecc1f 100644 --- a/apps/emqx_modules/src/emqx_modules.app.src +++ b/apps/emqx_modules/src/emqx_modules.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_modules, [{description, "EMQ X Modules"}, {vsn, "5.0.0"}, diff --git a/apps/emqx_plugin_libs/src/emqx_plugin_libs.app.src b/apps/emqx_plugin_libs/src/emqx_plugin_libs.app.src index 82937d033..f515244c1 100644 --- a/apps/emqx_plugin_libs/src/emqx_plugin_libs.app.src +++ b/apps/emqx_plugin_libs/src/emqx_plugin_libs.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_plugin_libs, [{description, "EMQ X Plugin utility libs"}, {vsn, "4.3.1"}, diff --git a/apps/emqx_prometheus/src/emqx_prometheus.app.src b/apps/emqx_prometheus/src/emqx_prometheus.app.src index e1e55b599..8b5968ea0 100644 --- a/apps/emqx_prometheus/src/emqx_prometheus.app.src +++ b/apps/emqx_prometheus/src/emqx_prometheus.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_prometheus, [{description, "Prometheus for EMQ X"}, {vsn, "5.0.0"}, % strict semver, bump manually! diff --git a/apps/emqx_resource/elvis.config b/apps/emqx_resource/elvis.config index 59aa13fbe..5a0ec61dd 100644 --- a/apps/emqx_resource/elvis.config +++ b/apps/emqx_resource/elvis.config @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- [{elvis, [{config, [ #{dirs => ["src"], diff --git a/apps/emqx_resource/src/emqx_resource.app.src b/apps/emqx_resource/src/emqx_resource.app.src index 7e7ebe9ff..1b93aa0de 100644 --- a/apps/emqx_resource/src/emqx_resource.app.src +++ b/apps/emqx_resource/src/emqx_resource.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_resource, [{description, "An OTP application"}, {vsn, "0.1.0"}, diff --git a/apps/emqx_retainer/src/emqx_retainer.app.src b/apps/emqx_retainer/src/emqx_retainer.app.src index b2023671b..482196b64 100644 --- a/apps/emqx_retainer/src/emqx_retainer.app.src +++ b/apps/emqx_retainer/src/emqx_retainer.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_retainer, [{description, "EMQ X Retainer"}, {vsn, "5.0.0"}, % strict semver, bump manually! diff --git a/apps/emqx_rule_actions/src/emqx_rule_actions.app.src b/apps/emqx_rule_actions/src/emqx_rule_actions.app.src index 8e7b66b55..8c2b8d247 100644 --- a/apps/emqx_rule_actions/src/emqx_rule_actions.app.src +++ b/apps/emqx_rule_actions/src/emqx_rule_actions.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_rule_actions, [{description, "Rule actions"}, {vsn, "5.0.0"}, diff --git a/apps/emqx_rule_engine/src/emqx_rule_engine.app.src b/apps/emqx_rule_engine/src/emqx_rule_engine.app.src index ff25dcfd3..a93a7e14d 100644 --- a/apps/emqx_rule_engine/src/emqx_rule_engine.app.src +++ b/apps/emqx_rule_engine/src/emqx_rule_engine.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_rule_engine, [{description, "EMQ X Rule Engine"}, {vsn, "5.0.0"}, % strict semver, bump manually! diff --git a/apps/emqx_statsd/src/emqx_statsd.app.src b/apps/emqx_statsd/src/emqx_statsd.app.src index 747c9447c..aa1c14ded 100644 --- a/apps/emqx_statsd/src/emqx_statsd.app.src +++ b/apps/emqx_statsd/src/emqx_statsd.app.src @@ -1,3 +1,4 @@ +%% -*- mode: erlang -*- {application, emqx_statsd, [{description, "An OTP application"}, {vsn, "5.0.0"}, diff --git a/elvis.config b/elvis.config index ef695458c..30178622a 100644 --- a/elvis.config +++ b/elvis.config @@ -1,4 +1,4 @@ -%% -*-: erlang -*- +%% -*- mode: erlang -*- [ { elvis, diff --git a/rebar.config b/rebar.config index 7c5edc680..7e2eb7e54 100644 --- a/rebar.config +++ b/rebar.config @@ -1,4 +1,4 @@ -%% -*- mode:erlang -*- +%% -*- mode: erlang -*- %% This config file is the very basic config to compile emqx %% This allows emqx to be used as a dependency for other applications %% such as emqx module/plugin develpments and tests.