tidb-lightning: clarify an ambiguous description for sorted-kv-dir (#…

…7962) (#7966)
pingcap · Mar 28, 2022 · a430bf1 · a430bf1
1 parent 21ff6ff
commit a430bf1
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/migrate-from-aurora-using-lightning.md b/migrate-from-aurora-using-lightning.md
@@ -46,7 +46,7 @@ Based on different deployment methods, edit the `tidb-lighting.toml` configurati
     [tikv-importer]
     # Uses Local-backend.
     backend = "local"
-    # The storage path of local temporary files. Ensure that the corresponding directory does not exist or is empty and that the disk capacity is large enough for storage.
+    # The storage path of local temporary files. Ensure that the corresponding directory does not exist or is empty and that the disk capacity is greater than the size of the dataset to be imported.
     sorted-kv-dir = "/path/to/local-temp-dir"
     ```
 

diff --git a/tidb-lightning/deploy-tidb-lightning.md b/tidb-lightning/deploy-tidb-lightning.md
@@ -94,7 +94,9 @@ Refer to the [TiDB enterprise tools download page](/download-ecosystem-tools.md#
 
 2. Mount the data source onto the same machine.
 
-3. Configure `tidb-lightning.toml`. For configurations that do not appear in the template below, TiDB Lightning writes a configuration error to the log file and exits. `sorted-kv-dir` must be an empty directory and the disk where the directory is located must have a lot of free space.
+3. Configure `tidb-lightning.toml`. For configurations that do not appear in the template below, TiDB Lightning writes a configuration error to the log file and exits.
+
+    `sorted-kv-dir` sets the temporary storage directory for the sorted Key-Value files. The directory must be empty, and the storage space **must be greater than the size of the dataset to be imported**.
 
     ```toml
     [lightning]