Improve mqueue documentation and documentation example #2670
+6
−6
Conversation
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
hicklin
commented
Sep 3, 2025
asomers
reviewed
Sep 18, 2025
src/mqueue.rs
Outdated
Comment on lines
103
to
105
| /// The maximum value allowed by the system can be obtained from `/proc/sys/fs/mqueue/msg_max`. | ||
| /// - `mq_msgsize`: Maximum message size in bytes. | ||
| /// The maximum value allowed by the system can be obtained from `/proc/sys/fs/mqueue/msgsize_max`. |
There was a problem hiding this comment.
These two comments are Linux-specific. But the API is cross-platform. So it's not really appropriate to put these here.
There was a problem hiding this comment.
I have removed these and updated the commit.
…l documentation to explain the limits of the MqAttr input values.
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.
From reading the mqueue c implementation that this library wraps, it seems that we can't set
attrtoNonewhen creating the mqueueMQ_OFlag::O_CREAT. If we do, we get anErrno::EINVAL. This means that the example in the documentation is incorrect.What does this PR do
This PR updates the mqueue documentation example and adds some helpful documentation to explain the limits of the
MqAttrinput values.