RFC: Manual: Update usrsctp_init() documentation #715
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
The documentation for usrsctp_init() is not up to date anymore. It mentions the UDP-Encapsulation port as the only parameter. By now there are three parameters. Commit b724b61 ("Add support for registering a printf() callback for debug output. This is required by Firefox.") was the last to extend the API. It seems a simulatenous update to the documentation had been forgotten. Introduce the new API to the documentation. Signed-off-by: Philipp Stanner <[email protected]>
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.
Hello,
so it seems this project's documentation is at least in part out of date.
Notably the function
usrsctp_init()is lacking descriptions of two parameters. Unfortunately, it is not easy (for me) to find what they are even supposed to do in the first place.The last one seems to be some sort of state logging mechanism, added in b724b61.
The first one is hidden in the history somewhere.
git blamejust delivers a white space fix when searching for when and why it was introduced.In any case, I think we should update the documentation. Feel free to use this patch as a basis. Alternatively, I'd also be happy to write some documentation. But someone from the project first would have to tell me what the
conn_outputanddebug_printffunction pointers are precisely supposed to do and when they are allowed to beNULL.