Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Standardise documentation on the bpftrace name
  • Loading branch information
ajor committed Mar 21, 2019
1 parent e1f5f14 commit 135a4d3
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 18 deletions.
16 changes: 8 additions & 8 deletions INSTALL.md
@@ -1,7 +1,7 @@
# BPFtrace Install
# bpftrace Install

- [Linux Kernel Requirements](#linux-kernel-requirements)
- [Building BPFtrace](#building-bpftrace)
- [Building bpftrace](#building-bpftrace)
- [Ubuntu](#ubuntu)
- [Fedora](#fedora)
- [Amazon Linux](#amazon-linux)
Expand Down Expand Up @@ -33,9 +33,9 @@ CONFIG_HAVE_EBPF_JIT=y
CONFIG_BPF_EVENTS=y
```

# Building BPFtrace
# Building bpftrace

BPFtrace's build system will download `gtest` at build time. If you don't want that or don't want tests, you can use the `make bpftrace` target.
bpftrace's build system will download `gtest` at build time. If you don't want that or don't want tests, you can use the `make bpftrace` target.

## Ubuntu

Expand Down Expand Up @@ -137,16 +137,16 @@ The bpftrace binary will be in installed in /usr/local/bin/bpftrace, and tools i

## Using Docker

There are currently problems with BPFtrace string comparisons when using the Docker build. The regular build is recommended for now.
There are currently problems with bpftrace string comparisons when using the Docker build. The regular build is recommended for now.

Building inside a Docker container will produce a statically linked bpftrace executable.

`./build.sh`

There are some more fine-grained options if you find yourself building BPFtrace a lot:
There are some more fine-grained options if you find yourself building bpftrace a lot:
- `./build-docker-image.sh` - builds just the `bpftrace-builder` Docker image
- `./build-debug.sh` - builds BPFtrace with debugging information (requires `./build-docker-image.sh` to have already been run)
- `./build-release.sh` - builds BPFtrace in a release configuration (requires `./build-docker-image.sh` to have already been run)
- `./build-debug.sh` - builds bpftrace with debugging information (requires `./build-docker-image.sh` to have already been run)
- `./build-release.sh` - builds bpftrace in a release configuration (requires `./build-docker-image.sh` to have already been run)

`./build.sh` is equivalent to `./build-docker-image.sh && ./build-release.sh`

Expand Down
8 changes: 4 additions & 4 deletions README.md
@@ -1,8 +1,8 @@
# BPFtrace
# bpftrace

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 was created by [Alastair Robertson](https://github.com/ajor).
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 was created by [Alastair Robertson](https://github.com/ajor).

To learn more about BPFtrace, see the [Reference Guide](docs/reference_guide.md) and [One-Liner Tutorial](docs/tutorial_one_liners.md).
To learn more about bpftrace, see the [Reference Guide](docs/reference_guide.md) and [One-Liner Tutorial](docs/tutorial_one_liners.md).

## Install

Expand Down Expand Up @@ -174,7 +174,7 @@ For more eBPF observability tools, see [bcc tools](https://github.com/iovisor/bc
<center><a href="images/bpftrace_probes_2018.png"><img src="images/bpftrace_probes_2018.png" border=0 width=700></a></center>

### kprobes
Attach a BPFtrace script to a kernel function, to be executed when that function is called:
Attach a bpftrace script to a kernel function, to be executed when that function is called:

`kprobe:vfs_read { ... }`

Expand Down
10 changes: 5 additions & 5 deletions man/man8/bpftrace.8
Expand Up @@ -2,7 +2,7 @@
.TH "BPFTRACE" "8" "October 2018"
.
.SH "NAME"
\fBBPFtrace\fR \- the eBPF tracing language & frontend
\fBbpftrace\fR \- the eBPF tracing language & frontend
.
.SH "SYNOPSIS"
bpftrace [\fIOPTIONS\fR] \fIFILE\fR
Expand All @@ -11,10 +11,10 @@ bpftrace [\fIOPTIONS\fR] \fIFILE\fR
bpftrace [\fIOPTIONS\fR] \-e \'program code\'
.
.SH "DESCRIPTION"
BPFtrace is a high\-level tracing language for Linux enhanced Berkeley Packet Filter (eBPF) available in recent Linux kernels (4\.x)\.
bpftrace is a high\-level tracing language for Linux enhanced Berkeley Packet Filter (eBPF) available in recent Linux kernels (4\.x)\.
.
.P
BPFtrace uses:
bpftrace uses:
.
.IP "\(bu" 4
\fILLVM\fR as a backend to compile scripts to BPF\-bytecode
Expand All @@ -40,7 +40,7 @@ ccc.
*USDT = user-level statically defined tracing
.
.P
The BPFtrace language is inspired by awk and C, and predecessor tracers such as DTrace and SystemTap\.
The bpftrace language is inspired by awk and C, and predecessor tracers such as DTrace and SystemTap\.
.
.P
See \fBEXAMPLES\fR and \fBONELINERS\fR if you are impatient\.
Expand Down Expand Up @@ -150,7 +150,7 @@ Profile user\-level stacks at 99 Hertz, for PID 189:
.SH "PROBE TYPES"
.
.SS "KPROBES"
Attach a BPFtrace script to a kernel function, to be executed when that function is called:
Attach a bpftrace script to a kernel function, to be executed when that function is called:
.
.P
\fBkprobe:vfs_read { \.\.\. }\fR
Expand Down
2 changes: 1 addition & 1 deletion tests/README.md
@@ -1,4 +1,4 @@
# BPFtrace Tests
# bpftrace Tests

There are two test suites in the project.

Expand Down

0 comments on commit 135a4d3

Please sign in to comment.