X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FCommandLine.rst;h=1b342e34bf50d48e10965f0d01cf8c4320d5a322;hb=3b52084af899f5eaf7c24845ccaf3d4b6f87e8db;hp=263a025f696f42bb70dd07929022fd89f22bc0be;hpb=61e01721978af4c2979c4b9153e56e72eb6389fb;p=oota-llvm.git diff --git a/docs/CommandLine.rst b/docs/CommandLine.rst index 263a025f696..1b342e34bf5 100644 --- a/docs/CommandLine.rst +++ b/docs/CommandLine.rst @@ -618,6 +618,8 @@ would yield the help output: -help - display available options (-help-hidden for more) -o - Specify output filename +.. _grouping options into categories: + Grouping options into categories -------------------------------- @@ -923,12 +925,13 @@ This section describes the basic attributes that you can specify on options. .. code-block:: c++ - cl::opt<**bool**> Quiet("quiet"); + cl::opt Quiet("quiet"); .. _cl::desc(...): * The **cl::desc** attribute specifies a description for the option to be - shown in the ``-help`` output for the program. + shown in the ``-help`` output for the program. This attribute supports + multi-line descriptions with lines separated by '\n'. .. _cl::value_desc: @@ -1273,7 +1276,7 @@ The ``cl::getRegisteredOptions`` function ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The ``cl::getRegisteredOptions`` function is designed to give a programmer -access to declared non positional command line options so that how they appear +access to declared non-positional command line options so that how they appear in ``-help`` can be modified prior to calling `cl::ParseCommandLineOptions`_. Note this method should not be called during any static initialisation because it cannot be guaranteed that all options will have been initialised. Hence it