[llvm-symbolizer] Add -p as alias to -pretty-print

[Quolyk]

Summary

Provides -p as a short alias for -pretty-print. Motivation: https://bugs.llvm.org/show_bug.cgi?id=40076

[jhenderson]

Thanks for working on this!

test/tools/llvm-symbolizer/sym.test

22

Nit, here and in the line above we're being inconsistent with the number of '-' characters used to prefix options (single dash for llvm-symbolizer, double for FileCheck). It would be nice if they were consistent. I have a marginal preference for double dash, but I don't mind if you want to go the other way.

tools/llvm-symbolizer/llvm-symbolizer.cpp

86

It looks like this line needs clang-formatting.

Aliases aren't in the help text by default, but you can make them be by adding the cl::NotHidden attribute. I think you should do that.

[Quolyk]

Add cl::NotHidden option

[Quolyk]

test/tools/llvm-symbolizer/sym.test

22

This is an opinionated question and I shall do as it comfortable to others for any historical reason.

[jhenderson]

Okay, looks good once the issue with the dashes is fixed.

[jhenderson]

test/tools/llvm-symbolizer/sym.test

22

I'm not sure I understand what you mean? I think that there was no good reason to use a mixture of single and double dashes before.

You can change the other lines in the test to make them all match.

[Quolyk]

FileCheck --check-prefix --> FileCheck -check-prefix

[jhenderson]

LGTM!

[Quolyk]

test/tools/llvm-symbolizer/sym.test

22

I agree, will take in account in future. I skimmed other tests and notices this pattern.

docs/CommandGuide/llvm-symbolizer.rst

  (Darwin-only flag). If the debug info for a binary isn't present in the default
  location, look for the debug info at the .dSYM path provided via the
  ``-dsym-hint`` flag. This flag can be used multiple times.
 
 .. option:: -print-address
 
  Print address before the source code location. Defaults to false.
 
-.. option:: -pretty-print
+.. option:: -pretty-print, -p
 
  Print human readable output. If ``-inlining`` is specified, enclosing scope is
  prefixed by (inlined by). Refer to listed examples.
 
 EXIT STATUS
 -----------
 
 :program:`llvm-symbolizer` returns 0. Other exit codes imply internal program error.

test/tools/llvm-symbolizer/sym.test

 #  int x = 1;
 #  return inc(&x);
 #}
 #
 #Build as : clang -g -O2 addr.c
 
 RUN: llvm-symbolizer -print-address -obj=%p/Inputs/addr.exe < %p/Inputs/addr.inp | FileCheck %s
 RUN: llvm-symbolizer -inlining -print-address -pretty-print -obj=%p/Inputs/addr.exe < %p/Inputs/addr.inp | FileCheck --check-prefix="PRETTY" %s 
+RUN: llvm-symbolizer -inlining -print-address -p -obj=%p/Inputs/addr.exe < %p/Inputs/addr.inp | FileCheck --check-prefix="PRETTY" %s
 RUN: echo "0x1" > %t.input
 RUN: llvm-symbolizer -obj=%p/Inputs/zero < %t.input | FileCheck --check-prefix="ZERO" %s
 
 #CHECK: some text
 #CHECK: 0x40054d
 #CHECK: main
 #CHECK: {{[/\]+}}tmp{{[/\]+}}x.c:14:0
 #CHECK: some text2

tools/llvm-symbolizer/llvm-symbolizer.cpp

 static cl::list<std::string>
 ClDsymHint("dsym-hint", cl::ZeroOrMore,
            cl::desc("Path to .dSYM bundles to search for debug info for the "
                     "object files"));
 static cl::opt<bool>
     ClPrintAddress("print-address", cl::init(false),
                    cl::desc("Show address before line information"));
 
+// -pretty-print, -p
 static cl::opt<bool>
     ClPrettyPrint("pretty-print", cl::init(false),
                   cl::desc("Make the output more human friendly"));
+static cl::alias ClPrettyPrintShort("p", cl::desc("Alias for --pretty-print"), cl::aliasopt(ClPrettyPrint));
 
 static cl::opt<int> ClPrintSourceContextLines(
     "print-source-context-lines", cl::init(0),
     cl::desc("Print N number of source file context"));
 
 static cl::opt<bool> ClVerbose("verbose", cl::init(false),
                                cl::desc("Print verbose line info"));