aaron.ballman added inline comments.
================
Comment at: clang-tidy/ClangTidy.h:230-232
+/// \param StoreCheckProfile If provided, and EnableCheckProfile is true,
+/// the profile will not be outputted to the stderr, but instead will be stored
+/// as JSON file in the specified directory.
----------------
Minor wording nits to fix grammar, how about: "...the profile will not be
output to stderr, but will instead be stored as a JSON file in the specified
directory."
================
Comment at: clang-tidy/ClangTidyProfiling.cpp:47
+void ClangTidyProfiling::printAsJSON(llvm::raw_ostream &OS) {
+ OS << "{\n";
----------------
I'm not keen that we call this `printAsJSON()` when the docs talk about writing
out YAML. While all JSON is valid YAML, that feels like trivia we shouldn't
encode in the function name. What do you think to renaming to `printAsYAML()`
instead?
================
Comment at: clang-tidy/ClangTidyProfiling.cpp:77
+
+ printAsJSON(OS);
+}
----------------
I'm not keen that we call `printAsJSON` when the docs talk about writing out
YAML. While all JSON is valid YAML, that feels like trivia we shouldn't encode
in the function name. What do you think to renaming to `printAsYAML()` instead?
================
Comment at: docs/clang-tidy/index.rst:257
+
:program:`clang-tidy` diagnostics are intended to call out code that does
----------------
Spurious change?
================
Comment at: docs/clang-tidy/index.rst:757
+
+To enable profiling info collection, use ``-enable-check-profile`` argument.
+The timings will be outputted to the ``stderr`` as a table. Example output:
----------------
use -> use the
================
Comment at: docs/clang-tidy/index.rst:758
+To enable profiling info collection, use ``-enable-check-profile`` argument.
+The timings will be outputted to the ``stderr`` as a table. Example output:
+
----------------
will be output to stderr
================
Comment at: docs/clang-tidy/index.rst:802
+ Example:
+ Let's suppose you have a source file named ``example.cpp``, located in
+ ``/source`` directory. Only the input filename is used, not the full path
----------------
in -> in the
Repository:
rCTE Clang Tools Extra
https://reviews.llvm.org/D46602
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
