文档标题(与文首 metadata 中的 title 名称保持一致)

模板说明:

  • 本文档为参考手册类模板,主要包含命令、参数、选项等参考解释信息。你可直接复制使用,并删除模板中不需要的说明。该类文档示例:TiDB 集群报警规则与处理方法
  • 对于新文档,请在 TOC.md 中合适的位置加目录(思考用户最有可能在目录哪里找文档)。
  • 文内标题级别不可跳级,尽量避免使用五级标题。

[必须]第一段对该文档进行概括性介绍,几句话即可。

可采用类似“本文介绍……”的句型。

二级标题 1(文内标题级别不可跳级,通常为大类的名称,或者直接是参数名)

用一两句话简要介绍这一节的内容。

三级标题 1(可选,如参数名)

如需列举多个参数/配置项,可以使用无序列表(*/+/-):

  • xxx:xxx
  • xxx:xxx
  • xxx:xxx

三级标题 2

xxx

二级标题 2

如果需要添加注意或警告事项,需严格遵循以下格式,其中,“注意”为一般的提示,“警告”含义则为”不要这样做“。示例如下:

注意:

读取历史数据时,即使当前数据的表结构相较于历史数据的表结构已经发生改变,历史数据也会以当时的历史表结构来返回。

警告:

xxxxxxxxxxxxxx。

如果注意或警告事项嵌套在列表内,需要缩进四个空格(官网文档中的缩进建议统一采用四个空格,以避免 PingCAP 官网显示错乱)。

二级标题 3

如需使用表格,应注意表格必须有表头(即第一行),且表格后需空一行。

下表列出了具体配置项/参数的说明、默认值和示例等相关信息。

参数 说明 默认值 是否必填 示例
xxx xxx xxx xxx xxx