1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-22 18:54:02 +01:00
llvm-mirror/docs/CommandGuide
Fangrui Song 601cf9f2c4 [llvm-readobj] Switch command line parsing from llvm::cl to OptTable
Users should generally observe no difference as long as they don't use
unintended option forms. Behavior changes:

* `-t=d` is removed. Use `-t d` instead.
* `--demangle=false` and `--demangle=0` cannot be used. Omit the option or use `--no-demangle`. Other flag-style options don't have `--no-` forms.
* `--help-list` is removed. This is a `cl::` specific option.
* llvm-readobj now supports grouped short options as well.
* `--color` is removed. This is generally not useful (only apply to errors/warnings) but was inherited from Support.

Some adjustment to the canonical forms
(usually from GNU readelf; currently llvm-readobj has too many redundant aliases):

* --dyn-syms is canonical. --dyn-symbols is a hidden alias
* --file-header is canonical. --file-headers is a hidden alias
* --histogram is canonical. --elf-hash-histogram is a hidden alias
* --relocs is canonical. --relocations is a hidden alias
* --section-groups is canonical. --elf-section-groups is a hidden alias

OptTable avoids global option collision if we decide to support multiplexing for binary utilities.

* Most one-dash long options are still supported. `-dt, -sd, -st, -sr` are dropped due to their conflict with grouped short options.
* `--section-mapping=false` (D57365) is strange but is kept for now.
* Many `cl::opt` variables were unnecessarily external. I added `static` whenever appropriate.

Reviewed By: jhenderson

