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

[Jessica Paquette via Phabricator via llvm-commits]

paquette added inline comments.


================
Comment at: llvm/docs/Remarks.rst:36
+
+        foz not inlined into bar because it should never be inlined
+        (cost=never): noinline function attribute
----------------
Probably meant to write foo here? (Even though it's a dummy name, and foz is pretty good anyway)


================
Comment at: llvm/docs/Remarks.rst:72
+
+.. option:: -pass-remarks=<regex>
+
----------------
Should probably mention that this is a POSIX regex.


================
Comment at: llvm/docs/Remarks.rst:119
+
+      With PGO, include profile count in optimization remarks.
+
----------------
Link to PGO documentation so that people can look at terminology for profiling etc.?


================
Comment at: llvm/docs/Remarks.rst:240
+Produce a new YAML file which contains all of the changes in optimizations
+between two YAML files. (e.g, new compiler + source vs old compiler + source)
+
----------------
opt-diff is really *only* intended for a changing compiler + fixed source, right? "E.g." doesn't really pack enough punch here; we should probably just say that the tool isn't intended for a changing source + changing compiler.


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

https://reviews.llvm.org/D64355