Commit 492e1f86 authored by Alastair Robertson's avatar Alastair Robertson Committed by GitHub

Merge pull request #40 from iovisor/docs

docs: add reference guide and one-liner tutorial
parents 9ebdbcd2 4a3b98e1
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
BPFtrace is a high-level tracing language for Linux enhanced Berkeley Packet Filter (eBPF) available in recent Linux kernels (4.x). BPFtrace uses LLVM as a backend to compile scripts to BPF-bytecode and makes use of [BCC](https://github.com/iovisor/bcc) for interacting with the Linux BPF system, as well as existing Linux tracing capabilities: kernel dynamic tracing (kprobes), user-level dynamic tracing (uprobes), and tracepoints. The BPFtrace language is inspired by awk and C, and predecessor tracers such as DTrace and SystemTap. BPFtrace is a high-level tracing language for Linux enhanced Berkeley Packet Filter (eBPF) available in recent Linux kernels (4.x). BPFtrace uses LLVM as a backend to compile scripts to BPF-bytecode and makes use of [BCC](https://github.com/iovisor/bcc) for interacting with the Linux BPF system, as well as existing Linux tracing capabilities: kernel dynamic tracing (kprobes), user-level dynamic tracing (uprobes), and tracepoints. The BPFtrace language is inspired by awk and C, and predecessor tracers such as DTrace and SystemTap.
For instructions on building BPFtrace, see [INSTALL.md](INSTALL.md) For instructions on building BPFtrace, see [INSTALL.md](INSTALL.md). There is also a [Reference Guide](docs/reference_guide.md) and [One-Liner Tutorial](docs/tutorial_one_liners.md).
## Examples ## Examples
...@@ -241,3 +241,5 @@ Functions: ...@@ -241,3 +241,5 @@ Functions:
- `join(char *arr[])` - Prints the string array - `join(char *arr[])` - Prints the string array
- `time(char *fmt)` - Print the current time - `time(char *fmt)` - Print the current time
- `exit()` - Quit bpftrace - `exit()` - Quit bpftrace
See the [Reference Guide](docs/reference_guide.md) for more detail.
This diff is collapsed.
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment