docs(fuse): make the "Use it" examples per-platform - #19
Merged
Conversation
The usage examples were Linux-only shell against /mnt/cte, which does not
translate to either other platform. Split them into the same os-grouped
tabs the install/mount/unmount steps already use, so picking a platform
once carries through the whole page.
- macOS: same commands, but the mountpoint is ~/cte-mnt (or
/Volumes/cte-mnt under FSKit) and the checksum tool is `md5`, not
`md5sum`.
- Windows: PowerShell equivalents (Set-Content / Copy-Item /
Get-Content / Get-FileHash / Get-ChildItem / Remove-Item) plus a
cmd.exe variant, since the mount is an ordinary volume any
path-taking application can use.
Also expand the Windows mount step to actually demonstrate setting the
mountpoint, which is the thing that differs most from Linux: it is the
first argument as everywhere else, but takes either a drive letter
(mount at exactly Z:, with Get-PSDrive to find a free one and the CI
script's first-free-letter loop for scripted use) or a directory path
whose parent exists. Notes that drive-letter mounting is the form CI
exercises end to end, and how to confirm the mount is live before
using it.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #18. This commit was pushed to that branch a few minutes after it was merged, so it missed the merge — the shipped FUSE page still has Linux-only usage examples. Cherry-picked onto current
mainunchanged.What this fixes
#18 made Installation, Mount, and Unmount per-platform, but left "3. Use it" as Linux-only shell against
/mnt/cte, which doesn't translate to either other platform. It now uses the samegroupId="os"tabs as the surrounding steps, so picking a platform once carries through the whole page./mnt/cte.~/cte-mnt(or/Volumes/cte-mntunder the FSKit backend), and the checksum tool ismd5; macOS does not ship themd5sumspelling.Set-Content,Copy-Item,Get-Content,Get-FileHash -Algorithm MD5,Get-ChildItem,Remove-Item), plus acmd.exevariant, since the mount is an ordinary volume that any path-taking application can use.Windows mountpoint
The bigger gap was that the Windows mount step never actually showed how to set the mountpoint. It's the first argument to
clio_cte_fuseexactly as on Linux — only the accepted forms differ:Plus the two things that bite in practice:
Get-PSDrive -PSProvider FileSystemto see what's taken — and for scripted use, the first-free-letter loop lifted fromCI/fuse_mount_smoke.ps1.Test-Path Z:\to confirm the mount is live before writing to it. The daemon needs a moment; CI polls for up to 20 s.Drive-letter mounting is flagged as the form CI exercises end to end, so it's the one to prefer when either would do. The directory form states the parent-must-exist requirement and nothing beyond that — the repo only proves the drive-letter path, so I didn't assert WinFsp directory-mount behavior I couldn't verify.
Verification
npx docusaurus buildcompletes with no broken links or anchors. One file changed, +100/−4.🤖 Generated with Claude Code