<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-symbolizer documentation"
href="https://bugs.llvm.org/show_bug.cgi?id=42253">42253</a>
</td>
</tr>
<tr>
<th>Summary</th>
<td>[docs] Improve llvm-symbolizer 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-symbolizer
</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>I reviewed the llvm-symbolizer documentation and have identified a number of
issues with it, which we could improve:
* The synopsis does not show the positional arguments that llvm-symbolizer can
now take (i.e. the addresses).
* The description section states that llvm-symbolizer reads information from
stdin, and does not mention the ability to provide addresses directly on the
command-line. There are also some grammar issues etc, so this section needs
rewriting.
* The example and options in the document all use single dashes for long
options, but the help text uses double-dashes for them in their description.
* There is no logic to the option ordering in the documentation. It would make
sense for it to be consistent in some way, e.g. alphabetical.
* Some options, such as \-dsym-hint are specific to Mach-O, but there is no
indication of this in the documentation.
* The documentation could do with clearer and more complete explanations of how
to specify files etc as well as addresses on stdin.
* The following options (including their short aliases) are missing from the
documentation:
--dwp
--fallback-debug-path
--print-source-context-lines
--verbose
--version
--help
--help-list</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>