Update documentation for the -f change.
authorDan Gohman <gohman@apple.com>
Tue, 25 Aug 2009 15:54:01 +0000 (15:54 +0000)
committerDan Gohman <gohman@apple.com>
Tue, 25 Aug 2009 15:54:01 +0000 (15:54 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@79996 91177308-0d34-0410-b5e6-96231b3b80d8

docs/CodeGenerator.html
docs/CommandGuide/llc.pod
docs/CommandGuide/llvm-as.pod
docs/CommandGuide/llvm-dis.pod
docs/CommandGuide/llvm-extract.pod
docs/CommandGuide/llvm-link.pod
docs/CommandGuide/opt.pod
docs/CommandLine.html
docs/HowToSubmitABug.html

index 2f716a2161a1bd7bcb2c79d8dd967788627fe94b..4f8472c07fa22cb0e8700a67a3a5e1c796bd890a 100644 (file)
@@ -1616,9 +1616,9 @@ bool RegMapping_Fer::compatible_class(MachineFunction &amp;mf,
 
 <div class="doc_code">
 <pre>
-$ llc -f -regalloc=simple file.bc -o sp.s;
-$ llc -f -regalloc=local file.bc -o lc.s;
-$ llc -f -regalloc=linearscan file.bc -o ln.s;
+$ llc -regalloc=simple file.bc -o sp.s;
+$ llc -regalloc=local file.bc -o lc.s;
+$ llc -regalloc=linearscan file.bc -o ln.s;
 </pre>
 </div>
 
index eba7859e28827d2dff6176b004a8cce6295a209d..7a7bbcac9c5895e45410c11829e11f30acc99afc 100644 (file)
@@ -49,8 +49,9 @@ B<clang>.
 
 =item B<-f>
 
-Overwrite output files. By default, B<llc> will refuse to overwrite
-an output file which already exists.
+Enable binary output on terminals.  Normally, B<llvm-extract> will refuse to
+write raw bitcode output if the output stream is a terminal. With this option,
+B<llvm-extract> will write raw bitcode regardless of the output device.
 
 =item B<-mtriple>=I<target triple>
 
index 2befed13ae009a79345597928193672b276a71d1..045a9245b60975b88f01754bb3b6d8596b83022b 100644 (file)
@@ -46,9 +46,9 @@ suffix is appended.
 
 =item B<-f>
 
-Force overwrite.  Normally, B<llvm-as> will refuse to overwrite an
-output file that already exists.  With this option, B<llvm-as>
-will overwrite the output file and replace it with new bitcode.
+Enable binary output on terminals.  Normally, B<llvm-as> will refuse to
+write raw bitcode output if the output stream is a terminal. With this option,
+B<llvm-as> will write raw bitcode regardless of the output device.
 
 =item B<--help>
 
index 8df382d2e9c0089270af23912054a63db55ae1ab..2b83290c9b2e21629b8dc06cd952bef9f42a360f 100644 (file)
@@ -29,9 +29,9 @@ B<-o> option.
 
 =item B<-f>
 
-Force overwrite.  Normally, B<llvm-dis> will refuse to overwrite
-an output file that already exists.  With this option, B<llvm-dis>
-will overwrite the output file.
+Enable binary output on terminals.  Normally, B<llvm-dis> will refuse to
+write raw bitcode output if the output stream is a terminal. With this option,
+B<llvm-dis> will write raw bitcode regardless of the output device.
 
 =item B<--help>
 
index d916612ec5c65d7c56b2464c34974baf49848d3f..c3bc019c6b8f169d0263992455c87e37d374d5e0 100644 (file)
@@ -28,9 +28,9 @@ unless the B<-o> option is specified (see below).
 
 =item B<-f>
 
-Force overwrite.  Normally, B<llvm-extract> will refuse to overwrite an
-output file that already exists.  With this option, B<llvm-extract>
-will overwrite the output file and replace it with new bitcode.
+Enable binary output on terminals.  Normally, B<llvm-extract> will refuse to
+write raw bitcode output if the output stream is a terminal. With this option,
+B<llvm-extract> will write raw bitcode regardless of the output device.
 
 =item B<--func> I<function-name>
 
index 5f4dcb6e354d09b0edf9d9a9a97bd0cb39f5330c..8a2a8c5d77016ccb395370151114d69a743502f1 100644 (file)
@@ -33,8 +33,9 @@ the order in which they were specified on the command line.
 
 =item B<-f>
 
-Overwrite output files.  By default, B<llvm-link> will not overwrite an output
-file if it already exists.
+Enable binary output on terminals.  Normally, B<llvm-link> will refuse to
+write raw bitcode output if the output stream is a terminal. With this option,
+B<llvm-link> will write raw bitcode regardless of the output device.
 
 =item B<-o> F<filename>
 
index 75b7eddd4cf13ef2311a5a6a4355773947753910..3e23cd1ae65f8ec35571bf3cb3a3e7ae2faadc1f 100644 (file)
@@ -39,9 +39,9 @@ writes its output to the standard output.
 
 =item B<-f>
 
-Force overwrite.  Normally, B<opt> will refuse to overwrite an
-output file that already exists.  With this option, B<opt> will
-overwrite the output file and replace it with new bitcode.
+Enable binary output on terminals.  Normally, B<opt> will refuse to
+write raw bitcode output if the output stream is a terminal. With this option,
+B<opt> will write raw bitcode regardless of the output device.
 
 =item B<-help>
 
index 09ed2b8c0e577072a60333b3a497e46f1aa5bf1f..f14defc31f4fb576ecb81106f2d9889a0b6cb38f 100644 (file)
@@ -331,13 +331,13 @@ OPTIONS:
 <div class="doc_text">
 
 <p>In addition to input and output filenames, we would like the compiler example
-to support three boolean flags: "<tt>-f</tt>" to force overwriting of the output
-file, "<tt>--quiet</tt>" to enable quiet mode, and "<tt>-q</tt>" for backwards
-compatibility with some of our users.  We can support these by declaring options
-of boolean type like this:</p>
+to support three boolean flags: "<tt>-f</tt>" to force writing binary output to
+a terminal, "<tt>--quiet</tt>" to enable quiet mode, and "<tt>-q</tt>" for
+backwards compatibility with some of our users.  We can support these by
+declaring options of boolean type like this:</p>
 
 <div class="doc_code"><pre>
-<a href="#cl::opt">cl::opt</a>&lt;bool&gt; Force ("<i>f</i>", <a href="#cl::desc">cl::desc</a>("<i>Overwrite output files</i>"));
+<a href="#cl::opt">cl::opt</a>&lt;bool&gt; Force ("<i>f</i>", <a href="#cl::desc">cl::desc</a>("<i>Enable binary output on terminals</i>"));
 <a href="#cl::opt">cl::opt</a>&lt;bool&gt; Quiet ("<i>quiet</i>", <a href="#cl::desc">cl::desc</a>("<i>Don't print informational messages</i>"));
 <a href="#cl::opt">cl::opt</a>&lt;bool&gt; Quiet2("<i>q</i>", <a href="#cl::desc">cl::desc</a>("<i>Don't print informational messages</i>"), <a href="#cl::Hidden">cl::Hidden</a>);
 </pre></div>
@@ -378,7 +378,7 @@ library calls to parse the string value into the specified data type.</p>
 USAGE: compiler [options] &lt;input file&gt;
 
 OPTIONS:
-  <b>-f     - Overwrite output files</b>
+  <b>-f     - Enable binary output on terminals</b>
   -o     - Override output filename
   <b>-quiet - Don't print informational messages</b>
   -help  - display available options (--help-hidden for more)
@@ -390,7 +390,7 @@ OPTIONS:
 USAGE: compiler [options] &lt;input file&gt;
 
 OPTIONS:
-  -f     - Overwrite output files
+  -f     - Enable binary output on terminals
   -o     - Override output filename
   <b>-q     - Don't print informational messages</b>
   -quiet - Don't print informational messages
@@ -530,7 +530,7 @@ OPTIONS:
     -O1         - Enable trivial optimizations
     -O2         - Enable default optimizations
     -O3         - Enable expensive optimizations</b>
-  -f            - Overwrite output files
+  -f            - Enable binary output on terminals
   -help         - display available options (--help-hidden for more)
   -o &lt;filename&gt; - Specify output filename
   -quiet        - Don't print informational messages
@@ -614,7 +614,7 @@ OPTIONS:
     =none       - disable debug information
     =quick      - enable quick debug information
     =detailed   - enable detailed debug information</b>
-  -f            - Overwrite output files
+  -f            - Enable binary output on terminals
   -help         - display available options (--help-hidden for more)
   -o &lt;filename&gt; - Specify output filename
   -quiet        - Don't print informational messages
index bdec1c091096f971ea6bbee5a035259cbdeea965..91d4e2bfe9868e27c2875ba565fd9753ad850870 100644 (file)
@@ -183,12 +183,12 @@ to llvm-gcc (in addition to the options you already pass).  Once your have
 foo.bc, one of the following commands should fail:</p>
 
 <ol>
-<li><tt><b>llc</b> foo.bc -f</tt></li>
-<li><tt><b>llc</b> foo.bc -f -relocation-model=pic</tt></li>
-<li><tt><b>llc</b> foo.bc -f -relocation-model=static</tt></li>
-<li><tt><b>llc</b> foo.bc -f -enable-eh</tt></li>
-<li><tt><b>llc</b> foo.bc -f -relocation-model=pic -enable-eh</tt></li>
-<li><tt><b>llc</b> foo.bc -f -relocation-model=static -enable-eh</tt></li>
+<li><tt><b>llc</b> foo.bc</tt></li>
+<li><tt><b>llc</b> foo.bc -relocation-model=pic</tt></li>
+<li><tt><b>llc</b> foo.bc -relocation-model=static</tt></li>
+<li><tt><b>llc</b> foo.bc -enable-eh</tt></li>
+<li><tt><b>llc</b> foo.bc -relocation-model=pic -enable-eh</tt></li>
+<li><tt><b>llc</b> foo.bc -relocation-model=static -enable-eh</tt></li>
 </ol>
 
 <p>If none of these crash, please follow the instructions for a
@@ -320,7 +320,7 @@ the following:</p>
 
 <div class="doc_code">
 <p><tt>
-<b>llc</b> test.bc -o test.s -f<br>
+<b>llc</b> test.bc -o test.s<br>
 <b>gcc</b> test.s safe.so -o test.llc<br>
 ./test.llc [program options]
 </tt></p>