Differential Revision: https://reviews.llvm.org/D105532
2021-07-12 10:14:42 -07:00
..
bugpoint.rst [docs] [tools] Fix see also links 2019-07-04 21:19:05 +00:00
clang-tblgen.rst [TableGen] [docs] Change title of tblgen.rst to fix man page filename 2021-04-09 09:37:56 -04:00
dsymutil.rst [dsymutil] Add flag to force a static variable to keep its enclosing function 2021-04-28 11:33:04 -07:00
FileCheck.rst [FileCheck] Add support for hex alternate form in FileCheck 2021-03-12 18:14:17 +00:00
index.rst [llvm-objdump] Add an llvm-otool tool 2021-04-20 08:24:58 -04:00
lit.rst [lit] Extend --xfail/LIT_XFAIL to take full test name 2021-07-01 15:46:37 -04:00
llc.rst [llc] (almost) remove --print-machineinstrs 2020-07-20 10:43:28 -07:00
lldb-tblgen.rst [TableGen] [docs] Change title of tblgen.rst to fix man page filename 2021-04-09 09:37:56 -04:00
lli.rst [llc] (almost) remove --print-machineinstrs 2020-07-20 10:43:28 -07:00
llvm-addr2line.rst llvm-addr2line: assume addresses on the command line are hexadecimal rather than attempting to guess the base based on the form of the number. 2020-04-16 16:16:21 -07:00
llvm-ar.rst [docs][llvm-ar] Add rsp-quoting option to the llvm-ar command guide. 2021-06-10 16:32:31 +01:00
llvm-as.rst [docs] [tools] Fix see also links 2019-07-04 21:19:05 +00:00
llvm-bcanalyzer.rst [docs] [tools] Fix see also links 2019-07-04 21:19:05 +00:00
llvm-config.rst [docs] [NFC] Removed excess spacing 2019-07-04 04:41:06 +00:00
llvm-cov.rst [docs] Update llvm-cov gcov 2021-06-03 12:36:27 -07:00
llvm-cxxfilt.rst [llvm-cxxfilt] Switch command line parsing from llvm::cl to OptTable 2021-07-09 10:10:45 -07:00
llvm-cxxmap.rst llvm-cxxmap: fix support for remapping non-mangled names. 2019-12-18 10:47:02 -08:00
llvm-diff.rst [docs] [NFC] Removed excess spacing 2019-07-04 04:41:06 +00:00
llvm-dis.rst [docs] [tools] Fix see also links 2019-07-04 21:19:05 +00:00
llvm-dwarfdump.rst [docs][llvm-dwarfdump] Fix the warnings during docs-llvm-html buil 2020-06-25 11:04:28 +02:00
llvm-exegesis-analysis.png
llvm-exegesis.rst [llvm-exegesis] Loop unrolling for loop snippet repetitor mode 2021-05-25 12:08:27 +03:00
llvm-extract.rst [docs] Fix typos 2020-08-09 19:31:49 -07:00
llvm-install-name-tool.rst [llvm] Fix typos in documentation (NFC) 2021-02-27 10:09:23 -08:00
llvm-lib.rst [docs] [NFC] Removed excess spacing 2019-07-04 04:41:06 +00:00
llvm-libtool-darwin.rst [llvm-libtool] Emit warnings for files without symbols 2021-02-16 17:52:12 -08:00
llvm-link.rst [docs] [NFC] Removed excess spacing 2019-07-04 04:41:06 +00:00
llvm-lipo.rst doc: use the right url to bugzilla 2020-03-22 22:49:40 +01:00
llvm-locstats.rst [llvm-locstats] Add the --compare option 2020-01-15 14:35:29 +01:00
llvm-mca.rst [llvm-mca] Fix JSON output (PR50922) 2021-07-01 12:53:20 +01:00
llvm-nm.rst [llvm-nm] Switch command line parsing from llvm::cl to OptTable 2021-07-07 13:34:33 -07:00
llvm-objcopy.rst [docs] Fix llvm-objcopy.rst 2021-03-08 19:06:32 -08:00
llvm-objdump.rst [llvm-objdump] Add --no-print-imm-hex to the command guide 2021-06-29 17:18:32 +01:00
llvm-otool.rst [llvm-objdump] Add an llvm-otool tool 2021-04-20 08:24:58 -04:00
llvm-pdbutil.rst [docs][tools] Add missing "program" tags to rst files 2019-06-27 13:24:46 +00:00
llvm-profdata.rst Supplement instr profile with sample profile. 2020-07-27 20:17:40 -07:00
llvm-profgen.rst [CSSPGO][llvm-profgen] Context-sensitive profile data generation 2020-12-07 13:48:58 -08:00
llvm-ranlib.rst Fix some regressions caused by r369553 on old versions of Debian and Ubuntu 2019-08-22 12:16:08 +00:00
llvm-readelf.rst [llvm-readobj] Switch command line parsing from llvm::cl to OptTable 2021-07-12 10:14:42 -07:00
llvm-readobj.rst [llvm-readobj] Switch command line parsing from llvm::cl to OptTable 2021-07-12 10:14:42 -07:00
llvm-size.rst [llvm-size] Switch command line parsing from llvm::cl to OptTable 2021-07-09 10:26:53 -07:00
llvm-stress.rst [docs] [NFC] Removed excess spacing 2019-07-04 04:41:06 +00:00
llvm-strings.rst [llvm-strings] Switch command line parsing from llvm::cl to OptTable 2021-07-05 10:46:17 -07:00
llvm-strip.rst [docs][llvm-strip] Fix documentation for -s/-S 2021-06-26 21:26:53 -07:00
llvm-symbolizer.rst [llvm-symbolizer][docs] Update example for --verbose in the guide 2021-06-17 19:12:44 +01:00
llvm-tblgen.rst [TableGen] [docs] Change title of tblgen.rst to fix man page filename 2021-04-09 09:37:56 -04:00
locstats-compare.png [llvm-locstats] Add the --compare option 2020-01-15 14:35:29 +01:00
locstats-draw-plot.png [llvm-locstats] Fix the docs 2020-01-15 12:32:01 +01:00
mlir-tblgen.rst [TableGen] [docs] Change title of tblgen.rst to fix man page filename 2021-04-09 09:37:56 -04:00
opt.rst [docs] [NFC] Removed excess spacing 2019-07-04 04:41:06 +00:00
tblgen.rst [TableGen] [docs] Change title of tblgen.rst to fix man page filename 2021-04-09 09:37:56 -04:00