[llvm-bugs] [Bug 42253] New: [docs] Improve llvm-symbolizer documentation

[via llvm-bugs]

https://bugs.llvm.org/show_bug.cgi?id=42253

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

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

-- 
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/fdfec405/attachment.html>