From 2e94880bb6dfbba5b6661cf0e9cb6bbfb332fa65 Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Tue, 15 Feb 2022 22:39:11 +0100 Subject: [PATCH] docs: More EMQ X -> EMQX rename in descriptive strings --- LICENSE | 4 +- NOTICE | 2 +- PLUGIN.md | 6 +-- Windows.md | 16 +++---- apps/emqx/NOTICE | 2 +- apps/emqx/etc/emqx_cloud/vm.args | 2 +- apps/emqx/etc/emqx_edge/vm.args | 2 +- apps/emqx_conf/etc/emqx_conf.md | 16 +++---- apps/emqx_exhook/docs/design-cn.md | 4 +- .../etc/emqx_gateway.conf.example | 4 +- bin/emqx | 46 +++++++++---------- bin/node_dump | 2 +- build | 4 +- deploy/charts/emqx/Chart.yaml | 2 +- deploy/docker/docker-entrypoint.sh | 2 +- deploy/packages/deb/debian/control | 2 +- deploy/packages/rpm/emqx.spec | 2 +- lib-ee/BSL.txt | 2 +- lib-ee/emqx_license/include/emqx_license.hrl | 2 +- mix.exs | 6 +-- scripts/buildx.sh | 6 +-- scripts/relup-base-vsns.sh | 2 +- 22 files changed, 68 insertions(+), 68 deletions(-) diff --git a/LICENSE b/LICENSE index f6af1c7d6..ac9372d97 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,7 @@ Source code in this repository is variously licensed under below licenses. -For EMQ X Community Edition: Apache License 2.0, see APL.txt, +For EMQX Community Edition: Apache License 2.0, see APL.txt, which applies to all source files except for lib-ee sub-directory. -For EMQ X Enterprise Edition (since version 5.0): Business Source License 1.1, +For EMQX Enterprise Edition (since version 5.0): Business Source License 1.1, see lib-ee/BSL.txt, which applies to source code in lib-ee sub-directory. diff --git a/NOTICE b/NOTICE index dfa7e800a..613c5d83a 100644 --- a/NOTICE +++ b/NOTICE @@ -1,4 +1,4 @@ -EMQ X, highly scalable, highly available distributed MQTT messaging platform for IoT. +EMQX, highly scalable, highly available distributed MQTT messaging platform for IoT. Copyright (c) 2017-2022 EMQ Technologies Co., Ltd. All Rights Reserved. This product contains code developed at EMQ Technologies Co., Ltd. diff --git a/PLUGIN.md b/PLUGIN.md index 680a40744..37a880a94 100644 --- a/PLUGIN.md +++ b/PLUGIN.md @@ -1,8 +1,8 @@ -# EMQ X plugins +# EMQX plugins -Starting from EMQ X 5.0, plugins are developed in independent projects. +Starting from EMQX 5.0, plugins are developed in independent projects. -This is different from EMQ X 4.3 (and later 4.x releases) for which the plugins have to +This is different from EMQX 4.3 (and later 4.x releases) for which the plugins have to be developed inside the emqx.git umbrella project. ## Erlang diff --git a/Windows.md b/Windows.md index 25896129f..7ae0f738c 100644 --- a/Windows.md +++ b/Windows.md @@ -1,4 +1,4 @@ -# Build and run EMQ X on Windows +# Build and run EMQX on Windows NOTE: The instructions and examples are based on Windows 10. @@ -6,7 +6,7 @@ NOTE: The instructions and examples are based on Windows 10. ### Visual studio for C/C++ compile and link -EMQ X includes Erlang NIF (Native Implemented Function) components, implemented +EMQX includes Erlang NIF (Native Implemented Function) components, implemented in C/C++. To compile and link C/C++ libraries, the easiest way is perhaps to install Visual Studio. @@ -51,7 +51,7 @@ Eshell V11.1.4 (abort with ^G) ### bash -All EMQ X build/run scripts are either in `bash` or `escript`. +All EMQX build/run scripts are either in `bash` or `escript`. `escript` is installed as a part of Erlang. To install a `bash` environment in Windows, there are quite a few options. @@ -68,7 +68,7 @@ Cygwin is what we tested with. ### Other tools -Some of the unix world tools are required to build EMQ X. Including: +Some of the unix world tools are required to build EMQX. Including: * git * curl @@ -85,7 +85,7 @@ When using scoop: scoop install git curl make cmake jq zip unzip ``` -## Build EMQ X source code +## Build EMQX source code * Clone the repo: `git clone https://github.com/emqx/emqx.git` @@ -113,11 +113,11 @@ scoop install git curl make cmake jq zip unzip To fix it, Visual Studio's bin paths should be ordered prior to Cygwin's (or similar installation's) bin paths in `Path` environment variable. -## Run EMQ X +## Run EMQX -To start EMQ X broker. +To start EMQX broker. -Execute `_build\emqx\rel\emqx>.\bin\emqx console` or `_build\emqx\rel\emqx>.\bin\emqx start` to start EMQ X. +Execute `_build\emqx\rel\emqx>.\bin\emqx console` or `_build\emqx\rel\emqx>.\bin\emqx start` to start EMQX. Then execute `_build\emqx\rel\emqx>.\bin\emqx_ctl status` to check status. If everything works fine, it should print out diff --git a/apps/emqx/NOTICE b/apps/emqx/NOTICE index dfa7e800a..613c5d83a 100644 --- a/apps/emqx/NOTICE +++ b/apps/emqx/NOTICE @@ -1,4 +1,4 @@ -EMQ X, highly scalable, highly available distributed MQTT messaging platform for IoT. +EMQX, highly scalable, highly available distributed MQTT messaging platform for IoT. Copyright (c) 2017-2022 EMQ Technologies Co., Ltd. All Rights Reserved. This product contains code developed at EMQ Technologies Co., Ltd. diff --git a/apps/emqx/etc/emqx_cloud/vm.args b/apps/emqx/etc/emqx_cloud/vm.args index 8111eed38..7a55ac26c 100644 --- a/apps/emqx/etc/emqx_cloud/vm.args +++ b/apps/emqx/etc/emqx_cloud/vm.args @@ -1,5 +1,5 @@ ###################################################################### -## Erlang VM Args for EMQ X Broker +## Erlang VM Args ###################################################################### ## NOTE: diff --git a/apps/emqx/etc/emqx_edge/vm.args b/apps/emqx/etc/emqx_edge/vm.args index 743068538..f63d2f976 100644 --- a/apps/emqx/etc/emqx_edge/vm.args +++ b/apps/emqx/etc/emqx_edge/vm.args @@ -1,5 +1,5 @@ ###################################################################### -## Erlang VM Args for EMQ X Edge +## Erlang VM Args ###################################################################### ## NOTE: diff --git a/apps/emqx_conf/etc/emqx_conf.md b/apps/emqx_conf/etc/emqx_conf.md index 505b444f3..45d71e151 100644 --- a/apps/emqx_conf/etc/emqx_conf.md +++ b/apps/emqx_conf/etc/emqx_conf.md @@ -1,10 +1,10 @@ -EMQ X configuration file is in [HOCON](https://github.com/emqx/hocon) format. +EMQX configuration file is in [HOCON](https://github.com/emqx/hocon) format. HOCON, or Human-Optimized Config Object Notation is a format for human-readable data, and a superset of JSON. ## Layered -EMQ X configuration consists of 3 layers. +EMQX configuration consists of 3 layers. From bottom up: 1. Immutable base: `emqx.conf` + `EMQX_` prefixed environment variables.
@@ -36,7 +36,7 @@ node.name="127.0.0.1" node.cookie="mysecret" ``` -This flat format is almost backward compatible with EMQ X's config file format +This flat format is almost backward compatible with EMQX's config file format in 4.x series (the so called 'cuttlefish' format). It is 'almost' compatible because the often HOCON requires strings to be quoted, @@ -51,13 +51,13 @@ For more HOCON syntax, please refer to the [specification](https://github.com/li ## Schema -To make the HOCON objects type-safe, EMQ X introduced a schema for it. +To make the HOCON objects type-safe, EMQX introduced a schema for it. The schema defines data types, and data fields' names and metadata for config value validation and more. In fact, this config document itself is generated from schema metadata. ### Complex Data Types -There are 4 complex data types in EMQ X's HOCON config: +There are 4 complex data types in EMQX's HOCON config: 1. Struct: Named using an unquoted string, followed by a predefined list of fields, fields can not start with a number, and are only allowed to use @@ -85,11 +85,11 @@ There are quite some different primitive types, to name a few: * ... The primitive types are mostly self-describing, some are built-in, such -as `atom()`, some are defined in EMQ X modules, such as `emqx_schema:duration()`. +as `atom()`, some are defined in EMQX modules, such as `emqx_schema:duration()`. ### Config Paths -If we consider the whole EMQ X config as a tree, +If we consider the whole EMQX config as a tree, to reference a primitive value, we can use a dot-separated names form string for the path from the tree-root (always a Struct) down to the primitive values at tree-leaves. @@ -181,7 +181,7 @@ zone.zone1.mqtt.max_packet_size = 10M #### Array Elements -Arrays in EMQ X config have two different representations +Arrays in EMQX config have two different representations * list, such as: `[1, 2, 3]` * indexed-map, such as: `{"1"=1, "2"=2, "3"=3}` diff --git a/apps/emqx_exhook/docs/design-cn.md b/apps/emqx_exhook/docs/design-cn.md index 26a385061..dcc2cf946 100644 --- a/apps/emqx_exhook/docs/design-cn.md +++ b/apps/emqx_exhook/docs/design-cn.md @@ -2,7 +2,7 @@ ## 动机 -在 EMQ X Broker v4.1-v4.2 中，我们发布了 2 个插件来扩展 emqx 的编程能力： +在 EMQX Broker v4.1-v4.2 中，我们发布了 2 个插件来扩展 emqx 的编程能力： 1. `emqx-extension-hook` 提供了使用 Java, Python 向 Broker 挂载钩子的功能 2. `emqx-exproto` 提供了使用 Java，Python 编写用户自定义协议接入插件的功能 @@ -26,7 +26,7 @@ 架构如下： ``` - EMQ X + EMQX +========================+ +========+==========+ | ExHook | | | | | +----------------+ | gRPC | gRPC | User's | diff --git a/apps/emqx_gateway/etc/emqx_gateway.conf.example b/apps/emqx_gateway/etc/emqx_gateway.conf.example index 481a5c7cd..50cd1e2ca 100644 --- a/apps/emqx_gateway/etc/emqx_gateway.conf.example +++ b/apps/emqx_gateway/etc/emqx_gateway.conf.example @@ -1,5 +1,5 @@ ##-------------------------------------------------------------------- -## EMQ X Gateway configurations +## EMQX Gateway configurations ##-------------------------------------------------------------------- gateway.stomp { @@ -135,7 +135,7 @@ gateway.coap { ## The *Default QoS Level* indicator for publish request. ## This option specifies the QoS level for the CoAP Client when publishing a - ## message to EMQ X PUB/SUB system, if the publish request is not carried `qos` + ## message to EMQX PUB/SUB system, if the publish request is not carried `qos` ## option. ## The indicator can be set to: ## - qos0, qos1, qos2: Fixed default QoS level diff --git a/bin/emqx b/bin/emqx index 6c2cd000e..94536a46b 100755 --- a/bin/emqx +++ b/bin/emqx @@ -80,42 +80,42 @@ usage() { case "$command" in start) - echo "Start EMQ X service in daemon mode" + echo "Start EMQX service in daemon mode" ;; stop) - echo "Stop the running EMQ X program" + echo "Stop the running EMQX program" ;; console) - echo "Boot up EMQ X service in an interactive Erlang or Elixir shell" + echo "Boot up EMQX service in an interactive Erlang or Elixir shell" echo "This command needs a tty" ;; console_clean) - echo "This command does NOT boot up the EMQ X service" + echo "This command does NOT boot up the EMQX service" echo "It only starts an interactive Erlang or Elixir console with all the" - echo "EMQ X code available" + echo "EMQX code available" ;; foreground) - echo "Start EMQ X in foreground mode without an interactive shell" + echo "Start EMQX in foreground mode without an interactive shell" ;; pid) - echo "Print out EMQ X process identifier" + echo "Print out EMQX process identifier" ;; ping) - echo "Check if the EMQ X node is up and running" + echo "Check if the EMQX node is up and running" echo "This command exit with 0 silently if node is running" ;; escript) - echo "Execute a escript using the Erlang runtime from EMQ X package installation" + echo "Execute a escript using the Erlang runtime from EMQX package installation" echo "For example $REL_NAME escript /path/to/my/escript my_arg1 my_arg2" ;; attach) - echo "This command is applicable when EMQ X is started in daemon" - echo "mode. it attaches the current shell to EMQ X's control console" + echo "This command is applicable when EMQX is started in daemon" + echo "mode. it attaches the current shell to EMQX's control console" echo "through a named pipe" echo "WARNING: try to use the safer alternative, remote_console command." ;; remote_console) - echo "Start a dummy Erlang or Elixir node and hidden-connect EMQ X to" + echo "Start a dummy Erlang or Elixir node and hidden-connect EMQX to" echo "with an interactive Erlang or Elixir shell" ;; ertspath) @@ -123,28 +123,28 @@ usage() { ;; rpc) echo "Usge $REL_NAME rpc MODULE FUNCTION [ARGS, ...]" - echo "Connect to the EMQ X node and make an Erlang RPC" + echo "Connect to the EMQX node and make an Erlang RPC" echo "This command blocks for at most 60 seconds." echo "It exits with non-zero code in case of any RPC failure" echo "including connection error and runtime exception" ;; rpcterms) echo "Usge $REL_NAME rpcterms MODULE FUNCTION [ARGS, ...]" - echo "Connect to the EMQ X node and make an Erlang RPC" + echo "Connect to the EMQX node and make an Erlang RPC" echo "The result of the RPC call is pretty-printed as an " echo "Erlang term" ;; root_dir) - echo "Print EMQ X installation root dir" + echo "Print EMQX installation root dir" ;; eval) - echo "Evaluate an Erlang or Elxir expression in the EMQ X node" + echo "Evaluate an Erlang or Elxir expression in the EMQX node" ;; eval-erl) - echo "Evaluate an Erlang expression in the EMQ X node, even on Elixir node" + echo "Evaluate an Erlang expression in the EMQX node, even on Elixir node" ;; versions) - echo "List installed EMQ X versions and their status" + echo "List installed EMQX versions and their status" ;; unpack) echo "Usage: $REL_NAME unpack [VERSION]" @@ -192,10 +192,10 @@ usage() { echo "Usage: $REL_NAME COMMAND [help]" echo '' echo "Commonly used COMMANDs:" - echo " start: Start EMQ X in daemon mode" - echo " console: Start EMQ X in an interactive Erlang or Elixir shell" - echo " foreground: Start EMQ X in foreground mode without an interactive shell" - echo " stop: Stop the running EMQ X node" + echo " start: Start EMQX in daemon mode" + echo " console: Start EMQX in an interactive Erlang or Elixir shell" + echo " foreground: Start EMQX in foreground mode without an interactive shell" + echo " stop: Stop the running EMQX node" echo " ctl: Administration commands, execute '$REL_NAME ctl help' for more details" echo '' echo "More:" @@ -237,7 +237,7 @@ if ! check_erlang_start >/dev/null 2>&1; then echoerr "FATAL: Unable to start Erlang." echoerr "Please make sure openssl-1.1.1 (libcrypto) and libncurses are installed." echoerr "Also ensure it's running on the correct platform," - echoerr "this EMQ X release is built for $BUILT_ON" + echoerr "this EMQX release is built for $BUILT_ON" exit 1 fi echoerr "WARNING: There seem to be missing dynamic libs from the OS. Using libs from ${DYNLIBS_DIR}" diff --git a/bin/node_dump b/bin/node_dump index 20b36b826..a628c4ed0 100755 --- a/bin/node_dump +++ b/bin/node_dump @@ -25,7 +25,7 @@ collect() { } show_help() { - echo "Collect information about the EMQ X node + echo "Collect information about the EMQX node USAGE: diff --git a/build b/build index 5d98fa026..2f6712abb 100755 --- a/build +++ b/build @@ -125,7 +125,7 @@ cp_dyn_libs() { | sort -u) } -## Re-pack the relx assembled .tar.gz to EMQ X's package naming scheme +## Re-pack the relx assembled .tar.gz to EMQX's package naming scheme ## It assumes the .tar.gz has been built -- relies on Makefile dependency make_tgz() { local pkgpath="_packages/${PROFILE}" @@ -186,7 +186,7 @@ make_docker() { ## This function accepts any base docker image, ## a emqx tgz-image, and a image tag (for the image to be built), -## to build a docker image which runs EMQ X +## to build a docker image which runs EMQX ## ## Export below variables to quickly build an image ## diff --git a/deploy/charts/emqx/Chart.yaml b/deploy/charts/emqx/Chart.yaml index f76e0c1aa..02785ccce 100644 --- a/deploy/charts/emqx/Chart.yaml +++ b/deploy/charts/emqx/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v2 name: emqx icon: https://github.com/emqx.png -description: A Helm chart for EMQ X +description: A Helm chart for EMQX # A chart can be either an 'application' or a 'library' chart. # # Application charts are a collection of templates that can be packaged into versioned archives diff --git a/deploy/docker/docker-entrypoint.sh b/deploy/docker/docker-entrypoint.sh index c2744aec4..21a9ac43b 100755 --- a/deploy/docker/docker-entrypoint.sh +++ b/deploy/docker/docker-entrypoint.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash ## EMQ docker image start script # Huang Rui -# EMQ X Team +# EMQX Team ## Shell setting if [[ -n "$DEBUG" ]]; then diff --git a/deploy/packages/deb/debian/control b/deploy/packages/deb/debian/control index 66b58047f..5bef99a93 100644 --- a/deploy/packages/deb/debian/control +++ b/deploy/packages/deb/debian/control @@ -9,4 +9,4 @@ Homepage: https://www.emqx.com Package: emqx Architecture: any Depends: ${shlibs:Depends}, ${misc:Depends} -Description: EMQ X, a distributed, massively scalable, highly extensible MQTT message broker. +Description: EMQX, a distributed, massively scalable, highly extensible MQTT message broker. diff --git a/deploy/packages/rpm/emqx.spec b/deploy/packages/rpm/emqx.spec index c6fc60e64..461c3024c 100644 --- a/deploy/packages/rpm/emqx.spec +++ b/deploy/packages/rpm/emqx.spec @@ -26,7 +26,7 @@ Requires: libatomic %endif %description -EMQ X, a distributed, massively scalable, highly extensible MQTT message broker. +EMQX, a distributed, massively scalable, highly extensible MQTT message broker. %prep diff --git a/lib-ee/BSL.txt b/lib-ee/BSL.txt index 3f58718a1..b361a8bd7 100644 --- a/lib-ee/BSL.txt +++ b/lib-ee/BSL.txt @@ -1,7 +1,7 @@ Business Source License 1.1 Licensor: Hangzhou EMQ Technologies Co., Ltd. -Licensed Work: EMQ X Enterprise Edition +Licensed Work: EMQX Enterprise Edition The Licensed Work is (c) 2021 Hangzhou EMQ Technologies Co., Ltd. Additional Use Grant: Students and educators are granted right to copy, diff --git a/lib-ee/emqx_license/include/emqx_license.hrl b/lib-ee/emqx_license/include/emqx_license.hrl index a906b7b4e..93a8c8cec 100644 --- a/lib-ee/emqx_license/include/emqx_license.hrl +++ b/lib-ee/emqx_license/include/emqx_license.hrl @@ -1,7 +1,7 @@ %%-------------------------------------------------------------------- %% Copyright (c) 2022 EMQ Technologies Co., Ltd. All Rights Reserved. %% -%% @doc EMQ X License Management CLI. +%% @doc EMQX License Management CLI. %%-------------------------------------------------------------------- -ifndef(_EMQX_LICENSE_). diff --git a/mix.exs b/mix.exs index 9373fb70e..5b392d0fc 100644 --- a/mix.exs +++ b/mix.exs @@ -588,13 +588,13 @@ defmodule EMQXUmbrella.MixProject do defp emqx_description(release_type, edition_type) do case {release_type, edition_type} do {:cloud, :enterprise} -> - "EMQ X Enterprise Edition" + "EMQX Enterprise Edition" {:cloud, :community} -> - "EMQ X Community Edition" + "EMQX Community Edition" {:edge, :community} -> - "EMQ X Edge Edition" + "EMQX Edge Edition" end end diff --git a/scripts/buildx.sh b/scripts/buildx.sh index 049dff971..6ce40b207 100755 --- a/scripts/buildx.sh +++ b/scripts/buildx.sh @@ -15,13 +15,13 @@ set -euo pipefail help() { echo echo "-h|--help: To display this usage information" - echo "--profile : EMQ X profile to build, e.g. emqx, emqx-edge" + echo "--profile : EMQX profile to build, e.g. emqx, emqx-edge" echo "--pkgtype tgz|pkg: Specify which package to build, tgz for .tar.gz," echo " pkg for .rpm or .deb" echo "--with-elixir: Specify if the release should be built with Elixir, " echo " defaults to false." - echo "--arch amd64|arm64: Target arch to build the EMQ X package for" - echo "--src_dir : EMQ X source ode in this dir, default to PWD" + echo "--arch amd64|arm64: Target arch to build the EMQX package for" + echo "--src_dir : EMQX source ode in this dir, default to PWD" echo "--builder : Builder image to pull" echo " E.g. ghcr.io/emqx/emqx-builder/4.4-4:24.1.5-3-debian10" echo "--otp : OTP version being used in the builder" diff --git a/scripts/relup-base-vsns.sh b/scripts/relup-base-vsns.sh index 5a94b58e3..87889e1f9 100755 --- a/scripts/relup-base-vsns.sh +++ b/scripts/relup-base-vsns.sh @@ -2,7 +2,7 @@ set -euo pipefail ## This script prints the relup upgrade base versions -## for the given EMQ X edition (specified as first arg) +## for the given EMQX edition (specified as first arg) ## ## The second argument is the current release version ## if not provided, it's taken from pkg-vsn.sh