[PATCH] D63651: [docs][llvm-symbolizer] Improve llvm-symbolizer documentation

[James Henderson via Phabricator via llvm-commits]

jhenderson created this revision.
jhenderson added reviewers: rupprecht, MaskRay, mtrent, ikudrin, khemant, samsonov.
Herald added a project: LLVM.

As detailed in https://bugs.llvm.org/show_bug.cgi?id=42253, there were a number of issues in the llvm-symbolizer documentation. This patch fixes them by:

1. Adding [addresses...] to the synopsis.
2. Rewriting the description to fix grammar issues and mention other usage options.
3. Rewrite the examples to be easier to read.
4. Re-order the options into alphabetical order.
5. Improve the text of some of the option descriptions, and added some more examples.
6. Split the Mach-O options into a separate section of the document.
7. Standardized on double dashes for long options throughout the file.
8. Added a reference to the llvm-addr2line document.


Repository:
  rL LLVM

https://reviews.llvm.org/D63651

Files:
  docs/CommandGuide/llvm-symbolizer.rst

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D63651.206000.patch
Type: text/x-patch
Size: 12507 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20190621/9c1cfa31/attachment.bin>