docs: update docs for load to mention include_bytes_aligned #1119
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
✅ Deploy Preview for aya-rs-docs ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
alessandrod
reviewed
Dec 22, 2024
aya/src/bpf.rs
Outdated
| @@ -375,6 +375,10 @@ impl<'a> EbpfLoader<'a> { | |||
|
|
|||
| /// Loads eBPF bytecode from a buffer. | |||
| /// | |||
| /// The program will need to be aligned properly for you to use it. | |||
There was a problem hiding this comment.
nit: I would say The buffer needs to be 4-bytes aligned. If you are ...
There was a problem hiding this comment.
I still see the past tense being used.
Alessandro proposed:
The buffer needs to be 4-bytes aligned. If you are ...
In the diff, I see:
The buffer will need to be aligned to 4 bytes. If you are ...
vadorovsky
approved these changes
Dec 27, 2024
|
Thanks for the contribution! I went ahead an applied two minor changes (present tense and "If you are bundling this" -> "If you are bundling the bytecode"). I will merge once green. |
This macro is required if you are bundling programs statically into your binary, which is not an uncommon thing to do. This change updates the documentation for the load function to mention this macro and the need for alignment.
vadorovsky
force-pushed
the
noah/update-load-docs
branch
from
472a5e4 to
d616946
Compare
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.
This macro is required if you are bundling programs statically into your binary, which is not an uncommon thing to do.
This change updates the documentation for the load function to mention this macro and the need for alignment.
This change is