[NFC][intelpt] Improve IntelPT trace bundle documentation
authorJakob Johnson <johnsonjakob99@gmail.com>
Sun, 6 Nov 2022 22:32:18 +0000 (14:32 -0800)
committerJakob Johnson <johnsonjakob99@gmail.com>
Tue, 8 Nov 2022 13:16:28 +0000 (05:16 -0800)
Mention that the LLVM/clang triple must be provided if the trace will be
consumed via `SBTraceCursor`

Test Plan:

Differential Revision: https://reviews.llvm.org/D137509

lldb/source/Plugins/Trace/intel-pt/TraceIntelPTBundleLoader.cpp

index cac91e8..0e664fd 100644 (file)
@@ -241,6 +241,8 @@ StringRef TraceIntelPTBundleLoader::GetSchema() {
       "pid": integer,
       "triple"?: string,
           // Optional clang/llvm target triple.
+          // This must be provided if the trace will be created not using the
+          // CLI or on a machine other than where the target was traced.
       "threads": [
           // A list of known threads for the given process. When context switch
           // data is provided, LLDB will automatically create threads for the