[PATCH] D63195: [docs][llvm-symbolizer] Fix --functions syntax highlighting

[James Henderson via Phabricator via llvm-commits]

jhenderson created this revision.
jhenderson added reviewers: ruiu, rupprecht, ikudrin, Quolyk.
Herald added a project: LLVM.

The text for the --functions switch in the llvm-symbolizer document had the '[' after the option in bold, like the option name, and unlike the rest of the args string. This was wrong. The only way I could come up with to fix this was to replace the '=' with a space (matching the Sphinx documentation <http://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-option>). To make the other options consistent, I've removed the '=' from them too.


Repository:
  rL LLVM

https://reviews.llvm.org/D63195

Files:
  docs/CommandGuide/llvm-symbolizer.rst


Index: docs/CommandGuide/llvm-symbolizer.rst
===================================================================
--- docs/CommandGuide/llvm-symbolizer.rst
+++ docs/CommandGuide/llvm-symbolizer.rst
@@ -74,7 +74,7 @@
 
 .. _llvm-symbolizer-opt-f:
 
-.. option:: -functions[=<none|short|linkage>], -f
+.. option:: -functions [<none|short|linkage>], -f
 
   Specify the way function names are printed (omit function name,
   print short function name, or print full linkage name, respectively).
@@ -112,7 +112,7 @@
  input (see example above). If architecture is not specified in either way,
  address will not be symbolized. Defaults to empty string.
 
-.. option:: -dsym-hint=<path/to/file.dSYM>
+.. option:: -dsym-hint <path/to/file.dSYM>
 
  (Darwin-only flag). If the debug info for a binary isn't present in the default
  location, look for the debug info at the .dSYM path provided via the
@@ -131,14 +131,14 @@
 
  Strip directories when printing the file path.
 
-.. option:: -adjust-vma=<offset>
+.. option:: -adjust-vma <offset>
 
  Add the specified offset to object file addresses when performing lookups. This
  can be used to perform lookups as if the object were relocated by the offset.
 
 .. _llvm-symbolizer-opt-output-style:
 
-.. option:: -output-style=<LLVM|GNU>
+.. option:: -output-style <LLVM|GNU>
 
   Specify the preferred output style. Defaults to ``LLVM``. When the output
   style is set to ``GNU``, the tool follows the style of GNU's **addr2line**.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D63195.204270.patch
Type: text/x-patch
Size: 1477 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20190612/b7855a9b/attachment.bin>