aboutsummaryrefslogtreecommitdiffstats
path: root/tools
diff options
context:
space:
mode:
authorMikhail Glushenkov <foldr@codedgers.com>2009-01-15 02:04:54 +0000
committerMikhail Glushenkov <foldr@codedgers.com>2009-01-15 02:04:54 +0000
commit564b75a4c6964768b537c737bb5c6e947032f309 (patch)
treec6c546846704a82961661960510a2812f45d1104 /tools
parentd9d46241ece12351fce06b55baad2c83b50922a6 (diff)
downloadexternal_llvm-564b75a4c6964768b537c737bb5c6e947032f309.zip
external_llvm-564b75a4c6964768b537c737bb5c6e947032f309.tar.gz
external_llvm-564b75a4c6964768b537c737bb5c6e947032f309.tar.bz2
Clarify the documentation a bit.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@62249 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'tools')
-rw-r--r--tools/llvmc/doc/LLVMC-Reference.rst17
1 files changed, 11 insertions, 6 deletions
diff --git a/tools/llvmc/doc/LLVMC-Reference.rst b/tools/llvmc/doc/LLVMC-Reference.rst
index 1c0da18..e28def7 100644
--- a/tools/llvmc/doc/LLVMC-Reference.rst
+++ b/tools/llvmc/doc/LLVMC-Reference.rst
@@ -262,16 +262,21 @@ separate option groups syntactically.
* Possible option types:
- - ``switch_option`` - a simple boolean switch, for example ``-time``.
+ - ``switch_option`` - a simple boolean switch without arguments,
+ for example ``-O2`` or ``-time``.
- - ``parameter_option`` - option that takes an argument, for example
- ``-std=c99``;
+ - ``parameter_option`` - option that takes one argument, for
+ example ``-std=c99``. It is also allowed to use spaces instead of
+ the equality sign: ``-std c99``.
- ``parameter_list_option`` - same as the above, but more than one
- occurence of the option is allowed.
+ option occurence is allowed.
- - ``prefix_option`` - same as the parameter_option, but the option name
- and parameter value are not separated.
+ - ``prefix_option`` - same as the parameter_option, but the option
+ name and argument do not have to be separated. Example:
+ ``-ofile``. This can be also specified as ``-o file``; however,
+ ``-o=file`` will be parsed incorrectly (``=file`` will be
+ interpreted as option value).
- ``prefix_list_option`` - same as the above, but more than one
occurence of the option is allowed; example: ``-lm -lpthread``.