Document the fs (filesystem) VCS type (refs #76)#93
Merged
Conversation
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.
Refs #76.
The
fsVCS type was listed in the options table but its behavior was undocumented, which led to the confusion in #76: a user setvcs = fswith an absolute-pathurlexpecting mxdev to symlink the external directory intosources/, and got aFilesystemErrorinstead.This documents what
fsactually does — it only verifies that a package directory already exists under the sources directory and does not fetch, copy, or symlink anything;urlis the directory name (equal to the package name), not a path. It also spells out the common pitfall and the alternatives (manual symlink, agitsource pointing at a local repo, or a[tool.uv.sources]path entry for uv projects).Docs-only; no behavior change.
Test Plan