sctp: update manpages #965
Closed
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
llfw
force-pushed
the
sctp-docs
branch
2 times, most recently
from
d0e64d4
to
68195ea
Compare
llfw
force-pushed
the
sctp-docs
branch
3 times, most recently
from
00818b7
to
f92ec8b
Compare
tuexen
reviewed
Jan 30, 2024
lib/libc/net/sctp_send.3
Outdated
| .Sh DESCRIPTION | ||
| The | ||
| .Fn sctp_send | ||
| system call | ||
| is used to transmit a message to another SCTP endpoint. | ||
| The | ||
| .Fn sctp_sendx | ||
| function is used to transmit a message to multiple endpoint addresses. |
There was a problem hiding this comment.
Maybe something like
When issuing an implicit association setup, the
.Fn sctp_sendx
function allows to specify multiple addresses of the peer, which can then be used for the association setup.
This is equivalent to using
.Xr sctp_connectx 3 .
would be more accurate.
There was a problem hiding this comment.
i replaced the text with this, which i think is still accurate, but is slightly shorter to fit the style of the paragraph:
The
.Fn sctp_sendx
function is used to specify multiple peer addresses when creating an implicit
association, as in
.Xr sctp_connectx 3 .
|
Looking at, for example IP6(4), it might be useful to add references to RFC 6458 in the |
bsdbcr
reviewed
Jan 31, 2024
bsdbcr
reviewed
Jan 31, 2024
|
The man page changes need a line break after a sentence stop. Running "mandoc -Tlint" and the textproc/igor port find these sort of issues. |
Add missing documentation for sctp_sendv(3) and sctp_recvv(3). Add a note that sctp_send(3), sctp_sendx(3) and sctp_recvmsg(3) are deprecated by RFC 6458. Add a STANDARDS section to all functions specified in RFC 6458 to indicate their standards conformance. MFC after: 2 weeks
|
|
The man page changes look good now, thank you! 👍 |
freebsd-git
pushed a commit
that referenced
this pull request
Feb 3, 2024
Add missing documentation for sctp_sendv(3) and sctp_recvv(3). Add a note that sctp_send(3), sctp_sendx(3) and sctp_recvmsg(3) are deprecated by RFC 6458. Add a STANDARDS section to all functions specified in RFC 6458 to indicate their standards conformance. MFC after: 2 weeks Reviewed by: imp, bcr, kp, tuexen Pull Request: #965
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.
Add missing documentation for sctp_sendv(3) and sctp_recvv(3).
Add a note that sctp_send(3), sctp_sendx(3) and sctp_recvmsg(3) are deprecated by RFC 6458.
Add a STANDARDS section to all functions specified in RFC 6458 to indicate their standards conformance.
this should probably be reviewed by someone who knows more about SCTP than i do.