[dsymutil] Fix short options displayed in the help message.

[Higuoxing]

Summary

This patch helps make the short options displayed in the help message be consistant with the description in https://llvm.org/docs/CommandGuide/dsymutil.html

[Higuoxing]

I am wondering if we could remove --o/--S/--y.

[jhenderson]

I'm not a dsymutil user or developer, so whilst your change makes sense, I'm not sure if I'm best placed to review it. I've added a couple more reviewers who have recently touched dsymutil.

[JDevlieghere]

LGTM.

In D78476#1991727, @Higuoxing wrote:

I am wondering if we could remove --o/--S/--y.

Before I converted option parsing to libOpt it was using cl::opt which does not differentiate between the two. Unfortunately we have users that have to come to rely on this. I think it's a small enough price to pay to keep them around and not break their workflows.

[aprantl]

Not sure how applicable this is here, but I wanted to point out that we do have a test specifically for the help text llvm/test/tools/dsymutil/cmdline.test. Perhaps this patch can be tested there.

[Higuoxing]

In D78476#1992621, @aprantl wrote:

Not sure how applicable this is here, but I wanted to point out that we do have a test specifically for the help text llvm/test/tools/dsymutil/cmdline.test. Perhaps this patch can be tested there.

Hi @aprantl

Sorry for the late response. I've checked cmdline.test, and these options are checked in this way.

dsymutil --help | FileCheck %s --check-prefix=HELP
HELP: -option1
HELP: -option2

However, -option matches both --option and -option. I've also checked other tools' cmdline.test/help.test, which are similar to dsymutil's. I guess we should use regex patterns to exactly match what we want? Do you have any suggestion?

[aprantl]

If you want to match this perfectly you can probably write {{--option}}.

[jhenderson]

In D78476#2004599, @Higuoxing wrote:

In D78476#1992621, @aprantl wrote:

Not sure how applicable this is here, but I wanted to point out that we do have a test specifically for the help text llvm/test/tools/dsymutil/cmdline.test. Perhaps this patch can be tested there.

Hi @aprantl

Sorry for the late response. I've checked cmdline.test, and these options are checked in this way.

dsymutil --help | FileCheck %s --check-prefix=HELP
HELP: -option1
HELP: -option2

However, -option matches both --option and -option. I've also checked other tools' cmdline.test/help.test, which are similar to dsymutil's. I guess we should use regex patterns to exactly match what we want? Do you have any suggestion?

Assuming we want only "--option1" to be matched, why not simply change the text to --option1? If we want to allow either version, then -option1 is fine, or you could be more specific with {{-?}}-option1. Finally, you could also ensure there'se a space before the option by doing {{ }}--option1 or even {{ -?}}-option1.

[Higuoxing]

In D78476#2007080, @jhenderson wrote:

Assuming we want only "--option1" to be matched, why not simply change the text to --option1? If we want to allow either version, then -option1 is fine, or you could be more specific with {{-?}}-option1. Finally, you could also ensure there'se a space before the option by doing {{ }}--option1 or even {{ -?}}-option1.

Sorry for the misleading, in this patch, I changed some long options (--o, --y) to (-o and -y), however, for example, pattern "-o" matches both --o and -o. I am wondering, is there any way to match exactly -o? I've checked other LLVM tools, and it seems that there is no such pattern?

[jhenderson]

In D78476#2007114, @Higuoxing wrote:

In D78476#2007080, @jhenderson wrote:

Assuming we want only "--option1" to be matched, why not simply change the text to --option1? If we want to allow either version, then -option1 is fine, or you could be more specific with {{-?}}-option1. Finally, you could also ensure there'se a space before the option by doing {{ }}--option1 or even {{ -?}}-option1.

Sorry for the misleading, in this patch, I changed some long options (--o, --y) to (-o and -y), however, for example, pattern "-o" matches both --o and -o. I am wondering, is there any way to match exactly -o? I've checked other LLVM tools, and it seems that there is no such pattern?

Ah, okay. FileCheck has "--match-full-lines" as one option, but it's probably not what you want in this case, as there will be other text on the same line that you don't want. Assuming there is whitespace before and after the option name, you can adapt the second-to last of my suggestions above to {{ }}-o{{ }} or even {{ -o }}. Spaces within the regex will be forcibly matched which should solve your problems. You can also use ^ and $ for regex markers for the start* and end of a line.

• "start" here means the end of the previous match, if on the same line as the current one, or the start of the line otherwise.

