xref: /freebsd/contrib/llvm-project/llvm/tools/llvm-objcopy/CommonOpts.td (revision dc318a4ffabcbfa23bb56a33403aad36e6de30af)
1include "llvm/Option/OptParser.td"
2
3multiclass Eq<string name, string help> {
4  def NAME : Separate<["--"], name>;
5  def NAME #_eq : Joined<["--"], name #"=">,
6                  Alias<!cast<Separate>(NAME)>,
7                  HelpText<help>;
8}
9
10def help : Flag<["--"], "help">;
11def h : Flag<["-"], "h">, Alias<help>;
12
13def allow_broken_links
14    : Flag<["--"], "allow-broken-links">,
15      HelpText<"Allow the tool to remove sections even if it would leave "
16               "invalid section references. The appropriate sh_link fields "
17               "will be set to zero.">;
18
19def enable_deterministic_archives
20    : Flag<["--"], "enable-deterministic-archives">,
21      HelpText<"Enable deterministic mode when operating on archives (use "
22               "zero for UIDs, GIDs, and timestamps).">;
23def D : Flag<["-"], "D">,
24        Alias<enable_deterministic_archives>,
25        HelpText<"Alias for --enable-deterministic-archives">;
26
27def disable_deterministic_archives
28    : Flag<["--"], "disable-deterministic-archives">,
29      HelpText<"Disable deterministic mode when operating on archives (use "
30               "real values for UIDs, GIDs, and timestamps).">;
31def U : Flag<["-"], "U">,
32        Alias<disable_deterministic_archives>,
33        HelpText<"Alias for --disable-deterministic-archives">;
34
35def preserve_dates : Flag<["--"], "preserve-dates">,
36                     HelpText<"Preserve access and modification timestamps">;
37def p : Flag<["-"], "p">,
38        Alias<preserve_dates>,
39        HelpText<"Alias for --preserve-dates">;
40
41def strip_all : Flag<["--"], "strip-all">,
42                HelpText<"Remove non-allocated sections outside segments. "
43                         ".gnu.warning* and .ARM.attribute sections are not "
44                         "removed">;
45
46def strip_all_gnu
47    : Flag<["--"], "strip-all-gnu">,
48      HelpText<"Compatible with GNU's --strip-all">;
49
50def strip_debug : Flag<["--"], "strip-debug">,
51                  HelpText<"Remove all debug sections">;
52def g : Flag<["-"], "g">,
53        Alias<strip_debug>,
54        HelpText<"Alias for --strip-debug">;
55
56def strip_unneeded : Flag<["--"], "strip-unneeded">,
57                     HelpText<"Remove all symbols not needed by relocations">;
58
59defm remove_section : Eq<"remove-section", "Remove <section>">,
60                      MetaVarName<"section">;
61def R : JoinedOrSeparate<["-"], "R">,
62        Alias<remove_section>,
63        HelpText<"Alias for --remove-section">;
64
65def strip_sections
66    : Flag<["--"], "strip-sections">,
67      HelpText<"Remove all section headers and all sections not in segments">;
68
69defm strip_symbol : Eq<"strip-symbol", "Strip <symbol>">,
70                    MetaVarName<"symbol">;
71def N : JoinedOrSeparate<["-"], "N">,
72        Alias<strip_symbol>,
73        HelpText<"Alias for --strip-symbol">;
74
75defm keep_section : Eq<"keep-section", "Keep <section>">,
76                    MetaVarName<"section">;
77
78defm keep_symbol : Eq<"keep-symbol", "Do not remove symbol <symbol>">,
79                   MetaVarName<"symbol">;
80def K : JoinedOrSeparate<["-"], "K">,
81        Alias<keep_symbol>,
82        HelpText<"Alias for --keep-symbol">;
83
84def keep_file_symbols : Flag<["--"], "keep-file-symbols">,
85                        HelpText<"Do not remove file symbols">;
86
87def only_keep_debug
88    : Flag<["--"], "only-keep-debug">,
89      HelpText<
90          "Produce a debug file as the output that only preserves contents of "
91          "sections useful for debugging purposes">;
92
93def discard_locals : Flag<["--"], "discard-locals">,
94                     HelpText<"Remove compiler-generated local symbols, (e.g. "
95                              "symbols starting with .L)">;
96def X : Flag<["-"], "X">,
97        Alias<discard_locals>,
98        HelpText<"Alias for --discard-locals">;
99
100def discard_all
101    : Flag<["--"], "discard-all">,
102      HelpText<"Remove all local symbols except file and section symbols">;
103def x : Flag<["-"], "x">,
104        Alias<discard_all>,
105        HelpText<"Alias for --discard-all">;
106
107def regex
108    : Flag<["--"], "regex">,
109      HelpText<"Permit regular expressions in name comparison">;
110
111def version : Flag<["--"], "version">,
112              HelpText<"Print the version and exit.">;
113def V : Flag<["-"], "V">,
114        Alias<version>,
115        HelpText<"Alias for --version">;
116
117def wildcard
118    : Flag<["--"], "wildcard">,
119      HelpText<"Allow wildcard syntax for symbol-related flags. Incompatible "
120               "with --regex. Allows using '*' to match any number of "
121               "characters, '?' to match any single character, '\' to escape "
122               "special characters, and '[]' to define character classes. "
123               "Wildcards beginning with '!' will prevent a match, for example "
124               "\"-N '*' -N '!x'\" will strip all symbols except for \"x\".">;
125def w : Flag<["-"], "w">, Alias<wildcard>, HelpText<"Alias for --wildcard">;
126