From 564b75a4c6964768b537c737bb5c6e947032f309 Mon Sep 17 00:00:00 2001 From: Mikhail Glushenkov Date: Thu, 15 Jan 2009 02:04:54 +0000 Subject: [PATCH] Clarify the documentation a bit. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@62249 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/CompilerDriver.html | 19 ++++++++++++------- tools/llvmc/doc/LLVMC-Reference.rst | 17 +++++++++++------ 2 files changed, 23 insertions(+), 13 deletions(-) diff --git a/docs/CompilerDriver.html b/docs/CompilerDriver.html index 769d053c721..fcd66bab3ab 100644 --- a/docs/CompilerDriver.html +++ b/docs/CompilerDriver.html @@ -263,13 +263,18 @@ separate option groups syntactically.

  • Possible option types:

      -
    • switch_option - a simple boolean switch, for example -time.
      • -
    • parameter_option - option that takes an argument, for example --std=c99;
      • +
    • switch_option - a simple boolean switch without arguments, +for example -O2 or -time.
      • +
    • 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.
      • -
    • prefix_option - same as the parameter_option, but the option name -and parameter value are not separated.
      • +option occurence is allowed. +
    • 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.
    • alias_option - a special option type for creating @@ -588,7 +593,7 @@ status code.

      Mikhail Glushenkov
      LLVM Compiler Infrastructure
      -Last modified: $Date$ +Last modified: $Date: 2008-12-11 11:34:48 -0600 (Thu, 11 Dec 2008) $ diff --git a/tools/llvmc/doc/LLVMC-Reference.rst b/tools/llvmc/doc/LLVMC-Reference.rst index 1c0da181892..e28def74d5e 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``. -- 2.34.1