Browse Source

docs: clarify trace2 version invariants

Make it explicit that we always want trace2 "version" events to be the
first event of any trace session. Also list the changes that would or
would not cause the EVENT format version field to be incremented.

Signed-off-by: Josh Steadmon <steadmon@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Josh Steadmon 5 years ago committed by Junio C Hamano
parent
commit
22541013d0
  1. 8
      Documentation/technical/api-trace2.txt

8
Documentation/technical/api-trace2.txt

@ -604,7 +604,13 @@ only present on the "start" and "atexit" events. @@ -604,7 +604,13 @@ only present on the "start" and "atexit" events.
==== Event-Specific Key/Value Pairs

`"version"`::
This event gives the version of the executable and the EVENT format.
This event gives the version of the executable and the EVENT format. It
should always be the first event in a trace session. The EVENT format
version will be incremented if new event types are added, if existing
fields are removed, or if there are significant changes in
interpretation of existing events or fields. Smaller changes, such as
adding a new field to an existing event, will not require an increment
to the EVENT format version.
+
------------
{

Loading…
Cancel
Save