[Higuoxing]

Thanks you @jhenderson and @aprantl, it helps a lot!

---

Addressed comments.

• Update cmdline.test to test this change.

[aprantl]

Thanks!

llvm/test/tools/dsymutil/cmdline.test

 RUN: dsymutil -help 2>&1 | FileCheck --check-prefix=HELP %s
 HELP: OVERVIEW: manipulate archived DWARF debug symbol files.
 HELP: USAGE: {{.*}}dsymutil{{[^ ]*}} [options] <input files>
 HELP-NOT: -reverse-iterate
 HELP: Dsymutil Options:
 HELP: -accelerator
 HELP: -arch <arch>
 HELP: -dump-debug-map
 HELP: -flat
 HELP: -minimize
 HELP: -no-odr
 HELP: -no-output
 HELP: -no-swiftmodule-timestamp
 HELP: -num-threads <threads>
 HELP: -object-prefix-map <prefix=remapped>
 HELP: -oso-prepend-path <path>
-HELP: -o <filename>
+HELP: {{ -o <filename> }}
 HELP: -papertrail
 HELP: -remarks-output-format <format>
 HELP: -remarks-prepend-path <path>
 HELP: -symbol-map
 HELP: -symtab
+HELP: {{ -S }}
 HELP: -toolchain
 HELP: -update
 HELP: -verbose
 HELP: -verify
-HELP: -y
+HELP: {{ -y }}
 HELP-NOT: -reverse-iterate
 
 RUN: dsymutil --version 2>&1 | FileCheck --check-prefix=VERSION %s
 VERSION: {{ version }}
 
 RUN: not dsymutil 2>&1 | FileCheck --check-prefix=NOINPUT %s
 NOINPUT: error: no input files specified
 
 RUN: dsymutil -bogus -help 2>&1 | FileCheck --check-prefix=BOGUS %s
 BOGUS: warning: ignoring unknown option: -bogus

llvm/tools/dsymutil/Options.td

 def no_odr: F<"no-odr">,
   HelpText<"Do not use ODR (One Definition Rule) for type uniquing.">,
   Group<grp_general>;
 
 def dump_debug_map: F<"dump-debug-map">,
   HelpText<"Parse and dump the debug map to standard output. Not DWARF link will take place.">,
   Group<grp_general>;
 
-def yaml_input: F<"y">,
+def yaml_input: Flag<["-", "--"], "y">,
   HelpText<"Treat the input file is a YAML debug map rather than a binary.">,
   Group<grp_general>;
 
 def papertrail: F<"papertrail">,
   HelpText<"Embed warnings in the linked DWARF debug info.">,
   Group<grp_general>;
 
-def assembly: F<"S">,
+def assembly: Flag<["-", "--"], "S">,
   HelpText<"Output textual assembly instead of a binary dSYM companion file.">,
   Group<grp_general>;
 
 def symtab: F<"symtab">,
   HelpText<"Dumps the symbol table found in executable or object file(s) and exits.">,
   Group<grp_general>;
 def: Flag<["-"], "s">,
   Alias<symtab>,

 def update: F<"update">,
   HelpText<"Updates existing dSYM files to contain the latest accelerator tables and other DWARF optimizations.">,
   Group<grp_general>;
 def: Flag<["-"], "u">,
   Alias<update>,
   HelpText<"Alias for --update">,
   Group<grp_general>;
 
-def output: Separate<["--", "-"], "o">,
+def output: Separate<["-", "--"], "o">,
   MetaVarName<"<filename>">,
   HelpText<"Specify the output file. Defaults to <input file>.dwarf">,
   Group<grp_general>;
 def: Separate<["--", "-"], "out">,
   Alias<output>,
-  HelpText<"Alias for --o">,
+  HelpText<"Alias for -o">,
   Group<grp_general>;
 def: Joined<["--", "-"], "out=">, Alias<output>;
-def: Joined<["--", "-"], "o=">, Alias<output>;
+def: Joined<["-", "--"], "o=">, Alias<output>;
 
 def oso_prepend_path: Separate<["--", "-"], "oso-prepend-path">,
   MetaVarName<"<path>">,
   HelpText<"Specify a directory to prepend to the paths of object files.">,
   Group<grp_general>;
 def: Joined<["--", "-"], "oso-prepend-path=">, Alias<oso_prepend_path>;
 
 def object_prefix_map: Separate<["--", "-"], "object-prefix-map">,