<html>
<head>
<base href="https://bugs.llvm.org/">
</head>
<body><table border="1" cellspacing="0" cellpadding="8">
<tr>
<th>Bug ID</th>
<td><a class="bz_bug_link
bz_status_NEW "
title="NEW - [docs] Improve llvm-objdump documentation"
href="https://bugs.llvm.org/show_bug.cgi?id=42249">42249</a>
</td>
</tr>
<tr>
<th>Summary</th>
<td>[docs] Improve llvm-objdump documentation
</td>
</tr>
<tr>
<th>Product</th>
<td>tools
</td>
</tr>
<tr>
<th>Version</th>
<td>trunk
</td>
</tr>
<tr>
<th>Hardware</th>
<td>PC
</td>
</tr>
<tr>
<th>OS</th>
<td>Windows NT
</td>
</tr>
<tr>
<th>Status</th>
<td>NEW
</td>
</tr>
<tr>
<th>Severity</th>
<td>enhancement
</td>
</tr>
<tr>
<th>Priority</th>
<td>P
</td>
</tr>
<tr>
<th>Component</th>
<td>llvm-objdump
</td>
</tr>
<tr>
<th>Assignee</th>
<td>unassignedbugs@nondot.org
</td>
</tr>
<tr>
<th>Reporter</th>
<td>jh7370.2008@my.bristol.ac.uk
</td>
</tr>
<tr>
<th>CC</th>
<td>llvm-bugs@lists.llvm.org
</td>
</tr></table>
<p>
<div>
<pre>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.</pre>
</div>
</p>
<hr>
<span>You are receiving this mail because:</span>
<ul>
<li>You are on the CC list for the bug.</li>
</ul>
</body>
</html>