Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RFC: Manual: Update usrsctp_init() documentation #715

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dasteihn
Copy link

@dasteihn dasteihn commented Aug 3, 2024

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 blame just 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_output and debug_printf function pointers are precisely supposed to do and when they are allowed to be NULL.

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 <stanner@posteo.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant