aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorReid Spencer <rspencer@reidspencer.com>2005-04-22 02:12:41 +0000
committerReid Spencer <rspencer@reidspencer.com>2005-04-22 02:12:41 +0000
commitd9dd32616e261bc6beff0a0b8aac80aa99c97252 (patch)
treeb0d206c8bf1afeba33c77520b101dd71e5d5c4ae
parent3da94aec4d429b2ba0f65fa040c33650cade196b (diff)
downloadexternal_llvm-d9dd32616e261bc6beff0a0b8aac80aa99c97252.zip
external_llvm-d9dd32616e261bc6beff0a0b8aac80aa99c97252.tar.gz
external_llvm-d9dd32616e261bc6beff0a0b8aac80aa99c97252.tar.bz2
Correct the documentation to match the program.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@21429 91177308-0d34-0410-b5e6-96231b3b80d8
-rw-r--r--docs/CommandGuide/llvmc.pod39
1 files changed, 26 insertions, 13 deletions
diff --git a/docs/CommandGuide/llvmc.pod b/docs/CommandGuide/llvmc.pod
index 6c6c26c..bc4d526 100644
--- a/docs/CommandGuide/llvmc.pod
+++ b/docs/CommandGuide/llvmc.pod
@@ -109,13 +109,13 @@ of compilation, optimization, and linking should be attempted. Source files
specified on the command line will be compiled and linked with objects and
libraries also specified.
-=item B<-S> or B<--assemble>
+=item B<-S>
This option specifies that compilation should end in the creation of
an LLVM assembly file that can be later converted to an LLVM object
file.
-=item B<-E> or B<--preprocess>
+=item B<-E>
This option specifies that no compilation or linking should be
performed. Only pre-processing, if applicable to the language being
@@ -274,7 +274,7 @@ it to the standard error.
=over
-=item B<-T,pp>=I<options>
+=item B<-T,pre>=I<options>
Pass an arbitrary option to the pre-processor.
@@ -282,7 +282,7 @@ Pass an arbitrary option to the pre-processor.
Pass an arbitrary option to the optimizer.
-=item B<-T,link>=I<options>
+=item B<-T,lnk>=I<options>
Pass an arbitrary option to the linker.
@@ -301,6 +301,11 @@ Pass an arbitrary option to the code generator.
This option is just passed through to a C or C++ front end compiler to tell it
where include files can be found.
+=item B<-D>F<symbol>
+
+This option is just passed through to a C or C++ front end compiler to tell it
+to define a symbol.
+
=back
=head2 Miscellaneous Options
@@ -324,6 +329,23 @@ of these options can produce drastically wrong results.
=over
+=item B<--config-dir> F<dirname>
+
+This option tells B<llvmc> to read configuration data from the I<directory>
+named F<dirname>. Data from such directories will be read in the order
+specified on the command line after all other standard configuration files have
+been read. This allows users or groups of users to conveniently create
+their own configuration directories in addition to the standard ones to which
+they may not have write access.
+
+
+=head2 Unimplemented Options
+
+The options below are not currently implemented in B<llvmc> but will be
+eventually. They are documented here as "future design".
+
+=over
+
=item B<--show-config> I<[suffixes...]>
When this option is given, the only action taken by B<llvmc> is to show its
@@ -344,15 +366,6 @@ item I<name> in the section named I<section>. This is a quick way to override
a configuration item on the command line without resorting to changing the
configuration files.
-=item B<--config-dir> F<dirname>
-
-This option tells B<llvmc> to read configuration data from the I<directory>
-named F<dirname>. Data from such directories will be read in the order
-specified on the command line after all other standard configuration files have
-been read. This allows users or groups of users to conveniently create
-their own configuration directories in addition to the standard ones to which
-they may not have write access.
-
=item B<--config-only-from> F<dirname>
This option tells B<llvmc> to skip the normal processing of configuration