[PATCH] D50034: Add a CommandGuide for llvm-objdump

[Chris Bieneman via Phabricator via llvm-commits]

beanz added a comment.

Given how mach-o is radically different from ELF, it might make sense to sort or group ELF and mach-o specific options. Right now we only call out options that only work on Mach-o, but I assume some of the options only work on ELF and/or COFF. Might make sense to document that behavior correctly too.

Below I've marked out a few places where mach-o options are missing the annotation.



================
Comment at: docs/CommandGuide/llvm-objdump.rst:28
+
+  Display mach-o binding info.
+
----------------
Does this require -macho?


================
Comment at: docs/CommandGuide/llvm-objdump.rst:56
+ 
+  Display mach-o exported symbols.
+
----------------
I assume this also requires -macho?


================
Comment at: docs/CommandGuide/llvm-objdump.rst:77
+
+  Display mach-o lazy binding info.
+
----------------
requires -macho?


================
Comment at: docs/CommandGuide/llvm-objdump.rst:106
+
+  Display mach-o rebasing info.
+
----------------
requires -macho?


================
Comment at: docs/CommandGuide/llvm-objdump.rst:173
+  Create a CFG for every symbol in the object file and write it to a graphviz
+  file (Mach-O-only).
+
----------------
Maybe change "Mach-O-only" to "requires -macho" for consistency.


================
Comment at: docs/CommandGuide/llvm-objdump.rst:185
+
+  Use .dSYM file for debug info.
+
----------------
I assume this also requires -macho?


================
Comment at: docs/CommandGuide/llvm-objdump.rst:201
+
+  Use Mach-O specific object file parser.
+
----------------
Side note for a separate conversation. Do we really need this flag? Is there a reason we can't just use the magic bits at the beginning of the file stream to set the mode?


Repository:
  rL LLVM

https://reviews.llvm.org/D50034