fix lint issues

pingcap · Jul 11, 2019 · 948ced1 · 948ced1
1 parent 5ba542c
commit 948ced1
Show file tree

Hide file tree

Showing 40 changed files with 104 additions and 115 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -3,10 +3,6 @@ name: "\U0001F41B Bug Report"
 about: Typo, Grammatical error, etc.。
 ---
 
-<!-- markdownlint-disable MD012 -->
-<!-- markdownlint-disable MD029 -->
-<!-- markdownlint-disable MD041 -->
-
 ## Bug 报告
 
 **This repository is ONLY used to solve problems related to DOCS-CN.

diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -3,10 +3,6 @@ name: "\U0001F680 Feature Request"
 about: Any suggestion? Want to add something new?
 ---
 
-<!-- markdownlint-disable MD012 -->
-<!-- markdownlint-disable MD029 -->
-<!-- markdownlint-disable MD041 -->
-
 ## Feature Request
 
 **This repository is ONLY used to solve problems related to DOCS-CN.

diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
@@ -3,8 +3,6 @@ name: "\U0001F914 Question"
 about: Usage question that isn't answered in docs or discussion
 ---
 
-<!-- markdownlint-disable MD041 -->
-
 ## Question
 
 **This repository is ONLY used to solve problems related to DOCS-CN.

diff --git a/v2.0/tools/tidb-binlog-kafka.md b/v2.0/tools/tidb-binlog-kafka.md
@@ -159,7 +159,7 @@ ZK3="192.168.0.11"
     -data-dir string
         Pump 数据存储位置路径
     -enable-tolerant
-        开启 tolerant 后，如果 binlog 写入失败，Pump 不会报错（默认开启）
+        开启 tolerant 后，如果 binlog 写入失败，Pump 不会报错（默认开启）
     -zookeeper-addrs string (-zookeeper_addrs = "192.168.0.11:2181,192.168.0.12:2181,192.168.0.13:2181")
         ZooKeeper 地址，该选项从 ZooKeeper 中获取 Kafka 地址
     -gc int

diff --git a/v2.1-legacy/op-guide/tune-tikv.md b/v2.1-legacy/op-guide/tune-tikv.md
@@ -229,11 +229,11 @@ block-cache-size = "256MB"
 
 除了以上列出的 `block-cache` 以及 `write-buffer` 会占用系统内存外：
 
-1.  需预留一些内存作为系统的 page cache
-2.  TiKV 在处理大的查询的时候（例如 `select * from ...`）会读取数据然后在内存中生成对应的数据结构返回给 TiDB，这个过程中 TiKV 会占用一部分内存
+1. 需预留一些内存作为系统的 page cache
+2. TiKV 在处理大的查询的时候（例如 `select * from ...`）会读取数据然后在内存中生成对应的数据结构返回给 TiDB，这个过程中 TiKV 会占用一部分内存
 
 ## TiKV 机器配置推荐
 
-1.  生产环境中，不建议将 TiKV 部署在 CPU 核数小于 8 或内存低于 32GB 的机器上
-2.  如果对写入吞吐要求比较高，建议使用吞吐能力比较好的磁盘
-3.  如果对读写的延迟要求非常高，建议使用 IOPS 比较高的 SSD 盘
+1. 生产环境中，不建议将 TiKV 部署在 CPU 核数小于 8 或内存低于 32GB 的机器上
+2. 如果对写入吞吐要求比较高，建议使用吞吐能力比较好的磁盘
+3. 如果对读写的延迟要求非常高，建议使用 IOPS 比较高的 SSD 盘
diff --git a/v2.1-legacy/releases/11alpha.md b/v2.1-legacy/releases/11alpha.md
@@ -7,7 +7,7 @@ category: Releases
 
 2018 年 1 月 19 日，TiDB 发布 1.1 Alpha 版。该版本对 MySQL 兼容性、SQL 优化器、系统稳定性、性能做了大量的工作。
 
-## TiDB：
+## TiDB
 
 - SQL parser
     - 兼容更多语法
@@ -28,15 +28,15 @@ category: Releases
 - Server
     - 支持 PROXY protocol
 
