From 0121cf93423033f41b42fc607ef076c7b8f8ac4e Mon Sep 17 00:00:00 2001 From: Tom Levy Date: Tue, 6 Feb 2024 07:58:18 +1300 Subject: [PATCH] Clarify specification of startValue in speedscope file format (#464) The previous description ("event values will be relative to this startValue") was ambiguous. Suppose the profile starts at wall time 1000ms and the first event is at wall time 1003ms. The intention is that startValue should be set to 1000 and the "at" value of the event should be set to 1003. The viewer's time axis will start at 0ms and the first event will be displayed at 3ms. But the previous description could be incorrectly interpreted as saying that the "at" value of the first event should be set to 3 (the time relative to startValue, as opposed to the absolute wall time). Clarify that "relative" is referring to how the viewer displays the data, not about which values to store in the file. --- src/lib/file-format-spec.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/lib/file-format-spec.ts b/src/lib/file-format-spec.ts index 584fa08..8e7218c 100644 --- a/src/lib/file-format-spec.ts +++ b/src/lib/file-format-spec.ts @@ -65,7 +65,7 @@ export namespace FileFormat { unit: ValueUnit // The starting value of the profile. This will typically be a timestamp. - // All event values will be relative to this startValue. + // All event values will be displayed relative to this startValue. startValue: number // The final value of the profile. This will typically be a timestamp. This @@ -93,7 +93,7 @@ export namespace FileFormat { unit: ValueUnit // The starting value of the profile. This will typically be a timestamp. - // All event values will be relative to this startValue. + // All event values will be displayed relative to this startValue. startValue: number // The final value of the profile. This will typically be a timestamp. This