[llvm-bugs] [Bug 42249] New: [docs] Improve llvm-objdump documentation

via llvm-bugs llvm-bugs at lists.llvm.org
Wed Jun 12 03:58:22 PDT 2019


            Bug ID: 42249
           Summary: [docs] Improve llvm-objdump documentation
           Product: tools
           Version: trunk
          Hardware: PC
                OS: Windows NT
            Status: NEW
          Severity: enhancement
          Priority: P
         Component: llvm-objdump
          Assignee: unassignedbugs at nondot.org
          Reporter: jh7370.2008 at my.bristol.ac.uk
                CC: llvm-bugs at lists.llvm.org

There are a number of issues with the llvm-objdump documentation which should
be fixed. Here is a list of things I've noticed:

* Grammar error in the sentence under the "Commands" header: "At least one of
the following commands are[should be is?] required" -> this one is a bit
controversial probably!

* Most long options in the documentation use a single dash, but the help text
always uses double dashes. We should standardise on double-dashes, I think.

* The list of "commands" is very incomplete. Many commands are missing.
Similarly, there are many missing options from the documentation.

* Some long options are missing from the documentation, whilst their short
aliases are present. The documentation should list both.

* It would make sense to group the Mach-O specific options in the documentation
together, similar to how they are grouped in the help text.

* The documentation mentions the "-mc-x86-disable-arith-relaxation" option
which does not appear to exist.

* -stats is mentioned in the documentation, but is missing from the help text.
It does not appear to have any purpose in llvm-objdump.

You are receiving this mail because:
You are on the CC list for the bug.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-bugs/attachments/20190612/936ab9ce/attachment.html>

More information about the llvm-bugs mailing list