[llvm-nm] Support the -V option, print that the tool is compatible with GNU nm
authorMartin Storsjö <martin@martin.st>
Tue, 11 May 2021 06:19:52 +0000 (09:19 +0300)
committerMartin Storsjö <martin@martin.st>
Thu, 13 May 2021 19:36:25 +0000 (22:36 +0300)
This unlocks some codepaths in libtool.

Differential Revision: https://reviews.llvm.org/D102321

llvm/docs/CommandGuide/llvm-nm.rst
llvm/test/tools/llvm-nm/libtool-version.test [new file with mode: 0644]
llvm/tools/llvm-nm/llvm-nm.cpp

index 20779b1..cdb1fd3 100644 (file)
@@ -230,10 +230,10 @@ OPTIONS
 
  Print only undefined symbols.
 
-.. option:: --version
+.. option:: --version, -V
 
- Display the version of the :program:`llvm-nm` executable. Does not stack with
- other commands.
+ Display the version of the :program:`llvm-nm` executable, then exit. Does not
stack with other commands.
 
 .. option:: --without-aliases
 
diff --git a/llvm/test/tools/llvm-nm/libtool-version.test b/llvm/test/tools/llvm-nm/libtool-version.test
new file mode 100644 (file)
index 0000000..ee53d0b
--- /dev/null
@@ -0,0 +1,8 @@
+# Check that the output of llvm-nm -V (and --version) contains the text
+# "GNU" somewhere, to let libtool know that it is compatible with GNU nm.
+# Also check that it contains the LLVM version.
+
+RUN: llvm-nm -V | FileCheck %s
+RUN: llvm-nm --version | FileCheck %s
+CHECK: LLVM version
+CHECK: GNU
index 3f52a22..e21f18a 100644 (file)
@@ -229,6 +229,8 @@ cl::opt<bool> AddInlinedInfo("add-inlinedinfo",
                                       "TBD(Mach-O) only"),
                              cl::cat(NMCat));
 
+cl::opt<bool> Version("V", cl::desc("Print version info"), cl::cat(NMCat));
+
 cl::extrahelp HelpResponse("\nPass @FILE as argument to read options from FILE.\n");
 
 bool PrintAddress = true;
@@ -2235,11 +2237,23 @@ static void dumpSymbolNamesFromFile(std::string &Filename) {
   }
 }
 
+static void printExtraVersionInfo(raw_ostream &Outs) {
+  // This needs to contain the word "GNU", libtool looks for that string.
+  Outs << "llvm-nm, compatible with GNU nm\n";
+}
+
 int main(int argc, char **argv) {
   InitLLVM X(argc, argv);
   cl::HideUnrelatedOptions(NMCat);
+  cl::AddExtraVersionPrinter(printExtraVersionInfo);
   cl::ParseCommandLineOptions(argc, argv, "llvm symbol table dumper\n");
 
+  if (Version) {
+    cl::PrintVersionMessage();
+    printExtraVersionInfo(outs());
+    return 0;
+  }
+
   // llvm-nm only reads binary files.
   if (error(sys::ChangeStdinToBinary()))
     return 1;