diff --git a/llvm/docs/CommandGuide/llvm-objdump.rst b/llvm/docs/CommandGuide/llvm-objdump.rst --- a/llvm/docs/CommandGuide/llvm-objdump.rst +++ b/llvm/docs/CommandGuide/llvm-objdump.rst @@ -27,7 +27,7 @@ .. option:: -d, --disassemble - Disassemble all text sections found in the input files. + Disassemble all executable sections found in the input files. .. option:: -D, --disassemble-all @@ -92,6 +92,8 @@ .. option:: -u, --unwind-info Display the unwind info of the input(s). + + This operation is only currently supported for COFF and Mach-O object files. .. option:: -v, --version diff --git a/llvm/tools/llvm-objdump/ObjdumpOpts.td b/llvm/tools/llvm-objdump/ObjdumpOpts.td --- a/llvm/tools/llvm-objdump/ObjdumpOpts.td +++ b/llvm/tools/llvm-objdump/ObjdumpOpts.td @@ -23,7 +23,8 @@ HelpText<"Increase the displayed address by the specified offset">; def all_headers : Flag<["--"], "all-headers">, - HelpText<"Display all available header information">; + HelpText<"Display all available header information, " + "relocation entries and the symbol table">; def : Flag<["-"], "x">, Alias, HelpText<"Alias for --all-headers">; def arch_name_EQ : Joined<["--"], "arch-name=">, @@ -39,11 +40,11 @@ def : Flag<["-"], "C">, Alias, HelpText<"Alias for --demangle">; def disassemble : Flag<["--"], "disassemble">, - HelpText<"Display assembler mnemonics for the machine instructions">; + HelpText<"Disassemble all executable sections found in the input files">; def : Flag<["-"], "d">, Alias, HelpText<"Alias for --disassemble">; def disassemble_all : Flag<["--"], "disassemble-all">, - HelpText<"Display assembler mnemonics for the machine instructions">; + HelpText<"Disassemble all sections found in the input files">; def : Flag<["-"], "D">, Alias, HelpText<"Alias for --disassemble-all">; @@ -73,10 +74,12 @@ HelpText<"Alias for --dynamic-reloc">; def dwarf_EQ : Joined<["--"], "dwarf=">, - HelpText<"Dump of dwarf debug sections">, Values<"frames">; + HelpText<"Dump the specified DWARF debug sections. The " + "only supported value is 'frames'">, + Values<"frames">; def fault_map_section : Flag<["--"], "fault-map-section">, - HelpText<"Display contents of faultmap section">; + HelpText<"Display the content of the fault map section">; def file_headers : Flag<["--"], "file-headers">, HelpText<"Display the contents of the overall file header">; @@ -89,9 +92,10 @@ HelpText<"Alias for --full-contents">; def line_numbers : Flag<["--"], "line-numbers">, - HelpText<"Display source line numbers with " - "disassembly. Implies disassemble object">; -def : Flag<["-"], "l">, Alias, + HelpText<"When disassembling, display source line numbers. " + "Implies --disassemble">; +def : Flag<["-"], "l">, + Alias, HelpText<"Alias for --line-numbers">; def macho : Flag<["--"], "macho">, @@ -111,7 +115,7 @@ "do not print the instruction bytes.">; def no_leading_addr : Flag<["--"], "no-leading-addr">, - HelpText<"Print no leading address">; + HelpText<"When disassembling, do not print leading addresses">; def raw_clang_ast : Flag<["--"], "raw-clang-ast">, HelpText<"Dump the raw binary contents of the clang AST section">; @@ -150,15 +154,18 @@ HelpText<"Display LMA column when dumping ELF section headers">; def source : Flag<["--"], "source">, - HelpText<"Display source inlined with disassembly. Implies disassemble object">; + HelpText<"When disassembling, display source interleaved with the " + "disassembly. Implies --disassemble">; def : Flag<["-"], "S">, Alias, HelpText<"Alias for --source">; def start_address_EQ : Joined<["--"], "start-address=">, MetaVarName<"address">, - HelpText<"Disassemble beginning at address">; + HelpText<"Set the start address for disassembling, " + "printing relocations and printing symbols">; def stop_address_EQ : Joined<["--"], "stop-address=">, MetaVarName<"address">, - HelpText<"Stop disassembly at address">; + HelpText<"Set the stop address for disassembling, " + "printing relocations and printing symbols">; def syms : Flag<["--"], "syms">, HelpText<"Display the symbol table">; @@ -195,11 +202,11 @@ MetaVarName<"prefix">; def debug_vars_EQ : Joined<["--"], "debug-vars=">, - Values<"unicode,ascii">; -def : Flag<["--"], "debug-vars">, HelpText<"Print the locations (in registers or memory) of " - "source-level variables alongside disassembly">, - Alias, AliasArgs<["unicode"]>; + "source-level variables alongside disassembly. " + "Supported formats: ascii, unicode (default)">, + Values<"unicode,ascii">; +def : Flag<["--"], "debug-vars">, Alias, AliasArgs<["unicode"]>; def debug_vars_indent_EQ : Joined<["--"], "debug-vars-indent=">, HelpText<"Distance to indent the source-level variable display, "