symlink: rename parameters and fix error messages to match std#83
Merged
andrewhickman merged 1 commit intoandrewhickman:mainfrom Dec 15, 2025
Merged
symlink: rename parameters and fix error messages to match std#83andrewhickman merged 1 commit intoandrewhickman:mainfrom
std#83andrewhickman merged 1 commit intoandrewhickman:mainfrom
Conversation
Previously, upstream named the parameters to `fn symlink(src: P, dest: Q)`.
This is confusing because `dest` is the path of the link that's
_created_, not the _destination_ the link points to.
In fact, it's so confusing that all the error messages from this crate
listed the paths incorrectly: if
`fs_err::os::unix::fs::symlink("link-destination", "link-source")`
failed, the error message would say:
failed to symlink file from link-destination to link-source
Now, in both `std` and `tokio`, these functions are named like `fn
symlink(original: P, link: Q)`. Let's update our wrappers to match the
new convention.
9999years
added a commit
to 9999years/npingler
that referenced
this pull request
Dec 11, 2025
I had referenced the upstream Lix code that ran this logic, but made two mistakes: 1. I was checking if the `profile` symlink existed, rather than the `profile_link` symlink. 2. I was creating the symlink in the wrong direction, partially due to confusing parameter names in `fs_err`. See: andrewhickman/fs-err#83 See: https://git.lix.systems/lix-project/lix/src/commit/fd38f625e6897c0597ebb2635bfb39f7cff45225/lix/libstore/profiles.cc#L338-L340
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
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.
Previously, upstream named the parameters to
fn symlink(src: P, dest: Q). This is confusing becausedestis the path of the link that's created, not the destination the link points to.In fact, it's so confusing that all the error messages from this crate listed the paths incorrectly: if
fs_err::os::unix::fs::symlink("link-destination", "link-source")failed, the error message would say:Now, in both
stdandtokio, these functions are named likefn symlink(original: P, link: Q). Let's update our wrappers to match the new convention.