You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by ji...@apache.org on 2020/12/14 00:54:59 UTC

[iotdb] branch master updated: fix doc error

This is an automated email from the ASF dual-hosted git repository.

jiangtian pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git


The following commit(s) were added to refs/heads/master by this push:
     new 316f30d  fix doc error
     new c666c3a  Merge pull request #2260 from neuyilan/apache_master_1213_fix_docs
316f30d is described below

commit 316f30da815c9db6da3ae3f4cca5c32ced56b888
Author: HouliangQi <ne...@163.com>
AuthorDate: Sun Dec 13 12:42:14 2020 +0800

    fix doc error
---
 cluster/src/assembly/resources/sbin/add-node.bat |  6 +++---
 cluster/src/assembly/resources/sbin/add-node.sh  |  6 +++---
 docs/UserGuide/Server/Cluster Setup.md           | 10 +++++-----
 docs/UserGuide/Server/ServerFileList.md          |  1 -
 docs/zh/UserGuide/Server/Cluster Setup.md        | 14 +++++++-------
 docs/zh/UserGuide/Server/ServerFileList.md       |  1 -
 6 files changed, 18 insertions(+), 20 deletions(-)

diff --git a/cluster/src/assembly/resources/sbin/add-node.bat b/cluster/src/assembly/resources/sbin/add-node.bat
index cdaf94a..958f16f 100755
--- a/cluster/src/assembly/resources/sbin/add-node.bat
+++ b/cluster/src/assembly/resources/sbin/add-node.bat
@@ -57,10 +57,10 @@ popd
 set IOTDB_CONF=%IOTDB_HOME%\conf
 set IOTDB_LOGS=%IOTDB_HOME%\logs
 
