[PATCH] D64355: [docs][Remarks] Add documentation for remarks in LLVM

[Francis Visoiu Mistrih via Phabricator via llvm-commits]

thegameg added inline comments.


================
Comment at: llvm/docs/Remarks.rst:97
+
+:doc:`llc <CommandGuide/llc>` and :doc:`opt <CommandGuide/opt>` support the
+following options:
----------------
Meinersbur wrote:
> Clang does as well using `-mllvm`
I initially didn't want to mention clang at all in the docs here, but if you think it's useful I can add the missing clang flags as well.


================
Comment at: llvm/docs/Remarks.rst:119
+
+      With PGO, include profile count in optimization remarks.
+
----------------
paquette wrote:
> Link to PGO documentation so that people can look at terminology for profiling etc.?
I tried looking for a link, but I can't find anything else than https://llvm.org/docs/HowToBuildWithPGO.html...


================
Comment at: llvm/docs/Remarks.rst:282
+    LLVMRemarkEntryRef Remark = NULL;
+    while ((Remark == LLVMRemarkParserGetNext(Parser))) {
+       // use Remark
----------------
Meinersbur wrote:
> Is this meant to use `=` (assignment instead of comparison)?
It is indeed!


CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D64355/new/

https://reviews.llvm.org/D64355