Skip to content

Commit 0e677b9

Browse files
authored
doc: update build (#23)
Signed-off-by: Xiaobo Liu <[email protected]>
1 parent da52890 commit 0e677b9

File tree

2 files changed

+6
-13
lines changed

2 files changed

+6
-13
lines changed

README.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,7 @@
1111
1. bpf-linker: `cargo install bpf-linker` (`--no-default-features` on macOS)
1212

1313

14-
## Build & Run
15-
16-
Use `cargo build`, `cargo check`, etc. as normal. Run your program with `xtask run`.
17-
18-
Cargo build scripts are used to automatically build the eBPF correctly and include it in the
19-
program. When not using `xtask run`, eBPF code generation is skipped for a faster developer
20-
experience; this compromise necessitates the use of `xtask` to actually build the eBPF.
21-
22-
Compiling project:
14+
## Build
2315

2416
```shell
2517
$ AYA_BUILD_EBPF=true cargo build --release
@@ -44,16 +36,16 @@ AYA_BUILD_EBPF=true CC=${ARCH}-linux-musl-gcc cargo build --package rust-memleak
4436
The cross-compiled program `target/${ARCH}-unknown-linux-musl/release/rust-memleak` can be
4537
copied to a Linux server or VM and run there.
4638

47-
## Notice
4839

49-
1. `aya v0.13.0` requires rustc 1.80.0 or newer.
40+
## Notice
5041

51-
2. The target Rust application needs to enable stack frame compilation:
42+
The target Rust application needs to enable stack frame compilation:
5243

5344
```
5445
$ RUSTFLAGS="-C force-frame-pointers=yes" cargo build
5546
```
5647

48+
5749
## Usage
5850

5951
```shell
@@ -68,6 +60,7 @@ Options:
6860
-h, --help Print help
6961
```
7062

63+
7164
### Example:
7265

7366
```shell
@@ -82,7 +75,7 @@ Generating flame graphs:
8275

8376
Flame graph:
8477

85-
![flamegraph](img/1.svg)
78+
![flamegraph](images/1.svg)
8679

8780

8881
## Reference

img/1.svg renamed to images/1.svg

File renamed without changes.

0 commit comments

Comments
 (0)