Skip to content

docs: fix TiDB Cloud file system casing to match the product name #23901

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yahonda wants to merge 1 commit into
base: release-8.5
Choose a base branch
from
Open

docs: fix TiDB Cloud file system casing to match the product name #23901

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions ai/ti/reference/ti-fs-copy-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <string>`: The file description for `--to-remote` operation.
- `--dry-run`: Validate the request without applying changes.
- `--file-system-id <string>`: Select the file system. You can also set `TI_FS_FILE_SYSTEM_ID`.
- `--from-local <string>`: The local source path.
- `--from-remote <string>`: The source path in the TiDB Cloud file system.
- `--from-remote <string>`: The source path in the TiDB Cloud Filesystem.
- `--from-stdin`: Read from stdin and write to `--to-remote`.
- `--fs-token <string>`: Set the Filesystem 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 Filesystem.
- `--help`: Display help information.
Expand All @@ -66,7 +66,7 @@ ti fs copy-file
- `--resume`: Resume an active copy operation.
- `--tag <string>`: Create tags `key=value` for `--to-remote` operation; repeatable.
- `--to-local <string>`: The local destination path.
- `--to-remote <string>`: The destination path in the TiDB Cloud file system.
- `--to-remote <string>`: The destination path in the TiDB Cloud Filesystem.
- `--to-stdout`: Write `--from-remote` to stdout.
- `--version`: Display version information.

Expand Down
4 changes: 2 additions & 2 deletions ai/ti/reference/ti-fs-create-hardlink.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ ti fs create-hardlink

## Options

- `--link-path <string>`: The file path for the hard link being created in the TiDB Cloud file system. \[required]
- `--source-path <string>`: The existing file path in the TiDB Cloud file system. \[required]
- `--link-path <string>`: The file path for the hard link being created in the TiDB Cloud Filesystem. \[required]
- `--source-path <string>`: The existing file path in the TiDB Cloud Filesystem. \[required]
- `--dry-run`: Validate the request without applying changes.
- `--file-system-id <string>`: Select the file system. You can also set `TI_FS_FILE_SYSTEM_ID`.
- `--fs-token <string>`: Set the Filesystem 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 Filesystem.
Expand Down
2 changes: 1 addition & 1 deletion ai/ti/reference/ti-fs-create-layer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ ti fs create-layer

## Options

- `--base-root-path <string>`: Base root path in the TiDB Cloud file system. \[required]
- `--base-root-path <string>`: Base root path in the TiDB Cloud Filesystem. \[required]
- `--actor-id <string>`: Actor ID identifying the layer owner (for example, the agent name).
- `--dry-run`: Validate the request without applying changes.
- `--durability-mode <string>`: 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`.
Expand Down
2 changes: 1 addition & 1 deletion ai/ti/reference/ti-fs-delete-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ ti fs delete-file

## Options

- `--path <string>`: File or directory path in the TiDB Cloud file system. \[required]
- `--path <string>`: File or directory path in the TiDB Cloud Filesystem. \[required]
- `--dry-run`: Validate the request without applying changes.
- `--file-system-id <string>`: Select the file system. You can also set `TI_FS_FILE_SYSTEM_ID`.
- `--fs-token <string>`: Set the Filesystem 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 Filesystem.
Expand Down
2 changes: 1 addition & 1 deletion ai/ti/reference/ti-fs-describe-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ ti fs describe-file

## Options

- `--path <string>`: File or directory path in the TiDB Cloud file system. \[required]
- `--path <string>`: File or directory path in the TiDB Cloud Filesystem. \[required]
- `--file-system-id <string>`: Select the file system. You can also set `TI_FS_FILE_SYSTEM_ID`.
- `--fs-token <string>`: Set the Filesystem 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 Filesystem.
- `--help`: Display help information.
Expand Down
2 changes: 1 addition & 1 deletion ai/ti/reference/ti-fs-mount-file-system.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ ti fs mount-file-system
- `--read-cache-ttl <duration>`: FUSE read cache time to live. \[default: `30s`]
- `--read-only`: Read-only mount mode.
- `--ready-timeout <duration>`: Time to wait for a background mount to become ready. \[default: `30s`]
- `--remote-path <string>`: The TiDB Cloud file system root path to mount. \[default: /]
- `--remote-path <string>`: The TiDB Cloud Filesystem root path to mount. \[default: /]
- `--unpack-archive-path <string>`: 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]
Expand Down
2 changes: 1 addition & 1 deletion ai/ti/reference/ti-fs-pack-file-system.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ ti fs pack-file-system
- `--mount-path <string>`: The local mounted path.
- `--mount-profile <string>`: 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 <string>`: Local overlay path for packing; repeatable.
- `--remote-root <string>`: The TiDB Cloud file system root represented by the local overlay. \[default: /]
- `--remote-root <string>`: 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).
Expand Down
Loading