Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

perf: clarify purpose of the package #1172

Merged
merged 1 commit into from
Oct 18, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 3 additions & 4 deletions perf/doc.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
// Package perf allows interacting with Linux perf_events.
// Package perf allows reading from BPF perf event arrays.
//
// BPF allows submitting custom perf_events to a ring-buffer set up
// by userspace. This is very useful to push things like packet samples
// from BPF to a daemon running in user space.
// A perf event array contains multiple perf event ringbuffers which can be used
// to exchange sample like data with user space.
package perf