Merge #143912

143912: kvserver: clean comments for policy_refresher.go r=arulajmani a=wenyihu6


This commit cleans some comments up for PolicyRefresher.

Release note: none
Epic: none

Co-authored-by: wenyihu6 <[email protected]>

Author: craig[bot]

pkg/kv/kvserver/closedts/policyrefresher/policy_refresher.go

@@ -20,12 +20,12 @@ import (
 )
 
 // PolicyRefresher periodically refreshes the closed timestamp policies for
-// leaseholder replicas based on network latencies between leaseholders and
-// their furthest follower.
+// ranges that have leaseholders on the node on which it is running or when
+// there are on-demand refresh requests from the replica.
 //
-// For ranges configured to serve global reads, this determines how far into the
-// future timestamps should be closed based on the latency to the farthest
-// follower (if LeadForGlobalReadsAutoTuneEnabled is enabled).
+// When LeadForGlobalReadsAutoTuneEnabled is enabled, ranges configured with
+// global reads consider network latencies between the leaseholder and its
+// furthest follower when calculating closed timestamps.
 type PolicyRefresher struct {
 	stopper  *stop.Stopper
 	settings *cluster.Settings
@@ -79,11 +79,13 @@ func NewPolicyRefresher(
 	return refresher
 }
 
-// Replica is implemented by kvserver.Replica.
+// Replica defines a thin interface to update closed timestamp policies.
 type Replica interface {
-	// RefreshPolicy is called to update closed timestamp policy periodically
-	// with observed latency information by PolichRefresher. Note that the
-	// given map here can be nil.
+	// RefreshPolicy informs the replica that it should refresh its closed
+	// timestamp policy. A latency map, which includes observed latency to other
+	// nodes in the system by the PolicyRefresher may be supplied (or may be nil),
+	// in which case it may be used to correctly place a replica in its latency
+	// based global reads bucket.
 	RefreshPolicy(map[roachpb.NodeID]time.Duration)
 }