From 63b7e5832bbdad38a2fb3512c7caf759c2aab45c Mon Sep 17 00:00:00 2001
From: pingcap-github-bot <sre-bot@pingcap.com>
Date: Wed, 15 Apr 2020 18:22:17 +0800
Subject: [PATCH] reference: add a description of max-index-length (#2748)
 (#2764)

* cherry pick #2748 to release-3.0

Signed-off-by: sre-bot <sre-bot@pingcap.com>

* *: fix conflicts

Co-authored-by: Lynn <zimu_xia@126.com>
---
 reference/configuration/tidb-server/configuration-file.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/reference/configuration/tidb-server/configuration-file.md b/reference/configuration/tidb-server/configuration-file.md
index 424fd586fcd9..de89f419b79b 100644
--- a/reference/configuration/tidb-server/configuration-file.md
+++ b/reference/configuration/tidb-server/configuration-file.md
@@ -80,6 +80,13 @@ TiDB 配置文件比命令行参数支持更多的选项。你可以在 [config/
 + 默认值：""
 + 默认情况下，TiDB 版本号格式为：`5.7.${mysql_latest_minor_version}-TiDB-${tidb_version}`。
 
+### `max-index-length`
+
++ 用于设置新建索引的长度限制。
++ 默认值：3072
++ 单位：byte。
++ 目前的合法值范围 `[3072, 3072*4]`。MySQL 和 TiDB v3.0.11 之前版本（不包含 v3.0.11）没有此配置项，不过都对新建索引的长度做了限制。MySQL 对此的长度限制为 `3072`，TiDB 在 v3.0.7 以及之前版本该值为 `3072*4`，在 v3.0.7 之后版本（包含 v3.0.8、v3.0.9 和 v3.0.10）的该值为 `3072`。为了与 MySQL 和 TiDB 之前版本的兼容，添加了此配置项。
+
 ## log
 
 日志相关的配置项。