Skip to content

docs(fs): Clarify That File::lock Coordinates Across Processes#153647

Open
TKanX wants to merge 1 commit intorust-lang:mainfrom
TKanX:docs/153618-file-lock-cross-process
Open

docs(fs): Clarify That File::lock Coordinates Across Processes#153647
TKanX wants to merge 1 commit intorust-lang:mainfrom
TKanX:docs/153618-file-lock-cross-process

Conversation

@TKanX
Copy link
Contributor

@TKanX TKanX commented Mar 10, 2026

Summary:

The documentation for lock, lock_shared, try_lock, and try_lock_shared did not make it clear that these are OS level file locks that coordinate access across processes, not just between handles within the current process.

Add "in this or any other process" to each method's existing description to clarify this.

Fixes #153618

r? @Mark-Simulacrum

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Mar 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

File::lock docs don't make clear they are cross-process

3 participants