document that Record.Remaining is -1 for overwritable buffers

Signed-off-by: Lorenz Bauer <lmb@isovalent.com>
cilium · Oct 20, 2023 · 220e1e7 · 220e1e7
1 parent 8ef1ee2
commit 220e1e7
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/perf/reader.go b/perf/reader.go
@@ -50,6 +50,7 @@ type Record struct {
 	LostSamples uint64
 
 	// The minimum number of bytes remaining in the per-CPU buffer after this Record has been read.
+	// Negative for overwritable buffers.
 	Remaining int
 }