[llvm-commits] [llvm] r79996 - in /llvm/trunk/docs: CodeGenerator.html CommandGuide/llc.pod CommandGuide/llvm-as.pod CommandGuide/llvm-dis.pod CommandGuide/llvm-extract.pod CommandGuide/llvm-link.pod CommandGuide/opt.pod CommandLine.html HowToSubmitABug.html

Dan Gohman gohman at apple.com
Tue Aug 25 08:54:01 PDT 2009 

Author: djg
Date: Tue Aug 25 10:54:01 2009
New Revision: 79996

URL: http://llvm.org/viewvc/llvm-project?rev=79996&view=rev
Log:
Update documentation for the -f change.

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

Modified: llvm/trunk/docs/CodeGenerator.html
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CodeGenerator.html?rev=79996&r1=79995&r2=79996&view=diff

==============================================================================
--- llvm/trunk/docs/CodeGenerator.html (original)
+++ llvm/trunk/docs/CodeGenerator.html Tue Aug 25 10:54:01 2009
@@ -1616,9 +1616,9 @@
 
 <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>
 

Modified: llvm/trunk/docs/CommandGuide/llc.pod
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llc.pod?rev=79996&r1=79995&r2=79996&view=diff

==============================================================================
--- llvm/trunk/docs/CommandGuide/llc.pod (original)
+++ llvm/trunk/docs/CommandGuide/llc.pod Tue Aug 25 10:54:01 2009
@@ -49,8 +49,9 @@
 
 =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>
 

Modified: llvm/trunk/docs/CommandGuide/llvm-as.pod
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-as.pod?rev=79996&r1=79995&r2=79996&view=diff

==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-as.pod (original)
+++ llvm/trunk/docs/CommandGuide/llvm-as.pod Tue Aug 25 10:54:01 2009
@@ -46,9 +46,9 @@
 
 =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>
 

Modified: llvm/trunk/docs/CommandGuide/llvm-dis.pod
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-dis.pod?rev=79996&r1=79995&r2=79996&view=diff

==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-dis.pod (original)
+++ llvm/trunk/docs/CommandGuide/llvm-dis.pod Tue Aug 25 10:54:01 2009
@@ -29,9 +29,9 @@
 
 =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>
 

Modified: llvm/trunk/docs/CommandGuide/llvm-extract.pod
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-extract.pod?rev=79996&r1=79995&r2=79996&view=diff

==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-extract.pod (original)
+++ llvm/trunk/docs/CommandGuide/llvm-extract.pod Tue Aug 25 10:54:01 2009
@@ -28,9 +28,9 @@
 
 =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>
 

Modified: llvm/trunk/docs/CommandGuide/llvm-link.pod
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-link.pod?rev=79996&r1=79995&r2=79996&view=diff

==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-link.pod (original)
+++ llvm/trunk/docs/CommandGuide/llvm-link.pod Tue Aug 25 10:54:01 2009
@@ -33,8 +33,9 @@
 
 =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>
 

Modified: llvm/trunk/docs/CommandGuide/opt.pod
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/opt.pod?rev=79996&r1=79995&r2=79996&view=diff

==============================================================================
--- llvm/trunk/docs/CommandGuide/opt.pod (original)
+++ llvm/trunk/docs/CommandGuide/opt.pod Tue Aug 25 10:54:01 2009
@@ -39,9 +39,9 @@
 
 =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>
 

Modified: llvm/trunk/docs/CommandLine.html
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandLine.html?rev=79996&r1=79995&r2=79996&view=diff

==============================================================================
--- llvm/trunk/docs/CommandLine.html (original)
+++ llvm/trunk/docs/CommandLine.html Tue Aug 25 10:54:01 2009
@@ -331,13 +331,13 @@
 <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><bool> Force ("<i>f</i>", <a href="#cl::desc">cl::desc</a>("<i>Overwrite output files</i>"));
+<a href="#cl::opt">cl::opt</a><bool> 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><bool> 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><bool> 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 @@
 USAGE: compiler [options] <input file>
 
 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 @@
 USAGE: compiler [options] <input file>
 
 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 @@
     -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 <filename> - Specify output filename
   -quiet        - Don't print informational messages
@@ -614,7 +614,7 @@
     =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 <filename> - Specify output filename
   -quiet        - Don't print informational messages

Modified: llvm/trunk/docs/HowToSubmitABug.html
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/HowToSubmitABug.html?rev=79996&r1=79995&r2=79996&view=diff

==============================================================================
--- llvm/trunk/docs/HowToSubmitABug.html (original)
+++ llvm/trunk/docs/HowToSubmitABug.html Tue Aug 25 10:54:01 2009
@@ -183,12 +183,12 @@
 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 @@
 
 <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>

More information about the llvm-commits mailing list