Update docs for deprecate-integer-display-length=true (#19159)

pingcap · Nov 26, 2024 · 4f968f2 · 4f968f2
1 parent 9f72c57
commit 4f968f2
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 1 deletion.
diff --git a/data-type-numeric.md b/data-type-numeric.md
@@ -18,6 +18,22 @@ TiDB supports all the MySQL integer types, including `INTEGER`/`INT`, `TINYINT`,
 
 The following table summarizes field descriptions:
 
+<CustomContent platform="tidb">
+
+> **Warning:**
+>
+> Starting from v8.5.0, integer display width is deprecated ([`deprecate-integer-display-length`](/tidb-configuration-file.md#deprecate-integer-display-length) is `true` by default). Specifying display width for integer types is NOT recommended.
+
+</CustomContent>
+
+<CustomContent platform="tidb-cloud">
+
+> **Warning:**
+>
+> Starting from v8.5.0, integer display width is deprecated. Specifying display width for integer types is NOT recommended.
+
+</CustomContent>
+
 | Syntax Element | Description |
 | -------- | ------------------------------- |
 | M | the display width of the type. Optional. |

diff --git a/data-type-overview.md b/data-type-overview.md
@@ -12,5 +12,22 @@ The definitions used for datatypes are specified as `T(M[, D])`. Where by:
 
 - `T` indicates the specific data type.
 - `M` indicates the maximum display width for integer types. For floating-point and fixed-point types, `M` is the total number of digits that can be stored (the precision). For string types, `M` is the maximum length. The maximum permissible value of M depends on the data type.
+
+<CustomContent platform="tidb">
+
+> **Warning:**
+>
+> Starting from v8.5.0, integer display width is deprecated ([`deprecate-integer-display-length`](/tidb-configuration-file.md#deprecate-integer-display-length) is `true` by default). Specifying display width for integer types is NOT recommended.
+
+</CustomContent>
+
+<CustomContent platform="tidb-cloud">
+
+> **Warning:**
+>
+> Starting from v8.5.0, integer display width is deprecated. Specifying display width for integer types is NOT recommended.
+
+</CustomContent>
+
 - `D` applies to floating-point and fixed-point types and indicates the number of digits following the decimal point (the scale).
 - `fsp` applies to the `TIME`, `DATETIME`, and `TIMESTAMP` types and represents the fractional seconds precision. The `fsp` value, if given, must be in the range 0 to 6. A value of 0 signifies that there is no fractional part. If omitted, the default precision is 0.
diff --git a/tidb-configuration-file.md b/tidb-configuration-file.md
@@ -183,7 +183,7 @@ The TiDB configuration file supports more options than command-line parameters.
 ### `deprecate-integer-display-length`
 
 - Deprecates the display width for integer types when this configuration item is set to `true`.
-- Default value: `false`
+- Default value: `true`. Before v8.5.0, the default value is `false`.
 
 ### `enable-tcp4-only` <span class="version-mark">New in v5.0</span>