[PATCH v3] doc: userguide: update code blocks #2154
Merged
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
odpbuild
changed the title
JannePeltonen
approved these changes
Dec 4, 2024
| Note that parsing is automatically done whenever classification is enabled | ||
| for an RX interface (see below). | ||
| receipt as controlled by the `odp_pktio_parser_config_t` struct. Note that | ||
| parsing is automatically done whenever classification is enabled for an RX |
There was a problem hiding this comment.
parsing is automatically done whenever classification is enabled
This statement caught my eye even though it is not changed by this commit. I wonder if enabling of parsing is really guaranteed by the API in this case as I did not find it in the API text. Or perhaps this is just the way the linux-gen ODP implementation works?
There was a problem hiding this comment.
Indeed the API doesn't mention this, so removed the sentence.
| ----- | ||
| Note that the *queue_param* field of this struct is ignored in DIRECT mode. | ||
| The purpose of `odp_pktin_queue_config()` is to specify the number of PktIn | ||
| `odp_pktin_queue_config()` API, which purpose is to specify the number of PktIn |
There was a problem hiding this comment.
The 'which' does not sound quite right to me. I would probably use 'whose', or if that is not good, I would say "... API, the purpose of which is ...".
There was a problem hiding this comment.
Changed to whose in V2.
MatiasElo
force-pushed
the
dev/user-guide
branch
from
e646c0e to
84b1f22
Compare
odpbuild
changed the title
Remove code sections copied from the API headers as they will not stay up- to-date. Update some code examples to utilize current APIs and remove some obsolete ones. Signed-off-by: Matias Elo <[email protected]> Reviewed-by: Janne Peltonen <[email protected]>
MatiasElo
force-pushed
the
dev/user-guide
branch
from
84b1f22 to
0e42ba1
Compare
odpbuild
changed the title
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.
Remove code sections copied from the API headers as they will not stay up- to-date. Update some code examples to utilize current APIs and remove some obsolete ones.