-IF EXIST "%IOTDB_CONF%\cluster-env.bat" (
-    CALL "%IOTDB_CONF%\cluster-env.bat"
+IF EXIST "%IOTDB_CONF%\iotdb-env.bat" (
+    CALL "%IOTDB_CONF%\iotdb-env.bat"
     ) ELSE (
-    echo "can't find %IOTDB_CONF%\cluster-env.bat"
+    echo "can't find %IOTDB_CONF%\iotdb-env.bat"
     )
 
 if NOT DEFINED MAIN_CLASS set MAIN_CLASS=org.apache.iotdb.cluster.ClusterMain
diff --git a/cluster/src/assembly/resources/sbin/add-node.sh b/cluster/src/assembly/resources/sbin/add-node.sh
index 46d9edc..0ed52e5 100755
--- a/cluster/src/assembly/resources/sbin/add-node.sh
+++ b/cluster/src/assembly/resources/sbin/add-node.sh
@@ -30,10 +30,10 @@ fi
 IOTDB_CONF=${IOTDB_HOME}/conf
 # IOTDB_LOGS=${IOTDB_HOME}/logs
 
-if [ -f "$IOTDB_CONF/cluster-env.sh" ]; then
-    . "$IOTDB_CONF/cluster-env.sh"
+if [ -f "$IOTDB_CONF/iotdb-env.sh" ]; then
+    . "$IOTDB_CONF/iotdb-env.sh"
 else
-    echo "can't find $IOTDB_CONF/cluster-env.sh"
+    echo "can't find $IOTDB_CONF/iotdb-env.sh"
 fi
 
 if [ -n "$JAVA_HOME" ]; then
diff --git a/docs/UserGuide/Server/Cluster Setup.md b/docs/UserGuide/Server/Cluster Setup.md
index bbb00e9..3945057 100644
--- a/docs/UserGuide/Server/Cluster Setup.md	
+++ b/docs/UserGuide/Server/Cluster Setup.md	
@@ -61,16 +61,16 @@ When both exist, the specified configuration item will overwrite the configurati
 > sed -i -e 's/6667/6669/g' ./cluster/target/cluster-0.11.0-SNAPSHOT2/conf/iotdb-engine.properties
 
 # Second step: Unix/OS X/Windows (git bash or WSL)
-> sed -i -e 's/31999/32000/g' ./cluster/target/cluster-0.11.0-SNAPSHOT1/conf/cluster-env.sh
-> sed -i -e 's/31999/32001/g' ./cluster/target/cluster-0.11.0-SNAPSHOT2/conf/cluster-env.sh
+> sed -i -e 's/31999/32000/g' ./cluster/target/cluster-0.11.0-SNAPSHOT1/conf/iotdb-env.sh
+> sed -i -e 's/31999/32001/g' ./cluster/target/cluster-0.11.0-SNAPSHOT2/conf/iotdb-env.sh
 > chmod -R 777 ./cluster/target/
 > nohup ./cluster/target/cluster-0.11.0-SNAPSHOT/sbin/start-node.sh >/dev/null 2>&1 &
 > nohup ./cluster/target/cluster-0.11.0-SNAPSHOT1/sbin/start-node.sh -internal_meta_port 9005 -internal_data_port 40012 -cluster_rpc_port 55561 >/dev/null 2>&1 &
 > nohup ./cluster/target/cluster-0.11.0-SNAPSHOT2/sbin/start-node.sh -internal_meta_port 9007 -internal_data_port 40014 -cluster_rpc_port 55562 >/dev/null 2>&1 &
 
 # Second step: Windows (MinGW)
-> sed -i -e 's/31999/32000/g'  cluster\target\cluster-0.11.0-SNAPSHOT\conf\cluster-env.bat
-> sed -i -e 's/31999/32001/g'  cluster\target\cluster-0.11.0-SNAPSHOT\conf\cluster-env.bat
+> sed -i -e 's/31999/32000/g'  cluster\target\cluster-0.11.0-SNAPSHOT\conf\iotdb-env.bat
+> sed -i -e 's/31999/32001/g'  cluster\target\cluster-0.11.0-SNAPSHOT\conf\iotdb-env.bat
 > nohup cluster\target\cluster-0.11.0-SNAPSHOT\sbin\start-node.bat 
 > nohup cluster\target\cluster-0.11.0-SNAPSHOT1\sbin\start-node.bat  -internal_meta_port 9005 -internal_data_port 40012 -cluster_rpc_port 55561
 > nohup cluster\target\cluster-0.11.0-SNAPSHOT2\sbin\start-node.bat  -internal_meta_port 9007 -internal_data_port 40014 -cluster_rpc_port 55562
@@ -106,7 +106,7 @@ What's more, Users can configure settings of TsFile (the data files), such as th
 
 * `iotdb-cluster.properties`. Some configurations required by IoTDB cluster. Such as replication number(`default_replica_num`), etc.
 
-For detailed description of the two configuration files `iotdb-engine.properties`, `cluster-env.sh`/`cluster-env.bat`, please refer to [Configuration Manual](Config%20Manual.md). 
+For detailed description of the two configuration files `iotdb-engine.properties`, `iotdb-env.sh`/`iotdb-env.bat`, please refer to [Configuration Manual](Config%20Manual.md). 
 The configuration items described below are in the `iotdb-cluster.properties` file.
 
 * internal\_meta\_port
diff --git a/docs/UserGuide/Server/ServerFileList.md b/docs/UserGuide/Server/ServerFileList.md
index 718eecc..6fd5df4 100644
--- a/docs/UserGuide/Server/ServerFileList.md
+++ b/docs/UserGuide/Server/ServerFileList.md
@@ -120,7 +120,6 @@
 
 ## Configuration Files
 1. iotdb-cluster.properties
-2. cluster-env.sh
 
 ## State Related Files
 > under directory basedir/
diff --git a/docs/zh/UserGuide/Server/Cluster Setup.md b/docs/zh/UserGuide/Server/Cluster Setup.md
index 4738eed..87a3445 100644
--- a/docs/zh/UserGuide/Server/Cluster Setup.md	
+++ b/docs/zh/UserGuide/Server/Cluster Setup.md	
@@ -55,16 +55,16 @@ or
 > sed -i -e 's/6667/6669/g' ./cluster/target/cluster-0.11.0-SNAPSHOT2/conf/iotdb-engine.properties
 
 # 第二步: Unix/OS X/Windows (git bash or WSL)
-> sed -i -e 's/31999/32000/g' ./cluster/target/cluster-0.11.0-SNAPSHOT1/conf/cluster-env.sh
-> sed -i -e 's/31999/32001/g' ./cluster/target/cluster-0.11.0-SNAPSHOT2/conf/cluster-env.sh
+> sed -i -e 's/31999/32000/g' ./cluster/target/cluster-0.11.0-SNAPSHOT1/conf/iotdb-env.sh
+> sed -i -e 's/31999/32001/g' ./cluster/target/cluster-0.11.0-SNAPSHOT2/conf/iotdb-env.sh
 > chmod -R 777 ./cluster/target/
 > nohup ./cluster/target/cluster-0.11.0-SNAPSHOT/sbin/start-node.sh >/dev/null 2>&1 &
 > nohup ./cluster/target/cluster-0.11.0-SNAPSHOT1/sbin/start-node.sh -internal_meta_port 9005 -internal_data_port 40012 -cluster_rpc_port 55561 >/dev/null 2>&1 &
 > nohup ./cluster/target/cluster-0.11.0-SNAPSHOT2/sbin/start-node.sh -internal_meta_port 9007 -internal_data_port 40014 -cluster_rpc_port 55562 >/dev/null 2>&1 &
 
 # 第二步: Windows (MinGW)
-> sed -i -e 's/31999/32000/g'  cluster\target\cluster-0.11.0-SNAPSHOT\conf\cluster-env.bat
-> sed -i -e 's/31999/32001/g'  cluster\target\cluster-0.11.0-SNAPSHOT\conf\cluster-env.bat
+> sed -i -e 's/31999/32000/g'  cluster\target\cluster-0.11.0-SNAPSHOT\conf\iotdb-env.bat
+> sed -i -e 's/31999/32001/g'  cluster\target\cluster-0.11.0-SNAPSHOT\conf\iotdb-env.bat
 > nohup cluster\target\cluster-0.11.0-SNAPSHOT\sbin\start-node.bat 
 > nohup cluster\target\cluster-0.11.0-SNAPSHOT1\sbin\start-node.bat  -internal_meta_port 9005 -internal_data_port 40012 -cluster_rpc_port 55561
 > nohup cluster\target\cluster-0.11.0-SNAPSHOT2\sbin\start-node.bat  -internal_meta_port 9007 -internal_data_port 40014 -cluster_rpc_port 55562
@@ -88,11 +88,11 @@ iotdb-engines.properties配置文件中的部分内容会不再生效:
 
 为方便IoTDB Server的配置与管理,IoTDB Server为用户提供三种配置项,使得您可以在启动服务器或服务器运行时对其进行配置。
 
-三种配置项的配置文件均位于IoTDB安装目录:`$IOTDB_HOME/conf`文件夹下,其中涉及server配置的共有4个文件,分别为:`iotdb-cluster.properties`、`iotdb-engine.properties`、`logback.xml` 和 `cluster-env.sh`(Unix系统)/`cluster-env.bat`(Windows系统), 您可以通过更改其中的配置项对系统运行的相关配置项进行配置。
+三种配置项的配置文件均位于IoTDB安装目录:`$IOTDB_HOME/conf`文件夹下,其中涉及server配置的共有4个文件,分别为:`iotdb-cluster.properties`、`iotdb-engine.properties`、`logback.xml` 和 `iotdb-env.sh`(Unix系统)/`iotdb-env.bat`(Windows系统), 您可以通过更改其中的配置项对系统运行的相关配置项进行配置。
 
 配置文件的说明如下:
 
-* `cluster-env.sh`/`cluster-env.bat`:环境配置项的默认配置文件。您可以在文件中配置JAVA-JVM的相关系统配置项。
+* `iotdb-env.sh`/`iotdb-env.bat`:环境配置项的默认配置文件。您可以在文件中配置JAVA-JVM的相关系统配置项。
 
 * `iotdb-engine.properties`:IoTDB引擎层系统配置项的默认配置文件。您可以在文件中配置IoTDB引擎运行时的相关参数。此外,用户可以在文件中配置IoTDB存储时TsFile文件的相关信息,如每次将内存中的数据写入到磁盘前的缓存大小(`group_size_in_byte`),内存中每个列打一次包的大小(`page_size_in_byte`)等。
 
@@ -100,7 +100,7 @@ iotdb-engines.properties配置文件中的部分内容会不再生效:
 
 * `iotdb-cluster.properties`: IoTDB集群所需要的一些配置。
 
-`iotdb-engine.properties`、`cluster-env.sh`/`cluster-env.bat` 两个配置文件详细说明请参考[配置手册](Config%20Manual.md),下面描述的配置项是在`iotdb-cluster.properties`文件中的。
+`iotdb-engine.properties`、`iotdb-env.sh`/`iotdb-env.bat` 两个配置文件详细说明请参考[配置手册](Config%20Manual.md),下面描述的配置项是在`iotdb-cluster.properties`文件中的。
 
 * internal\_meta\_port
 
diff --git a/docs/zh/UserGuide/Server/ServerFileList.md b/docs/zh/UserGuide/Server/ServerFileList.md
index 2b183e1..1fac212 100644
--- a/docs/zh/UserGuide/Server/ServerFileList.md
+++ b/docs/zh/UserGuide/Server/ServerFileList.md
@@ -117,7 +117,6 @@
 
 ## 配置文件
 1. iotdb-cluster.properties
-2. cluster-env.sh
 
 ## 状态相关文件
 > 在basedir目录下