[llvm-bugs] [Bug 42255] New: [docs] Improve llvm-readobj documentation

via llvm-bugs llvm-bugs at lists.llvm.org
Wed Jun 12 06:39:24 PDT 2019


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

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.

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

More information about the llvm-bugs mailing list