Skip to content

Conversation

@Hyalunar
Copy link
Contributor

@Hyalunar Hyalunar commented Oct 7, 2025

Users have repeatedly tripped over the subtle difference between getFileStatus and getSymbolicLinkStatus.

I have added a single line of documentation to hint at the other function. Currently there is only a hint in getSymbolicLinkStatus.
I'm not sure whether this is enough to stop these mix-ups from happening, but I didn't want to make all the documentation of getFileStatus about getSymbolicLinkStatus.

Looking forward to hearing from you

My thanks go to the discourse user f-a for encouraging me to open up an issue/PR.

@Hyalunar
Copy link
Contributor Author

Hyalunar commented Oct 9, 2025

During my research to the causes of this, I have noticed that there is no support for the O_PATH flag.
I added hints and notes about it in the documentation of getFdStatus, openFd and OpenFileFlags.
I'd consider implementing this out of scope for this specific Pull Request, but I plan on coming back to this.

@Bodigrim
Copy link
Contributor

Bodigrim commented Oct 9, 2025

CC @hs-viktor @hasufell for review.

@hasufell
Copy link
Member

@Hyalunar can you fix the remaining issues?

Hyalunar and others added 6 commits October 14, 2025 12:19
Co-authored-by: Viktor Dukhovni <viktor1ghub@dukhovni.org>
Co-authored-by: Viktor Dukhovni <viktor1ghub@dukhovni.org>
Co-authored-by: Viktor Dukhovni <viktor1ghub@dukhovni.org>
@Hyalunar
Copy link
Contributor Author

Hyalunar commented Oct 14, 2025

I have removed the platform-specific hints and checked that the documentation for getFdStatus and getFileStatus is in sync across the different String APIs. (I send the comment before the push, sorry)

Copy link
Contributor

@vdukhovni vdukhovni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@hasufell hasufell merged commit 1e32d82 into haskell:master Oct 29, 2025
26 of 27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants