[PATCH] D129839: [obj2yaml] Refactor command line parsing

[Fangrui Song via Phabricator via llvm-commits]

MaskRay created this revision.
MaskRay added a reviewer: jhenderson.
Herald added a subscriber: StephenFan.
Herald added a project: All.
MaskRay requested review of this revision.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

Similar to D73982 <https://reviews.llvm.org/D73982> for yaml2obj.

- Hide unrelated options.
- Add an OVERVIEW: message.
- Disallow single-dash long options.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D129839

Files:
  llvm/test/tools/obj2yaml/help.test
  llvm/tools/obj2yaml/obj2yaml.cpp


Index: llvm/tools/obj2yaml/obj2yaml.cpp
===================================================================
--- llvm/tools/obj2yaml/obj2yaml.cpp
+++ llvm/tools/obj2yaml/obj2yaml.cpp
@@ -20,16 +20,20 @@
 using namespace llvm;
 using namespace llvm::object;
 
+static cl::OptionCategory Cat("obj2yaml Options");
+
 static cl::opt<std::string>
     InputFilename(cl::Positional, cl::desc("<input file>"), cl::init("-"));
 static cl::opt<std::string> OutputFilename("o", cl::desc("Output filename"),
                                            cl::value_desc("filename"),
-                                           cl::init("-"), cl::Prefix);
+                                           cl::init("-"), cl::Prefix,
+                                           cl::cat(Cat));
 static cl::bits<RawSegments> RawSegment(
     "raw-segment",
     cl::desc("Mach-O: dump the raw contents of the listed segments instead of "
              "parsing them:"),
-    cl::values(clEnumVal(data, "__DATA"), clEnumVal(linkedit, "__LINKEDIT")));
+    cl::values(clEnumVal(data, "__DATA"), clEnumVal(linkedit, "__LINKEDIT")),
+    cl::cat(Cat));
 
 static Error dumpObject(const ObjectFile &Obj, raw_ostream &OS) {
   if (Obj.isCOFF())
@@ -97,7 +101,10 @@
 
 int main(int argc, char *argv[]) {
   InitLLVM X(argc, argv);
-  cl::ParseCommandLineOptions(argc, argv);
+  cl::HideUnrelatedOptions(Cat);
+  cl::ParseCommandLineOptions(
+      argc, argv, "Dump a YAML description from an object file", nullptr,
+      nullptr, /*LongOptionsUseDoubleDash=*/true);
 
   std::error_code EC;
   std::unique_ptr<ToolOutputFile> Out(
Index: llvm/test/tools/obj2yaml/help.test
===================================================================
--- /dev/null
+++ llvm/test/tools/obj2yaml/help.test
@@ -0,0 +1,11 @@
+## Show that help text is printed correctly when requested.
+
+# RUN: obj2yaml -h | FileCheck %s --check-prefixes=CHECK,CATEG --implicit-check-not=Options:
+# RUN: obj2yaml --help | FileCheck %s --check-prefixes=CHECK,CATEG --implicit-check-not=Options:
+# RUN: obj2yaml --help-list | FileCheck %s --implicit-check-not=Options:
+
+# CHECK: OVERVIEW: Dump a YAML description from an object file
+# CHECK: USAGE: obj2yaml{{(.exe)?}} [options] <input file>{{$}}
+# CHECK: OPTIONS:
+# CATEG: Generic Options:
+# CATEG: obj2yaml Options:


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D129839.444904.patch
Type: text/x-patch
Size: 2315 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20220715/dd73c847/attachment.bin>