Document the --volume three-part form and mount option behavior#1959
Open
magicashu wants to merge 1 commit into
Open
Document the --volume three-part form and mount option behavior#1959magicashu wants to merge 1 commit into
magicashu wants to merge 1 commit into
Conversation
The --volume flag accepts an undocumented third colon-separated component containing comma-separated mount options (host-path:container-path:options), but neither the CLI help text nor the docs mention it. Document all three accepted formats in the flag help, the command reference, and the how-to guide, including a note that for host directory mounts only the ro option is currently guaranteed to take effect and that other options are silently ignored unless combined with ro. Fixes apple#1940 Co-Authored-By: Claude Fable 5 <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.
Type of Change
Motivation and Context
The
--volumeflag accepts an undocumented third colon-separated component containing comma-separated mount options (host-path:container-path:options), but neither the CLI help text nor the docs mention it. Users discovering the form by reading the parser have no guidance on which options are supported, and options other thanroare currently silently ignored for host directory mounts unless combined withro(see #1940 for the code-level analysis).This PR documents all three accepted
--volumeformats in the flag help text,docs/command-reference.md, anddocs/how-to.md, including an explicit note about the currentrointeraction so behavior is no longer surprising. The underlying option-application behavior in apple/containerization is intentionally left unchanged pending maintainer guidance on the intended semantics.Fixes #1940
Testing
swift format lint(repo configuration) passes on the modified source file. Change is limited to a help-string literal and markdown documentation; no behavior change.🤖 Generated with Claude Code