[PATCH] D152771: [docs] Fix LibTooling documentation for OptionsParser change

[Hironao OTSUBO via Phabricator via cfe-commits]

motemen created this revision.
motemen added reviewers: serge-sans-paille, nridge.
Herald added a project: All.
motemen requested review of this revision.
Herald added a project: clang.
Herald added a subscriber: cfe-commits.

Additional documentation fix per https://reviews.llvm.org/D94420


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D152771

Files:
  clang/docs/LibTooling.rst


Index: clang/docs/LibTooling.rst
===
--- clang/docs/LibTooling.rst
+++ clang/docs/LibTooling.rst
@@ -69,9 +69,15 @@
   static llvm::cl::OptionCategory MyToolCategory("my-tool options");
 
   int main(int argc, const char **argv) {
-// CommonOptionsParser constructor will parse arguments and create a
-// CompilationDatabase.  In case of error it will terminate the program.
-CommonOptionsParser OptionsParser(argc, argv, MyToolCategory);
+// CommonOptionsParser::create will parse arguments and create a
+// CompilationDatabase.
+auto ExpectedParser = CommonOptionsParser::create(argc, argv, 
MyToolCategory);
+if (!ExpectedParser) {
+  // Fail gracefully for unsupported options.
+  llvm::errs() << ExpectedParser.takeError();
+  return 1;
+}
+CommonOptionsParser &OptionsParser = ExpectedParser.get();
 
 // Use OptionsParser.getCompilations() and 
OptionsParser.getSourcePathList()
 // to retrieve CompilationDatabase and the list of input file paths.
@@ -133,7 +139,13 @@
   static cl::extrahelp MoreHelp("\nMore help text...\n");
 
   int main(int argc, const char **argv) {
-CommonOptionsParser OptionsParser(argc, argv, MyToolCategory);
+auto ExpectedParser = CommonOptionsParser::create(argc, argv, 
MyToolCategory);
+if (!ExpectedParser) {
+  // Fail gracefully for unsupported options.
+  llvm::errs() << ExpectedParser.takeError();
+  return 1;
+}
+CommonOptionsParser &OptionsParser = ExpectedParser.get();
 ClangTool Tool(OptionsParser.getCompilations(),
OptionsParser.getSourcePathList());
 return Tool.run(newFrontendActionFactory().get());


Index: clang/docs/LibTooling.rst
===
--- clang/docs/LibTooling.rst
+++ clang/docs/LibTooling.rst
@@ -69,9 +69,15 @@
   static llvm::cl::OptionCategory MyToolCategory("my-tool options");
 
   int main(int argc, const char **argv) {
-// CommonOptionsParser constructor will parse arguments and create a
-// CompilationDatabase.  In case of error it will terminate the program.
-CommonOptionsParser OptionsParser(argc, argv, MyToolCategory);
+// CommonOptionsParser::create will parse arguments and create a
+// CompilationDatabase.
+auto ExpectedParser = CommonOptionsParser::create(argc, argv, MyToolCategory);
+if (!ExpectedParser) {
+  // Fail gracefully for unsupported options.
+  llvm::errs() << ExpectedParser.takeError();
+  return 1;
+}
+CommonOptionsParser &OptionsParser = ExpectedParser.get();
 
 // Use OptionsParser.getCompilations() and OptionsParser.getSourcePathList()
 // to retrieve CompilationDatabase and the list of input file paths.
@@ -133,7 +139,13 @@
   static cl::extrahelp MoreHelp("\nMore help text...\n");
 
   int main(int argc, const char **argv) {
-CommonOptionsParser OptionsParser(argc, argv, MyToolCategory);
+auto ExpectedParser = CommonOptionsParser::create(argc, argv, MyToolCategory);
+if (!ExpectedParser) {
+  // Fail gracefully for unsupported options.
+  llvm::errs() << ExpectedParser.takeError();
+  return 1;
+}
+CommonOptionsParser &OptionsParser = ExpectedParser.get();
 ClangTool Tool(OptionsParser.getCompilations(),
OptionsParser.getSourcePathList());
 return Tool.run(newFrontendActionFactory().get());
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[PATCH] D152771: [docs] Fix LibTooling documentation for OptionsParser change

[Hironao OTSUBO via Phabricator via cfe-commits]

motemen added a comment.

Thank you for your review. Though I'm interested in it, I'm not familiar with 
the build system. So I won't go further in this patch. 
Thanks!


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D152771

___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits