Added information about the configuration file. This is a temporary home

for this information as it belongs in a larger document on the subject of
llvmc.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@15566 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/docs/CommandGuide/llvmc.pod b/docs/CommandGuide/llvmc.pod
index 51f436e3b49ab686200a1442eb66ba59a0898c01..735a30cb823ba68c4aa153e9fac809fac8c6e4b1 100644 (file)
--- a/docs/CommandGuide/llvmc.pod
+++ b/docs/CommandGuide/llvmc.pod
@@ -272,16 +272,19 @@ it to the standard error.
 
 =over
 
+=item B<-T,pp>=I<options>
 
-=item B<-Tool,opt>=I<options>
+Pass an arbitrary option to the pre-processor.
+
+=item B<-T,opt>=I<options>
 
 Pass an arbitrary option to the optimizer.
 
-=item B<-Tool,link>=I<options>
+=item B<-T,link>=I<options>
 
 Pass an arbitrary option to the linker.
 
-=item B<-Tool,asm>=I<options>
+=item B<-T,asm>=I<options>
 
 Pass an arbitrary option to the code generator.
 
@@ -507,11 +510,97 @@ viable options:
 =over
 
 =item XML
+
 =item Windows .ini
+
 =item specific to B<llvmc>
 
 =back
 
+=head2 Master Configuration Items
+
+=head3 Section: [lang=I<LANGUAGE>]
+
+This section provides the master configuration data for a given language. The
+language specific data will be found in a file named I<LANGUAGE>.
+
+=over
+
+=item C<suffix=>I<suffix>
+
+This adds the I<suffix> specified to the list of recognized suffixes for
+the I<LANGUAGE> identified in the section. As many suffixes as are commonly used
+for source files for the I<LANGUAGE> should be specified. 
+
+=back
+
+=begin html
+
+<p>For example, the following might appear for C++:
+<pre><tt>
+[lang=C++]
+suffix=.cpp
+suffix=.cxx
+suffix=.C
+</tt></pre></p>
+
+=end html
+
+=head2 Language Specific Configuration Items
+
+=head3 Section: [general]
+
+=over
+
+=item C<hasPreProcessor=yes|no>
+
+This item specifies whether the language has a pre-processing phase or not. This
+controls whether the B<-E> option works for the language or not.
+
+=item C<output=bc|ll>
+
+This item specifies the kind of output the language's compiler generates. The
+choices are either bytecode (C<bc>) or LLVM assembly (C<ll>).
+
+=back
+
+=head3 Section: [-O0]
+
+=over
+
+=item C<preprocess=>I<commandline>
+
+This item specifies the I<commandline> to use for pre-processing the input.
+
+=over
+
+Valid substitutions for this item are:
+
+=item %in%
+
+The input source file.
+
+=item %out%
+
+The output file.
+
+=item %options%
+
+Any pre-processing specific options (e.g. B<-I>).
+
+=back
+
+=item C<translate=>I<commandline>
+
+This item specifies the I<commandline> to use for translating the source
+language input into the output format given by the C<output> item.
+
+=item C<optimize=>I<commandline>
+
+This item specifies the I<commandline> for optimizing the translator's output.
+
+=back
+
 =head1 EXIT STATUS
 
 If B<llvmc> succeeds, it will exit with 0.  Otherwise, if an error
@@ -527,6 +616,6 @@ L<llc|llc>, L<llvm-link|llvm-link>
 
 =head1 AUTHORS
 
-Reid Spencer
+Reid Spencer, L<rspencer@x10sys.com>
 
 =cut