From 2a3e4c337ec9f8be695e2e3711b6f84744ec37a0 Mon Sep 17 00:00:00 2001 From: Yasuo Honda Date: Thu, 17 Sep 2026 15:47:42 +0900 Subject: [PATCH 1/3] docs: fix "TiDB Cloud file system" casing to match the product name "TiDB Cloud Filesystem" is the product's branded name and is used consistently 243 times across ai/ti/. These 7 reference pages' Options sections used the lowercase generic "TiDB Cloud file system" in 11 places instead, an inconsistent casing of the same product name. Co-Authored-By: Claude Sonnet 5 --- ai/ti/reference/ti-fs-copy-file.md | 8 ++++---- ai/ti/reference/ti-fs-create-hardlink.md | 4 ++-- ai/ti/reference/ti-fs-create-layer.md | 2 +- ai/ti/reference/ti-fs-delete-file.md | 2 +- ai/ti/reference/ti-fs-describe-file.md | 2 +- ai/ti/reference/ti-fs-mount-file-system.md | 2 +- ai/ti/reference/ti-fs-pack-file-system.md | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/ai/ti/reference/ti-fs-copy-file.md b/ai/ti/reference/ti-fs-copy-file.md index 9d1d415ed83d6..5db2115517674 100644 --- a/ai/ti/reference/ti-fs-copy-file.md +++ b/ai/ti/reference/ti-fs-copy-file.md @@ -50,13 +50,13 @@ ti fs copy-file ## Options -- `--append`: Append the contents of a local file to a file in the TiDB Cloud file system. -- `--create-parents`: Create missing local parent directories when copying from a TiDB Cloud file system. +- `--append`: Append the contents of a local file to a file in the TiDB Cloud Filesystem. +- `--create-parents`: Create missing local parent directories when copying from a TiDB Cloud Filesystem. - `--description `: The file description for `--to-remote` operation. - `--dry-run`: Validate the request without applying changes. - `--file-system-id `: Select the file system. You can also set `TI_FS_FILE_SYSTEM_ID`. - `--from-local `: The local source path. -- `--from-remote `: The source path in the TiDB Cloud file system. +- `--from-remote `: The source path in the TiDB Cloud Filesystem. - `--from-stdin`: Read from stdin and write to `--to-remote`. - `--fs-token `: Set the file system token. If omitted, the command uses the `TI_FS_TOKEN` environment variable. If neither is provided, the command uses the local token stored for the selected file system. - `--help`: Display help information. @@ -66,7 +66,7 @@ ti fs copy-file - `--resume`: Resume an active copy operation. - `--tag `: Create tags `key=value` for `--to-remote` operation; repeatable. - `--to-local `: The local destination path. -- `--to-remote `: The destination path in the TiDB Cloud file system. +- `--to-remote `: The destination path in the TiDB Cloud Filesystem. - `--to-stdout`: Write `--from-remote` to stdout. - `--version`: Display version information. diff --git a/ai/ti/reference/ti-fs-create-hardlink.md b/ai/ti/reference/ti-fs-create-hardlink.md index c61db9949cc62..bc18d79465759 100644 --- a/ai/ti/reference/ti-fs-create-hardlink.md +++ b/ai/ti/reference/ti-fs-create-hardlink.md @@ -26,8 +26,8 @@ ti fs create-hardlink ## Options -- `--link-path `: The file path for the hard link being created in the TiDB Cloud file system. \[required] -- `--source-path `: The existing file path in the TiDB Cloud file system. \[required] +- `--link-path `: The file path for the hard link being created in the TiDB Cloud Filesystem. \[required] +- `--source-path `: The existing file path in the TiDB Cloud Filesystem. \[required] - `--dry-run`: Validate the request without applying changes. - `--file-system-id `: Select the file system. You can also set `TI_FS_FILE_SYSTEM_ID`. - `--fs-token `: Set the file system token. If omitted, the command uses the `TI_FS_TOKEN` environment variable. If neither is provided, the command uses the local token stored for the selected file system. diff --git a/ai/ti/reference/ti-fs-create-layer.md b/ai/ti/reference/ti-fs-create-layer.md index a8df7ce9030a8..d7ba6ed8504fe 100644 --- a/ai/ti/reference/ti-fs-create-layer.md +++ b/ai/ti/reference/ti-fs-create-layer.md @@ -30,7 +30,7 @@ ti fs create-layer ## Options -- `--base-root-path `: Base root path in the TiDB Cloud file system. \[required] +- `--base-root-path `: Base root path in the TiDB Cloud Filesystem. \[required] - `--actor-id `: Actor ID identifying the layer owner (for example, the agent name). - `--dry-run`: Validate the request without applying changes. - `--durability-mode `: Set the layer durability mode. The only explicitly supported value is `restore-safe`, which preserves changes in the remote layer so the layer can be restored after the local environment ends. If omitted, the service uses `restore-safe`. diff --git a/ai/ti/reference/ti-fs-delete-file.md b/ai/ti/reference/ti-fs-delete-file.md index 0ce68bea4a38c..63558c740d20f 100644 --- a/ai/ti/reference/ti-fs-delete-file.md +++ b/ai/ti/reference/ti-fs-delete-file.md @@ -26,7 +26,7 @@ ti fs delete-file ## Options -- `--path `: File or directory path in the TiDB Cloud file system. \[required] +- `--path `: File or directory path in the TiDB Cloud Filesystem. \[required] - `--dry-run`: Validate the request without applying changes. - `--file-system-id `: Select the file system. You can also set `TI_FS_FILE_SYSTEM_ID`. - `--fs-token `: Set the file system token. If omitted, the command uses the `TI_FS_TOKEN` environment variable. If neither is provided, the command uses the local token stored for the selected file system. diff --git a/ai/ti/reference/ti-fs-describe-file.md b/ai/ti/reference/ti-fs-describe-file.md index 59c820fb6fa66..01dd4377baaee 100644 --- a/ai/ti/reference/ti-fs-describe-file.md +++ b/ai/ti/reference/ti-fs-describe-file.md @@ -24,7 +24,7 @@ ti fs describe-file ## Options -- `--path `: File or directory path in the TiDB Cloud file system. \[required] +- `--path `: File or directory path in the TiDB Cloud Filesystem. \[required] - `--file-system-id `: Select the file system. You can also set `TI_FS_FILE_SYSTEM_ID`. - `--fs-token `: Set the file system token. If omitted, the command uses the `TI_FS_TOKEN` environment variable. If neither is provided, the command uses the local token stored for the selected file system. - `--help`: Display help information. diff --git a/ai/ti/reference/ti-fs-mount-file-system.md b/ai/ti/reference/ti-fs-mount-file-system.md index 0d3b8dea170fa..23ab6284d6885 100644 --- a/ai/ti/reference/ti-fs-mount-file-system.md +++ b/ai/ti/reference/ti-fs-mount-file-system.md @@ -65,7 +65,7 @@ ti fs mount-file-system - `--read-cache-ttl `: FUSE read cache time to live. \[default: `30s`] - `--read-only`: Read-only mount mode. Requires FUSE; WebDAV rejects this option. Use `--driver fuse` explicitly, or use a scoped token to enforce read-only access at the service level. - `--ready-timeout `: Time to wait for a background mount to become ready. This is a startup timeout, not a timeout for subsequent file reads or writes. [Verify file I/O after mounting](/tidb-cloud-filesystem/filesystem-mount.md#verify-a-mount-before-using-it). \[default: `30s`] -- `--remote-path `: The TiDB Cloud file system root path to mount. \[default: /] +- `--remote-path `: The TiDB Cloud Filesystem root path to mount. \[default: /] - `--unpack-archive-path `: Restore the pack archive before mounting. - `--version`: Display version information. - `--write-back-cache`: Persist FUSE writes locally before writing them to the file system on flush. This behavior is enabled by default; specify `--write-back-cache=false` to disable it. Unavailable for checkpoint mounts, which are always read-only. \[default: true] diff --git a/ai/ti/reference/ti-fs-pack-file-system.md b/ai/ti/reference/ti-fs-pack-file-system.md index a781d8dedf491..7ca069dfc7f04 100644 --- a/ai/ti/reference/ti-fs-pack-file-system.md +++ b/ai/ti/reference/ti-fs-pack-file-system.md @@ -39,7 +39,7 @@ ti fs pack-file-system - `--mount-path `: The local mounted path. - `--mount-profile `: Select a [mount profile](/ai/ti/reference/ti-filesystem.md#mount-profiles-and-local-overlays): `coding-agent`, `portable`, or `none`. If omitted, uses `none`. - `--path `: Local overlay path for packing; repeatable. -- `--remote-root `: The TiDB Cloud file system root represented by the local overlay. \[default: /] +- `--remote-root `: The TiDB Cloud Filesystem root represented by the local overlay. \[default: /] - `--version`: Display version information. For options shared by all commands, see [Global options](/ai/ti/reference/ti-cli-reference.md#global-options). From e0a5959229d68b50ff17323d95e5f252d42eba67 Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Wed, 30 Sep 2026 10:57:07 +0800 Subject: [PATCH 2/3] Apply suggestions from code review --- ai/ti/reference/ti-fs-copy-file.md | 6 +++--- ai/ti/reference/ti-fs-create-hardlink.md | 4 ++-- ai/ti/reference/ti-fs-create-layer.md | 2 +- ai/ti/reference/ti-fs-delete-file.md | 2 +- ai/ti/reference/ti-fs-describe-file.md | 2 +- ai/ti/reference/ti-fs-mount-file-system.md | 2 +- ai/ti/reference/ti-fs-pack-file-system.md | 2 +- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/ai/ti/reference/ti-fs-copy-file.md b/ai/ti/reference/ti-fs-copy-file.md index 5db2115517674..81f644738b46a 100644 --- a/ai/ti/reference/ti-fs-copy-file.md +++ b/ai/ti/reference/ti-fs-copy-file.md @@ -51,12 +51,12 @@ ti fs copy-file ## Options - `--append`: Append the contents of a local file to a file in the TiDB Cloud Filesystem. -- `--create-parents`: Create missing local parent directories when copying from a TiDB Cloud Filesystem. +- `--create-parents`: Create missing local parent directories when copying from a file system. - `--description `: The file description for `--to-remote` operation. - `--dry-run`: Validate the request without applying changes. - `--file-system-id `: Select the file system. You can also set `TI_FS_FILE_SYSTEM_ID`. - `--from-local `: The local source path. -- `--from-remote `: The source path in the TiDB Cloud Filesystem. +- `--from-remote `: The source path in the file system. - `--from-stdin`: Read from stdin and write to `--to-remote`. - `--fs-token `: Set the file system token. If omitted, the command uses the `TI_FS_TOKEN` environment variable. If neither is provided, the command uses the local token stored for the selected file system. - `--help`: Display help information. @@ -66,7 +66,7 @@ ti fs copy-file - `--resume`: Resume an active copy operation. - `--tag `: Create tags `key=value` for `--to-remote` operation; repeatable. - `--to-local `: The local destination path. -- `--to-remote `: The destination path in the TiDB Cloud Filesystem. +- `--to-remote `: The destination path in the file system. - `--to-stdout`: Write `--from-remote` to stdout. - `--version`: Display version information. diff --git a/ai/ti/reference/ti-fs-create-hardlink.md b/ai/ti/reference/ti-fs-create-hardlink.md index bc18d79465759..064cc204d3b7d 100644 --- a/ai/ti/reference/ti-fs-create-hardlink.md +++ b/ai/ti/reference/ti-fs-create-hardlink.md @@ -26,8 +26,8 @@ ti fs create-hardlink ## Options -- `--link-path `: The file path for the hard link being created in the TiDB Cloud Filesystem. \[required] -- `--source-path `: The existing file path in the TiDB Cloud Filesystem. \[required] +- `--link-path `: The file path for the hard link being created in the file system. \[required] +- `--source-path `: The existing file path in the file system. \[required] - `--dry-run`: Validate the request without applying changes. - `--file-system-id `: Select the file system. You can also set `TI_FS_FILE_SYSTEM_ID`. - `--fs-token `: Set the file system token. If omitted, the command uses the `TI_FS_TOKEN` environment variable. If neither is provided, the command uses the local token stored for the selected file system. diff --git a/ai/ti/reference/ti-fs-create-layer.md b/ai/ti/reference/ti-fs-create-layer.md index d7ba6ed8504fe..08813c5ab2723 100644 --- a/ai/ti/reference/ti-fs-create-layer.md +++ b/ai/ti/reference/ti-fs-create-layer.md @@ -30,7 +30,7 @@ ti fs create-layer ## Options -- `--base-root-path `: Base root path in the TiDB Cloud Filesystem. \[required] +- `--base-root-path `: Base root path in the file system. \[required] - `--actor-id `: Actor ID identifying the layer owner (for example, the agent name). - `--dry-run`: Validate the request without applying changes. - `--durability-mode `: Set the layer durability mode. The only explicitly supported value is `restore-safe`, which preserves changes in the remote layer so the layer can be restored after the local environment ends. If omitted, the service uses `restore-safe`. diff --git a/ai/ti/reference/ti-fs-delete-file.md b/ai/ti/reference/ti-fs-delete-file.md index 63558c740d20f..17475e0c6c37e 100644 --- a/ai/ti/reference/ti-fs-delete-file.md +++ b/ai/ti/reference/ti-fs-delete-file.md @@ -26,7 +26,7 @@ ti fs delete-file ## Options -- `--path `: File or directory path in the TiDB Cloud Filesystem. \[required] +- `--path `: File or directory path in the file system. \[required] - `--dry-run`: Validate the request without applying changes. - `--file-system-id `: Select the file system. You can also set `TI_FS_FILE_SYSTEM_ID`. - `--fs-token `: Set the file system token. If omitted, the command uses the `TI_FS_TOKEN` environment variable. If neither is provided, the command uses the local token stored for the selected file system. diff --git a/ai/ti/reference/ti-fs-describe-file.md b/ai/ti/reference/ti-fs-describe-file.md index 01dd4377baaee..66fde7a1e9aff 100644 --- a/ai/ti/reference/ti-fs-describe-file.md +++ b/ai/ti/reference/ti-fs-describe-file.md @@ -24,7 +24,7 @@ ti fs describe-file ## Options -- `--path `: File or directory path in the TiDB Cloud Filesystem. \[required] +- `--path `: File or directory path in the file system. \[required] - `--file-system-id `: Select the file system. You can also set `TI_FS_FILE_SYSTEM_ID`. - `--fs-token `: Set the file system token. If omitted, the command uses the `TI_FS_TOKEN` environment variable. If neither is provided, the command uses the local token stored for the selected file system. - `--help`: Display help information. diff --git a/ai/ti/reference/ti-fs-mount-file-system.md b/ai/ti/reference/ti-fs-mount-file-system.md index 23ab6284d6885..a0d13efbb154d 100644 --- a/ai/ti/reference/ti-fs-mount-file-system.md +++ b/ai/ti/reference/ti-fs-mount-file-system.md @@ -65,7 +65,7 @@ ti fs mount-file-system - `--read-cache-ttl `: FUSE read cache time to live. \[default: `30s`] - `--read-only`: Read-only mount mode. Requires FUSE; WebDAV rejects this option. Use `--driver fuse` explicitly, or use a scoped token to enforce read-only access at the service level. - `--ready-timeout `: Time to wait for a background mount to become ready. This is a startup timeout, not a timeout for subsequent file reads or writes. [Verify file I/O after mounting](/tidb-cloud-filesystem/filesystem-mount.md#verify-a-mount-before-using-it). \[default: `30s`] -- `--remote-path `: The TiDB Cloud Filesystem root path to mount. \[default: /] +- `--remote-path `: The file system root path to mount. \[default: /] - `--unpack-archive-path `: Restore the pack archive before mounting. - `--version`: Display version information. - `--write-back-cache`: Persist FUSE writes locally before writing them to the file system on flush. This behavior is enabled by default; specify `--write-back-cache=false` to disable it. Unavailable for checkpoint mounts, which are always read-only. \[default: true] diff --git a/ai/ti/reference/ti-fs-pack-file-system.md b/ai/ti/reference/ti-fs-pack-file-system.md index 7ca069dfc7f04..68ad1996718bc 100644 --- a/ai/ti/reference/ti-fs-pack-file-system.md +++ b/ai/ti/reference/ti-fs-pack-file-system.md @@ -39,7 +39,7 @@ ti fs pack-file-system - `--mount-path `: The local mounted path. - `--mount-profile `: Select a [mount profile](/ai/ti/reference/ti-filesystem.md#mount-profiles-and-local-overlays): `coding-agent`, `portable`, or `none`. If omitted, uses `none`. - `--path `: Local overlay path for packing; repeatable. -- `--remote-root `: The TiDB Cloud Filesystem root represented by the local overlay. \[default: /] +- `--remote-root `: The file system root represented by the local overlay. \[default: /] - `--version`: Display version information. For options shared by all commands, see [Global options](/ai/ti/reference/ti-cli-reference.md#global-options). From 04b4183ed6bb79e4ab825905de63018d88929a2b Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Wed, 30 Sep 2026 10:57:37 +0800 Subject: [PATCH 3/3] Update ai/ti/reference/ti-fs-copy-file.md --- ai/ti/reference/ti-fs-copy-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ai/ti/reference/ti-fs-copy-file.md b/ai/ti/reference/ti-fs-copy-file.md index 81f644738b46a..891bb5e28c855 100644 --- a/ai/ti/reference/ti-fs-copy-file.md +++ b/ai/ti/reference/ti-fs-copy-file.md @@ -50,7 +50,7 @@ ti fs copy-file ## Options -- `--append`: Append the contents of a local file to a file in the TiDB Cloud Filesystem. +- `--append`: Append the contents of a local file to a file in the file system. - `--create-parents`: Create missing local parent directories when copying from a file system. - `--description `: The file description for `--to-remote` operation. - `--dry-run`: Validate the request without applying changes.