[PATCH] D34339: [XRay] fix and clarify comments in the log file decoder [NFC]

Dean Michael Berris via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Mon Jun 19 02:31:35 PDT 2017


dberris added inline comments.


================
Comment at: lib/XRay/Trace.cpp:10-11
 //
-// XRay log reader implementation.
+// XRay log reader implementation.  Decodes logs written using compiler-rt's
+// naive and Flight Data Recorder XRay logging formats.
 //
----------------
This technically isn't strictly true. While there is an implementation of the naive and FDR mode logging, those may not be written by the implementation in compiler-rt. Making it sound like there's an actual dependency (as opposed to a coincidental dependency) may be misleading.

For instance, it's possible to write logs in this format without using the compiler-rt implementation.

Working on documenting the log details/format as opposed to referring to the compiler-rt implementation would be a strictly better approach. I'd rather change this comment to say the explicit versions of the log we're supporting and not mentioning anything in compiler-rt.


https://reviews.llvm.org/D34339





More information about the llvm-commits mailing list