From 20b5a502f051d32abc087ba568acad3575f9edd1 Mon Sep 17 00:00:00 2001
From: Andy Pan <i@andypan.me>
Date: Sat, 21 Sep 2024 23:15:26 +0800
Subject: [PATCH] chore: add comments

---
 pkg/pool/byteslice/byteslice.go | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/pkg/pool/byteslice/byteslice.go b/pkg/pool/byteslice/byteslice.go
index 480478d0e..53397dac6 100644
--- a/pkg/pool/byteslice/byteslice.go
+++ b/pkg/pool/byteslice/byteslice.go
@@ -64,7 +64,8 @@ func (p *Pool) Put(buf []byte) {
 	if size != 1<<idx { // this byte slice is not from Pool.Get(), put it into the previous interval of idx
 		idx--
 	}
-	// array pointer
+	// Store the pointer to the underlying array instead of the pointer to the slice itself,
+	// which circumvents the escape of buf from the stack to the heap.
 	p.pools[idx].Put(unsafe.SliceData(buf))
 }