Document --ready-fd in man page #335
Merged
Conversation
This file contains 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
mstoeckl
reviewed
Dec 15, 2023
swaylock.1.scd
Outdated
| *-R, --ready-fd* <fd> | ||
| File descriptor to send readiness notifications to. | ||
|
|
||
| When swaylock has fully initialized, a single newline is written to the FD. |
There was a problem hiding this comment.
It may help to add something like: "and the compositor has indicated that the session is now locked ", since that is probably the specific event people are waiting for when they use this feature. See ext_session_lock_v1.locked for specific guarantees.
There was a problem hiding this comment.
Good point! I've reworded the paragraph to this effect.
emersion
force-pushed
the
doc-ready-fd
branch
from
aa5618a to
2110e4e
Compare
mstoeckl
approved these changes
Dec 15, 2023
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.
No description provided.