James Henderson 2e662e9f46 [docs][llvm-symbolizer] Improve llvm-symbolizer documentation ...

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, and matching the formatting
    of other tools.
 2. Rewriting the description to fix grammar issues and mention other
    usage options.
 3. Rewriting the examples to be easier to read.
 4. Re-ordering the options into alphabetical order.
 5. Improving the text of some of the option descriptions, and adding
    some examples to individual options.
 6. Splitting the Mach-O options into a separate section of the
    document.
 7. Standardizing on double dashes for long options throughout the file.
 8. Adding a reference to the llvm-addr2line document.

Reviewed by: mtrent, ikudrin

Differential Revision: https://reviews.llvm.org/D63651

llvm-svn: 364410

2019-06-26 11:42:03 +00:00

..

bugpoint.rst

…

dsymutil.rst

[dsymutil] Upstream emitting of papertrail warnings.

2018-04-02 10:40:43 +00:00

FileCheck.rst

[FileCheck] Stop qualifying expressions as numeric

2019-06-19 23:47:24 +00:00

index.rst

[docs] Add "GNU binutils Replacements" section to command guide

2019-06-11 21:13:01 +00:00

lit.rst

[llvm] Document "%T" as deprecated in CommandGuide/lit.rst

2018-08-25 01:27:48 +00:00

llc.rst

[Remarks] Emit a section containing remark diagnostics metadata

2019-03-27 01:13:59 +00:00

lli.rst

[AArch64] Add Tiny Code Model for AArch64

2018-08-22 11:31:39 +00:00

llvm-addr2line.md

[llvm-symbolizer] Add llvm-addr2line

2019-04-19 10:17:52 +00:00

llvm-ar.rst

[Docs] Modernize references to macOS

2019-05-30 16:46:22 +00:00

llvm-as.rst

…

llvm-bcanalyzer.rst

…

llvm-build.rst

…

llvm-config.rst

…

llvm-cov.rst

[Coverage] Load code coverage data from archives

2019-06-13 20:48:57 +00:00

llvm-cxxfilt.rst

[docs][llvm-cxxfilt] Write llvm-cxxfilt documentation

2019-06-25 10:36:15 +00:00

llvm-cxxmap.rst

Add flag to llvm-profdata to allow symbols in profile data to be remapped, and

2018-09-13 20:22:02 +00:00

llvm-diff.rst

…

llvm-dis.rst

…

llvm-dwarfdump.rst

[docs][llvm-dwarfdump] Make the --show-parents and --show-children help text and docs more consistent and correct

2019-06-14 13:00:09 +00:00

llvm-exegesis-analysis.png

[llvm-exegesis] Show sched class details in analysis.

2018-05-24 10:47:05 +00:00

llvm-exegesis.rst

Add an option do not dump the generated object on disk

2019-04-05 15:18:59 +00:00

llvm-extract.rst

…

llvm-lib.rst

…

llvm-link.rst

…

llvm-lipo.rst

[llvm-lipo] Update llvm-lipo docs for -archs flag

2019-06-12 17:37:01 +00:00

llvm-mca.rst

[llvm-mca][docs] clarify how the quality of the perf report is affected by the quality of the scheduling models.

2019-06-19 16:10:58 +00:00

llvm-nm.rst

[docs][llvm-nm] Add missing options to documentation

2019-06-24 10:50:49 +00:00

llvm-objcopy.md

[docs] Add "GNU binutils Replacements" section to command guide

2019-06-11 21:13:01 +00:00

llvm-objdump.rst

[docs][llvm-objdump] Fix bad merge of docs

2019-06-21 14:41:36 +00:00

llvm-pdbutil.rst

[docs] Update code block for compatibility with Sphinx 1.5.1

2017-11-06 11:47:24 +00:00

llvm-profdata.rst

[llvm-profdata] Fix indentation error in docs. NFC.

2019-04-30 22:35:35 +00:00

llvm-ranlib.md

[docs] Add "GNU binutils Replacements" section to command guide

2019-06-11 21:13:01 +00:00

llvm-readelf.md

[docs] Add "GNU binutils Replacements" section to command guide

2019-06-11 21:13:01 +00:00

llvm-readobj.rst

[docs][llvm-readobj] Improve llvm-readobj documentation

2019-06-25 13:12:38 +00:00

llvm-size.md

[docs] Add "GNU binutils Replacements" section to command guide

2019-06-11 21:13:01 +00:00

llvm-stress.rst

…

llvm-strings.md

[docs] Add "GNU binutils Replacements" section to command guide

2019-06-11 21:13:01 +00:00

llvm-strip.md

[docs] Add "GNU binutils Replacements" section to command guide

2019-06-11 21:13:01 +00:00

llvm-symbolizer.rst

[docs][llvm-symbolizer] Improve llvm-symbolizer documentation

2019-06-26 11:42:03 +00:00

opt.rst

Rename DEBUG macro to LLVM_DEBUG.

2018-05-14 12:53:11 +00:00

tblgen.rst

[MCSched] Bind PFM Counters to the CPUs instead of the SchedModel.

2018-10-25 07:44:01 +00:00