Skip to content

docs: document mount --durability and the drain/unmount gate in the published English pages #98

Open

Description

@srstack

The published English PingCAP documentation submodule (docs/pingcap-docs/docs) was not checked out while PR #97 landed, so the mount page still describes the pre-PR CLI. The binary now contradicts it:

  • ti fs mount-file-system --durability auto|interactive|fsync|close-sync|write-sync (default interactive), with --write-back-cache as a legacy alias (true = interactive, false = auto) and a conflict error when both are set inconsistently.
  • WebDAV mounts forward no tier, report durability: "auto", and reject every other explicit tier; checkpoint mounts report auto and reject other tiers.
  • The mount result reports durability and no longer reports the write_back_cache boolean.
  • ti fs drain-file-system returns the companion's drain report (response, including pending counters), fails with fs.drain_pending_work when work remains, and refuses WebDAV/vault mounts with fs.drain_not_applicable.
  • ti fs unmount-file-system drains before detaching a FUSE file-system mount, blocks while writes are pending, treats --force as the only loss acceptance, and never lets --ignore-absent skip pending work.

Tracked from docs/spec/done/0038-fs-mount-durability.md and docs/spec/done/0039-fs-unmount-drain-gate.md. Do this before the next release cut.

Acceptance: the mount and unmount pages under docs/pingcap-docs/docs/ document the flags, the result fields, and the drain gate, and TOC-ai.md / ai/_index.md stay consistent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions