paulkirth accepted this revision.
paulkirth added a comment.
This revision is now accepted and ready to land.
LGTM w/ the caveat that I think we should update the release notes, since we're
changing the default behavior of a command line tool. I've also left a few
small suggestions the wording.
================
Comment at: clang-tools-extra/clang-doc/tool/ClangDocMain.cpp:188
- if (!Exec) {
- llvm::errs() << toString(Exec.takeError()) << "\n";
+ Example usage for files without flags:
+
----------------
================
Comment at: clang-tools-extra/clang-doc/tool/ClangDocMain.cpp:192
+
+ Example usage for a project using compile commands database:
+
----------------
================
Comment at: clang-tools-extra/docs/clang-doc.rst:28
-By default, the tool will run on all files listed in the given compile commands
-database:
+The tool will process listed files by default:
----------------
================
Comment at: clang-tools-extra/docs/clang-doc.rst:34
-The tool can also be used on a single file or multiple files if a build path is
-passed with the ``-p`` flag.
+The tool can be also used with compile commands database:
----------------
================
Comment at: clang-tools-extra/docs/clang-doc.rst:77
+
+ Example usage for files without flags:
+
----------------
================
Comment at: clang-tools-extra/docs/clang-doc.rst:81
+
+ Example usage for a project using compile commands database:
+
----------------
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D130226/new/
https://reviews.llvm.org/D130226
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
