[llvm-dev] RFC: XRay in the LLVM Library

[Renato Golin via llvm-dev]

On 1 December 2016 at 00:17, Dean Michael Berris <dean.berris at gmail.com> wrote:
> Thanks Renato! Just so I understand this one sentence (to disambiguate), you meant:
>
> 1) Don't have multiple canonical forms, just have one.
> 2) Create tools that will convert to/from that one canonical format.

Yup.


> I think this follows closely the Option B mental model that I had, with the only difference being the canonical reader is a library made part of LLVM "when it's ready", as you suggest later. Would that be accurate?

Yup. :)


> So in essence we can treat the current implementation as experimental, and make that abundantly clear in any point release where XRay functionality will be included. Is there a clear place where this ought to be documented clearly (aside from the documentation at http://llvm.org/docs/XRay.html)?

I'd add this to the release change log, too. And whenever you decide
to make it stable, call it "1.0" or something and again, mention in
the change log that, from now on, it won't change unless it has to.


> XRay trace file headers already contain a version identifier, intended to precisely identify how a reader would interpret the data in there.

Perfect!

cheers,
--renato