diff options
Diffstat (limited to 'llvm/docs')
| -rw-r--r-- | llvm/docs/CodeGenerator.rst | 11 | ||||
| -rw-r--r-- | llvm/docs/CommandGuide/llc.rst | 4 |
2 files changed, 15 insertions, 0 deletions
diff --git a/llvm/docs/CodeGenerator.rst b/llvm/docs/CodeGenerator.rst index c0e3d53e969..094bd05adb6 100644 --- a/llvm/docs/CodeGenerator.rst +++ b/llvm/docs/CodeGenerator.rst @@ -1589,6 +1589,17 @@ and stack sizes (unsigned LEB128). The stack size values only include the space allocated in the function prologue. Functions with dynamic stack allocations are not included. +Emitting remark diagnostics in the object file +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +A section containing metadata on remark diagnostics will be emitted when +-remarks-section is passed. The section contains: + +* a magic number: "REMARKS\0" +* the version number: a little-endian uint64_t +* the absolute file path to the serialized remark diagnostics: a + null-terminated string. + VLIW Packetizer --------------- diff --git a/llvm/docs/CommandGuide/llc.rst b/llvm/docs/CommandGuide/llc.rst index da096f1263a..aaf7e2e6b77 100644 --- a/llvm/docs/CommandGuide/llc.rst +++ b/llvm/docs/CommandGuide/llc.rst @@ -140,6 +140,10 @@ End-user Options in the function prologue. Functions with dynamic stack allocations are not included. +.. option:: -remarks-section + + Emit the .remarks (ELF) / __remarks (MachO) section which contains metadata + about remark diagnostics. Tuning/Configuration Options ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
