Skip to content

Commit

Permalink
docs: update docs for load to mention include_bytes_aligned (#1119)
Browse files Browse the repository at this point in the history
* docs: update docs for load to mention include_bytes_aligned

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.
  • Loading branch information
Noah-Kennedy authored Dec 29, 2024
1 parent 78ee9a4 commit df053f0
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions aya/src/bpf.rs
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,10 @@ impl<'a> EbpfLoader<'a> {

/// Loads eBPF bytecode from a buffer.
///
/// The buffer needs to be 4-bytes aligned. If you are bundling the bytecode statically
/// into your binary, it is recommended that you do so using
/// [`include_bytes_aligned`](crate::include_bytes_aligned).
///
/// # Examples
///
/// ```no_run
Expand Down Expand Up @@ -896,6 +900,10 @@ impl Ebpf {
/// [maps](crate::maps) defined in it. If the kernel supports [BTF](Btf)
/// debug info, it is automatically loaded from `/sys/kernel/btf/vmlinux`.
///
/// The buffer needs to be 4-bytes aligned. If you are bundling the bytecode statically
/// into your binary, it is recommended that you do so using
/// [`include_bytes_aligned`](crate::include_bytes_aligned).
///
/// For more loading options, see [EbpfLoader].
///
/// # Examples
Expand Down

0 comments on commit df053f0

Please sign in to comment.