[llvm] 190707f - [docs][llvm-symbolizer] Fix --functions description

[James Henderson via llvm-commits]

Author: James Henderson
Date: 2020-02-26T10:50:24Z
New Revision: 190707f60e8da3b802a31e35e60c78246204fb93

URL: https://github.com/llvm/llvm-project/commit/190707f60e8da3b802a31e35e60c78246204fb93
DIFF: https://github.com/llvm/llvm-project/commit/190707f60e8da3b802a31e35e60c78246204fb93.diff

LOG: [docs][llvm-symbolizer] Fix --functions description

"--functions none" and "--functions=none" are not the same. One is the
option "--functions" with its default value of "linkage", followed by an
input address of "none", and the other is "--functions" with the value
"none". This patch fixes the doc to match the actual behaviour by adding
an extra '=' sign in the allowed values description.

Added: 
    

Modified: 
    llvm/docs/CommandGuide/llvm-symbolizer.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/CommandGuide/llvm-symbolizer.rst b/llvm/docs/CommandGuide/llvm-symbolizer.rst
index 10f72a002e4e..aa2b55f3f142 100644
--- a/llvm/docs/CommandGuide/llvm-symbolizer.rst
+++ b/llvm/docs/CommandGuide/llvm-symbolizer.rst
@@ -181,7 +181,7 @@ OPTIONS
 
 .. _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). Defaults to