From b73b9092ee3a320bce9507f386a46fd2f80fdabc Mon Sep 17 00:00:00 2001 From: Tamir Duberstein Date: Thu, 2 Oct 2025 23:43:46 -0400 Subject: [PATCH] Add AGENTS.md --- AGENTS.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..e424466a --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,36 @@ +# AGENTS NOTES + +- Repository: aya (Rust library and tooling for working with eBPF programs). +- Development tooling: + - Do not regenerate public API fixtures; the user handles that. + - Many crates only build on Linux; on macOS lint and type check using + + ```sh + ./clippy.sh --target x86_64-unknown-linux-musl + ``` + +- Coding guidelines: + - Use github or bootlin permalinks when referencing kernel sources. +- Integration testing: + - Prepare: + + ```sh + .github/scripts/download_kernel_images.sh \ + test/.tmp/debian-kernels/ [VERSIONS]... + + find test/.tmp -name '*.deb' -print0 | xargs -t -0 -I {} \ + sh -c "dpkg --fsys-tarfile {} | tar -C test/.tmp \ + --wildcards --extract '**/boot/*' '**/modules/*' --file -" + ``` + + You might need to use gtar rather than tar on mac. + - Run: + + + + ```sh + .github/scripts/find_kernels.py | xargs -0 -t sh -c \ + 'cargo xtask integration-test vm --cache-dir test/.tmp "$@" -- [ARGS]...' _ + ``` + +