Correct bpf_l4_csum_replace() documentation for offset parameter #105
+1
−1
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
dylandreimerink
requested changes
Dec 29, 2024
There was a problem hiding this comment.
This description is imported from libbpf automatically, hence the <!-- [HELPER_FUNC_DEF] --> marker. These changes will be reversed when make generate-docs is called.
Secondly, the original description isn't necessarily wrong. Since TCP, UDP, and ICMP do use the "IP checksum". So it does not seem to make to much sense.
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.
The bpf_l4_csum_replace() helper’s offset parameter points to the transport-layer checksum (e.g., TCP/UDP/ICMP), not the IP checksum. This change updates the misleading reference to “IP checksum” and aligns the documentation with the function’s actual behavior.