docs: document path normalization and workspace-root escape error#48
Merged
Conversation
Paths passed to file(), glob(), out, and support_files are now lexically normalized and hard-error when .. escapes the workspace root (hephbuild/heph#128). Document this behavior in buildfile.md and exec.md to match the existing note in fs.md.
⚡ Cloudflare Pages preview
|
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.
What changed\n\nFollows hephbuild/heph#128, which fixed package-relative path joins across three callsites (
file(),glob(), andout/support_files). The change also made..segments that escape the workspace root a hard error instead of silently mangling the path.\n\nfs.mdalready carried a path-normalization note forheph.fs.glob. This PR adds matching notes to the two pages that were missing them:\n\n-buildfile.md— extends theabs = Truesentence in thefile()/glob()section to state that paths are lexically normalized and that escaping the workspace root is an error.\n-exec.md— adds a one-sentence note after thesupport_filesdescription in the Output groups section.\n\n## No new behavior documented\n\nThis is a bug-fix commit. The normalization of./-prefixed paths is the correction of silent wrong behavior. The only net-new constraint is the hard error on workspace-root escape — users with..-heavy paths that previously produced wrong-but-silent output will now get a clear error message.\nGenerated by Claude Code