Skip to content

Commit f63e12d

Browse files
felixgegopherbot
authored andcommitted
internal/trace: fix Sync.ClockSnapshot comment
The old comment said "clocks take in close in time" which was probably due to rewording this a few times. Replace the comment with the one of the ClockSnapshot type as there doesn't seem to be a good reason for using a different wording here. Change-Id: I6a6a69648c8470c2f45f6f8e728f5dc8b121a82b Reviewed-on: https://go-review.googlesource.com/c/go/+/694620 Reviewed-by: Michael Knyszek <[email protected]> LUCI-TryBot-Result: Go LUCI <[email protected]> Reviewed-by: David Chase <[email protected]> Auto-Submit: Michael Knyszek <[email protected]>
1 parent 8e317da commit f63e12d

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/internal/trace/event.go

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -690,9 +690,11 @@ type Sync struct {
690690
// N indicates that this is the Nth sync event in the trace.
691691
N int
692692

693-
// ClockSnapshot is a snapshot of different clocks taken in close in time
694-
// that can be used to correlate trace events with data captured by other
695-
// tools. May be nil for older trace versions.
693+
// ClockSnapshot represents a near-simultaneous clock reading of several
694+
// different system clocks. The snapshot can be used as a reference to
695+
// convert timestamps to different clocks, which is helpful for correlating
696+
// timestamps with data captured by other tools. The value is nil for traces
697+
// before go1.25.
696698
ClockSnapshot *ClockSnapshot
697699

698700
// ExperimentalBatches contain all the unparsed batches of data for a given experiment.

0 commit comments

Comments
 (0)