<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-readobj documentation"
href="https://bugs.llvm.org/show_bug.cgi?id=42255">42255</a>
</td>
</tr>
<tr>
<th>Summary</th>
<td>[docs] Improve llvm-readobj 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-readobj
</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>jh7370.2008@my.bristol.ac.uk, llvm-bugs@lists.llvm.org
</td>
</tr></table>
<p>
<div>
<pre>There are several issues with the llvm-readobj documentation not covered by
other bugs:
* The description claims "The tool and its output is primarily designed for use
in FileCheck-based tests" which is not really the case any more, so this text
should be updated.
* The documentation uses single-dash long options for option names, but
references in the help text to other options exlcusively use double-dashes.
* The majority of options in the help text are not present in the
documentation. We should add them.
* The llvm-readobj documentation does not list several aliases e.g. \--relocs.</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>