Fix FLOWSPEC vs QOS confusion. #1869
Open
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.
The current documentation is talking about the
QOS
parameter in introduction summary, but about theFLOWSPEC
parameter later on in place where the parameter is described, this is confusing. But the header files are talking about theQOS
parameter. Upon further inspection the documentation is talking about the pointer pointing to two consecutiveFLOWSPEC
parameters followed by single user data parameter. Guess what, theQOS
structure is exactly that. Thus, by accepting the change proposed in this PR, the documentation will be in sync with the header files. And the documentation will be more correct, more consistent, more useful and less confusing for the end user.