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.
reviewable/pr1119/r1
noah 4 months ago committed by Michal Rostecki
parent 4f0559f2af
commit 0f9e6a43b6

@ -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.
/// If you are bundling this statically into your binary, it is recommended that you do so
/// using [`include_bytes_aligned`](crate::include_bytes_aligned).
///
/// # Examples
///
/// ```no_run
@ -898,6 +902,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 program will need to be aligned properly for you to use it.
/// If you are bundling this 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

Loading…
Cancel
Save