Skip to content

Commit

Permalink
perf: clarify purpose of the package
Browse files Browse the repository at this point in the history
Update the doc comment to make it clear that the package is only really
about reading from PerfEventArray.

Signed-off-by: Lorenz Bauer <lmb@isovalent.com>
  • Loading branch information
lmb committed Oct 18, 2023
1 parent ed9bf3b commit aa05a83
Showing 1 changed file with 3 additions and 4 deletions.
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

0 comments on commit aa05a83

Please sign in to comment.