-## PD：
+## PD
 
 - 增加更多的 API
 - 支持 TLS
 - 给 Simulator 增加更多的 case
 - 调度适应不同的 Region size
 - Fix 了一些调度的 bug
 
-## TiKV：
+## TiKV
 
 - 支持 Raft learner
 - 优化 Raft Snapshot，减少 I/O 开销

diff --git a/v2.1-legacy/releases/11beta.md b/v2.1-legacy/releases/11beta.md
@@ -46,4 +46,4 @@ category: Releases
 + 设置 Raft snapshot max size，防止遗留文件占用太多空间
 + `tikv-ctl` 支持更多修复操作
 + 优化有序流式聚合操作
-+ 完善 metrics，修复 bug
++ 完善 metrics，修复 bug
diff --git a/v2.1-legacy/releases/2.0.10.md b/v2.1-legacy/releases/2.0.10.md
@@ -36,4 +36,4 @@ category: Releases
 ## TiKV
 
 - 修复迁移 Leader 到新节点时造成请求延时问题 [#3929](https://github.com/tikv/tikv/pull/3929)
-- 修复多余的 Region 心跳 [#3930](https://github.com/tikv/tikv/pull/3930)
+- 修复多余的 Region 心跳 [#3930](https://github.com/tikv/tikv/pull/3930)
diff --git a/v2.1-legacy/releases/2.0.11.md b/v2.1-legacy/releases/2.0.11.md
@@ -10,12 +10,12 @@ category: Releases
 ## TiDB
 
 - 修复 PD 发生异常的情况下，Error 没有被正确处理的问题 [#8764](https://github.com/pingcap/tidb/pull/8764)
-- 修复 Rename 相同表的行为，跟 MySQL 保持一致 [#8809](https://github.com/pingcap/tidb/pull/8809) 
+- 修复 Rename 相同表的行为，跟 MySQL 保持一致 [#8809](https://github.com/pingcap/tidb/pull/8809)
 - 修复 `ADMIN CHECK TABLE` 在 `ADD INDEX` 过程中误报的问题 [#8750](https://github.com/pingcap/tidb/pull/8750)
 - 修复前缀索引在某些情况下，开闭范围区间错误的问题 [#8877](https://github.com/pingcap/tidb/pull/8877)
 - 修复在某些添加列的情况下，`UPDATE` 语句 panic 的问题 [#8904](https://github.com/pingcap/tidb/pull/8904)
 
 ## TiKV
 
-- 修复了两个 Region merge 相关的问题 
-[#4003](https://github.com/tikv/tikv/pull/4003)，[#4004](https://github.com/tikv/tikv/pull/4004)
+- 修复了两个 Region merge 相关的问题
+[#4003](https://github.com/tikv/tikv/pull/4003)，[#4004](https://github.com/tikv/tikv/pull/4004)
diff --git a/v2.1-legacy/releases/2.0ga.md b/v2.1-legacy/releases/2.0ga.md
@@ -153,4 +153,4 @@ TiSpark 使用独立的版本号，现为 1.0 GA。TiSpark 1.0 版本组件提
     - ThriftServer/JDBC 支持
     - Spark-SQL 交互支持
     - PySpark Shell 支持
-    - SparkR 支持
+    - SparkR 支持
diff --git a/v2.1-legacy/releases/2.1.1.md b/v2.1-legacy/releases/2.1.1.md
@@ -43,4 +43,4 @@ category: Releases
     - 优化对导入表的 `analyze` 机制，提升了导入速度
     - 支持 checkpoint 信息储存在本地文件
 + TiDB-Binlog
-    - 修复 pb files 输出 bug，表只有主键列则无法产生 pb event
+    - 修复 pb files 输出 bug，表只有主键列则无法产生 pb event
diff --git a/v2.1-legacy/releases/2.1ga.md b/v2.1-legacy/releases/2.1ga.md
@@ -81,8 +81,8 @@ category: Releases
     - 支持更多 MySQL 语法
     - `BIT` 聚合函数支持 `ALL` 参数
     - 支持 `SHOW PRIVILEGES` 语句
-    - 支持 `LOAD DATA` 语句的 `CHARACTER SET` 语法 
-    - 支持 `CREATE USER` 语句的 `IDENTIFIED WITH` 语法 
+    - 支持 `LOAD DATA` 语句的 `CHARACTER SET` 语法
+    - 支持 `CREATE USER` 语句的 `IDENTIFIED WITH` 语法
     - 支持 `LOAD DATA IGNORE LINES` 语句
     - `Show ProcessList` 语句返回更准确信息
 
@@ -125,7 +125,7 @@ category: Releases
 
 + 监控
 
-    - 增加 `Filter `相关的监控
+    - 增加 `Filter`相关的监控
     - 新增 etcd Raft 状态机相关监控
 
 + 性能优化
@@ -179,9 +179,9 @@ category: Releases
 
 ## 升级兼容性说明
 
-- 由于新版本存储引擎更新，不支持在升级后回退至 2.0.x 或更旧版本
-- 从 2.0.6 之前的版本升级到 2.1 之前，最好确认集群中是否存在正在运行中的 DDL 操作，特别是耗时的 Add Index 操作，等 DDL 操作完成后再执行升级操作
++ 由于新版本存储引擎更新，不支持在升级后回退至 2.0.x 或更旧版本
++ 从 2.0.6 之前的版本升级到 2.1 之前，最好确认集群中是否存在正在运行中的 DDL 操作，特别是耗时的 Add Index 操作，等 DDL 操作完成后再执行升级操作
 + 因为 2.1 版本启用了并行 DDL，对于早于 2.0.1 版本的集群，无法滚动升级到 2.1，可以选择下面两种方案：
 
     - 停机升级，直接从早于 2.0.1 的 TiDB 版本升级到 2.1
-    - 先滚动升级到 2.0.1 或者之后的 2.0.x 版本，再滚动升级到 2.1 版本
+    - 先滚动升级到 2.0.1 或者之后的 2.0.x 版本，再滚动升级到 2.1 版本
diff --git a/v2.1-legacy/releases/201.md b/v2.1-legacy/releases/201.md
@@ -46,4 +46,4 @@ category: Releases
 - 修复特殊情况下开启 learner 无法选举成功的问题
 - 修复极端情况下分裂可能导致的脏读问题
 - 修正读线程池的配置默认值
-- 修正删大数据表会影响写性能的问题
+- 修正删大数据表会影响写性能的问题
diff --git a/v2.1-legacy/releases/202.md b/v2.1-legacy/releases/202.md
@@ -27,4 +27,3 @@ category: Releases
 - 支持配置更多 gRPC 相关参数
 - 支持配置选举超时的取值范围
 - 修复过期 learner 没有删掉的问题
-- 修复 snapshot 中间文件被误删的问题
diff --git a/v2.1-legacy/releases/203.md b/v2.1-legacy/releases/203.md
@@ -34,4 +34,4 @@ category: Releases
 ## TiKV
 
 - 修复 learner flag 错误上报给 PD 的 bug
-- 在 `do_div_mod` 中 `divisor/dividend` 为 0 时返回错误
+- 在 `do_div_mod` 中 `divisor/dividend` 为 0 时返回错误
diff --git a/v2.1-legacy/releases/204.md b/v2.1-legacy/releases/204.md
@@ -15,7 +15,7 @@ category: Releases
 - 优化查询代价估计精度
 - 设置 gRPC 的 `backoff max delay` 参数
 - 支持通过配置文件设置单条语句的内存使用阈值
-- 重构 Optimizer 的 error 
+- 重构 Optimizer 的 error
 - 解决 Cast Decimal 数据的副作用问题
 - 解决特定场景下 `Merge Join` 算子结果错误的问题
 - 解决转换 `Null` 对象到 String 的问题

diff --git a/v2.1-legacy/releases/205.md b/v2.1-legacy/releases/205.md
@@ -37,4 +37,4 @@ category: Releases
 ## TiKV
 
 - 修复 decimal 运算中潜在的溢出问题
-- 修复 merge 过程中可能发生的脏读问题
+- 修复 merge 过程中可能发生的脏读问题
diff --git a/v2.1-legacy/releases/206.md b/v2.1-legacy/releases/206.md
@@ -46,4 +46,4 @@ category: Releases
     - 减少回滚事务的连续标记以提升冲突极端严重下的读性能
     - 限制 RocksDB log 文件的大小和个数以减少长时间运行下不必要的磁盘占用
 - Bug Fixes
-    - 修复字符串转 Decimal 时出现的 crash
+    - 修复字符串转 Decimal 时出现的 crash
diff --git a/v2.1-legacy/releases/207.md b/v2.1-legacy/releases/207.md
@@ -33,4 +33,4 @@ category: Releases
 - Improvement
     - 空集群默认打开 `dynamic-level-bytes` 参数减少空间放大
 - Bug Fix
-    - 在 Region merge 之后更新 Region 的 `approximate size` 和 keys
+    - 在 Region merge 之后更新 Region 的 `approximate size` 和 keys
diff --git a/v2.1-legacy/releases/208.md b/v2.1-legacy/releases/208.md
@@ -17,7 +17,7 @@ category: Releases
     - 修复 `duplicate key update` 在某些情况下没有正确插入值的问题 [#7685](https://github.com/pingcap/tidb/pull/7685)
     - 修复 `UnionScan` 中谓词条件没有下推的问题 [#7726](https://github.com/pingcap/tidb/pull/7726)
     - 修复增加 `TIMESTAMP` 索引没有正确处理时区的问题 [#7812](https://github.com/pingcap/tidb/pull/7812)
-    - 修复某些情况下统计信息模块导致的内存泄露问题 [#7864](https://github.com/pingcap/tidb/pull/7864) 
+    - 修复某些情况下统计信息模块导致的内存泄露问题 [#7864](https://github.com/pingcap/tidb/pull/7864)
     - 修复在某些异常情况下，无法获得 `ANALYZE` 结果的问题 [#7871](https://github.com/pingcap/tidb/pull/7871)
     - 令 `SYSDATE` 不做表达式展开，以返回正确的结果 [#7894](https://github.com/pingcap/tidb/pull/7894)
     - 修复某些情况下，`substring_index` panic 的问题 [#7896](https://github.com/pingcap/tidb/pull/7896)
@@ -26,4 +26,4 @@ category: Releases
 ## TiKV
 
 + Bug 修复
-    - 修复节点宕机时 Raftstore `EntryCache` 占用内存持续上升的问题 [#3529](https://github.com/tikv/tikv/pull/3529)
+    - 修复节点宕机时 Raftstore `EntryCache` 占用内存持续上升的问题 [#3529](https://github.com/tikv/tikv/pull/3529)
diff --git a/v2.1-legacy/releases/209.md b/v2.1-legacy/releases/209.md
@@ -10,7 +10,7 @@ category: Releases
 ## TiDB
 
 - 修复统计信息直方图为空的时候导致的问题 [#7927](https://github.com/pingcap/tidb/pull/7927)
-- 修复 `UNION ALL` 语句在某些情况下 panic 的问题 [#7942](https://github.com/pingcap/tidb/pull/7942) 
+- 修复 `UNION ALL` 语句在某些情况下 panic 的问题 [#7942](https://github.com/pingcap/tidb/pull/7942)
 - 修复错误的 DDL JOB 情况下导致的递归溢出问题 [#7959](https://github.com/pingcap/tidb/pull/7959)
 - 为 `Commit` 操作加上慢操作日志 [#7983](https://github.com/pingcap/tidb/pull/7983)
 - 修复 `Limit` 值太大的情况下导致的 panic 问题 [#8004](https://github.com/pingcap/tidb/pull/8004)
@@ -43,4 +43,4 @@ category: Releases
 
 - 增加 `kv_scan` 接口扫描上界的限制 [#3749](https://github.com/tikv/tikv/pull/3749)
 - 废弃配置 `max-tasks-xxx` 并新增 `max-tasks-per-worker-xxx` [#3093](https://github.com/tikv/tikv/pull/3093)
-- 修复 RocksDB `CompactFiles` 的问题 [#3789](https://github.com/tikv/tikv/pull/3789)
+- 修复 RocksDB `CompactFiles` 的问题 [#3789](https://github.com/tikv/tikv/pull/3789)
diff --git a/v2.1-legacy/releases/21beta.md b/v2.1-legacy/releases/21beta.md
@@ -41,11 +41,11 @@ category: Releases
     - 添加 `tidb_disable_txn_auto_retry` 系统变量控制事务是否自动重试
     - 修复写入 `time` 类型的数据精度问题
     - 支持本地冲突事务排队，优化冲突事务性能
-    - 修复 `UPDATE` 语句的 `Affected Rows` 
+    - 修复 `UPDATE` 语句的 `Affected Rows`
     - 优化 `insert ignore on duplicate key update` 语句性能
     - 优化 `Create Table` 语句的执行速度
     - 优化 `Add index` 的速度，在某些场景下速度大幅提升
-    - 修复 `Alter table add column` 增加列超过表的列数限制的问题 
+    - 修复 `Alter table add column` 增加列超过表的列数限制的问题
     - 修复在某些异常情况下 DDL 任务重试导致 TiKV 压力增加的问题
     - 修复在某些异常情况下 TiDB 不断重载 Schema 信息的问题
 - DDL
@@ -65,7 +65,7 @@ category: Releases
 - `region merge` 调度时跳过数据行数较多的 Region
 - 默认开启 `raft learner` 功能，降低调度时出现宕机导致数据不可用的风险
 - `pd-recover` 移除 max-replica 参数
-- 增加 `Filter `相关的 metrics
+- 增加 `Filter`相关的 metrics
 - 修复 tikv-ctl unsafe recovery 之后 Region 信息没更新的问题
 - 修复某些场景下副本迁移导致 TiKV 磁盘空间耗尽的问题
 - 兼容性提示

diff --git a/v2.1-legacy/releases/21rc1.md b/v2.1-legacy/releases/21rc1.md
@@ -72,7 +72,7 @@ category: Releases
     - 修复 `SET` 和 `ENUM`  类型在 `information_schema` 里的 column size [#7347](https://github.com/pingcap/tidb/pull/7347)
     - 支持建表语句里的 `NATIONAL CHARACTER` 语法 [#7378](https://github.com/pingcap/tidb/pull/7378)
     - 支持 `LOAD DATA` 语句的 `CHARACTER SET` 语法 [#7391](https://github.com/pingcap/tidb/pull/7391)
-    - 修复 `SET` 和 `ENUM `类型的 column info [#7417](https://github.com/pingcap/tidb/pull/7417)
+    - 修复 `SET` 和 `ENUM`类型的 column info [#7417](https://github.com/pingcap/tidb/pull/7417)
     - 支持 `CREATE USER` 语句的 `IDENTIFIED WITH` 语法 [#7402](https://github.com/pingcap/tidb/pull/7402)
     - 修复 `TIMESTAMP` 类型计算过程中丢失精度的问题 [#7418](https://github.com/pingcap/tidb/pull/7418)
     - 支持更多 `SYSTEM` 变量的合法性验证 [#7196](https://github.com/pingcap/tidb/pull/7196)

diff --git a/v2.1-legacy/releases/21rc2.md b/v2.1-legacy/releases/21rc2.md
@@ -116,4 +116,4 @@ category: Releases
 - Bug 修复
     - 修复新分裂 Region 的 PreVote 消息被丢弃导致的 leader 选举问题 [#3557](https://github.com/tikv/tikv/pull/3557)
     - 修复 Region merge 以后 follower 的相关统计信息 [#3573](https://github.com/tikv/tikv/pull/3573)
-    - 修复 local reader 使用过期 Region 信息的问题 [#3565](https://github.com/tikv/tikv/pull/3565)
+    - 修复 local reader 使用过期 Region 信息的问题 [#3565](https://github.com/tikv/tikv/pull/3565)
diff --git a/v2.1-legacy/releases/21rc5.md b/v2.1-legacy/releases/21rc5.md
@@ -45,9 +45,9 @@ category: Releases
     - [#1298](https://github.com/pingcap/pd/pull/1298)
     - [#1299](https://github.com/pingcap/pd/pull/1299)
     - [#1308](https://github.com/pingcap/pd/pull/1308)
-- 修复 `regions/check` API 输出错误的问题 [#1311](https://github.com/pingcap/pd/pull/1311)
-- 修复 PD join 失败后无法重新 join 的问题 [#1279](https://github.com/pingcap/pd/pull/1279)
-- 修复某些情况下 watch leader 会丢失事件的问题 [#1317](https://github.com/pingcap/pd/pull/1317)
++ 修复 `regions/check` API 输出错误的问题 [#1311](https://github.com/pingcap/pd/pull/1311)
++ 修复 PD join 失败后无法重新 join 的问题 [#1279](https://github.com/pingcap/pd/pull/1279)
++ 修复某些情况下 watch leader 会丢失事件的问题 [#1317](https://github.com/pingcap/pd/pull/1317)
 
 ## TiKV
 
@@ -58,4 +58,4 @@ category: Releases
 
 ## Tools
 
-- TiDB 支持 TiDB-Binlog cluster，不兼容旧版本 TiDB-Binlog [#8093](https://github.com/pingcap/tidb/pull/8093)，[使用文档](https://github.com/pingcap/docs-cn/blob/master/tools/tidb-binlog-cluster.md)
+- TiDB 支持 TiDB-Binlog cluster，不兼容旧版本 TiDB-Binlog [#8093](https://github.com/pingcap/tidb/pull/8093)，[使用文档](https://github.com/pingcap/docs-cn/blob/master/tools/tidb-binlog-cluster.md)
diff --git a/v2.1-legacy/releases/2rc1.md b/v2.1-legacy/releases/2rc1.md
@@ -36,4 +36,4 @@ category: Releases
 + 增加获取 metrics 的 gRPC API
 + 启动时候，检查是否使用 SSD
 + 使用 ReadPool 优化读性能，`raw get` 测试性能提升 30%
-+ 完善 metrics，优化 metrics 的使用
++ 完善 metrics，优化 metrics 的使用
diff --git a/v2.1-legacy/releases/2rc3.md b/v2.1-legacy/releases/2rc3.md
@@ -56,4 +56,4 @@ category: Releases
 - 根据 compaction 事件及时更新对应 Region 的 size 信息
 - 对 `scan lock` 的大小进行限制，防止请求超时
 - 使用 `DeleteRange` 加速 Region 删除
-- 支持在线修改 RocksDB 的参数
+- 支持在线修改 RocksDB 的参数
diff --git a/v2.1-legacy/releases/ga.md b/v2.1-legacy/releases/ga.md
@@ -7,33 +7,33 @@ category: Releases
 
 2017 年 10 月 16 日，TiDB 发布 GA 版（TiDB 1.0）。该版本对 MySQL 兼容性、SQL 优化器、系统稳定性、性能做了大量的工作。
 
-## TiDB:
+## TiDB
 
 + SQL 查询优化器
-  - 调整代价模型
-  - Analyze 下推
-  - 函数签名下推
+    - 调整代价模型
+    - Analyze 下推
+    - 函数签名下推
 
 + 优化内部数据格式，减小中间结果大小
 + 提升 MySQL 兼容性
 + 支持 `NO_SQL_CACHE` 语法，控制存储引擎对缓存的使用
 + 重构 Hash Aggregator 算子，降低内存使用
 + 支持 Stream Aggragator 算子
 
-## PD:
+## PD
 
 + 支持基于读流量的热点调度
 + 支持设置 Store 权重，以及基于权重的调度
 
-## TiKV:
+## TiKV
 
 + Coprocessor 支持更多下推函数
 + 支持取样操作下推
 + 支持手动触发数据 Compact，用于快速回收空间
 + 提升性能和稳定性
 + 增加 Debug API，方便调试
 
-## TiSpark Beta Release:
+## TiSpark Beta Release
 
 + 支持可配置框架
 + 支持 ThriftSever/JDBC 和 Spark SQL 脚本入口
@@ -53,7 +53,7 @@ category: Releases
 - 腾讯云
 - 韩国三星研究院
 
-### 感谢以下组织/个人提供出色的开源软件/服务：
+### 感谢以下组织/个人提供出色的开源软件/服务
 
 - Asta Xie
 - CNCF