diff options
author | Dan Gohman <gohman@apple.com> | 2009-08-25 15:54:01 +0000 |
---|---|---|
committer | Dan Gohman <gohman@apple.com> | 2009-08-25 15:54:01 +0000 |
commit | 0cabaa54e512420f3057ffe781ff317ecb9196ed (patch) | |
tree | 1295f1b7ee5d5a77c367bfd54b52c05c29c46183 | |
parent | 47dd94e542f78b518b4fa70c0c00b1be7e3cf5a6 (diff) |
Update documentation for the -f change.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@79996 91177308-0d34-0410-b5e6-96231b3b80d8
-rw-r--r-- | docs/CodeGenerator.html | 6 | ||||
-rw-r--r-- | docs/CommandGuide/llc.pod | 5 | ||||
-rw-r--r-- | docs/CommandGuide/llvm-as.pod | 6 | ||||
-rw-r--r-- | docs/CommandGuide/llvm-dis.pod | 6 | ||||
-rw-r--r-- | docs/CommandGuide/llvm-extract.pod | 6 | ||||
-rw-r--r-- | docs/CommandGuide/llvm-link.pod | 5 | ||||
-rw-r--r-- | docs/CommandGuide/opt.pod | 6 | ||||
-rw-r--r-- | docs/CommandLine.html | 18 | ||||
-rw-r--r-- | docs/HowToSubmitABug.html | 14 |
9 files changed, 37 insertions, 35 deletions
diff --git a/docs/CodeGenerator.html b/docs/CodeGenerator.html index 2f716a2161..4f8472c07f 100644 --- a/docs/CodeGenerator.html +++ b/docs/CodeGenerator.html @@ -1616,9 +1616,9 @@ bool RegMapping_Fer::compatible_class(MachineFunction &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> diff --git a/docs/CommandGuide/llc.pod b/docs/CommandGuide/llc.pod index eba7859e28..7a7bbcac9c 100644 --- a/docs/CommandGuide/llc.pod +++ b/docs/CommandGuide/llc.pod @@ -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> diff --git a/docs/CommandGuide/llvm-as.pod b/docs/CommandGuide/llvm-as.pod index 2befed13ae..045a9245b6 100644 --- a/docs/CommandGuide/llvm-as.pod +++ b/docs/CommandGuide/llvm-as.pod @@ -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> diff --git a/docs/CommandGuide/llvm-dis.pod b/docs/CommandGuide/llvm-dis.pod index 8df382d2e9..2b83290c9b 100644 --- a/docs/CommandGuide/llvm-dis.pod +++ b/docs/CommandGuide/llvm-dis.pod @@ -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> diff --git a/docs/CommandGuide/llvm-extract.pod b/docs/CommandGuide/llvm-extract.pod index d916612ec5..c3bc019c6b 100644 --- a/docs/CommandGuide/llvm-extract.pod +++ b/docs/CommandGuide/llvm-extract.pod @@ -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> diff --git a/docs/CommandGuide/llvm-link.pod b/docs/CommandGuide/llvm-link.pod index 5f4dcb6e35..8a2a8c5d77 100644 --- a/docs/CommandGuide/llvm-link.pod +++ b/docs/CommandGuide/llvm-link.pod @@ -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> diff --git a/docs/CommandGuide/opt.pod b/docs/CommandGuide/opt.pod index 75b7eddd4c..3e23cd1ae6 100644 --- a/docs/CommandGuide/opt.pod +++ b/docs/CommandGuide/opt.pod @@ -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> diff --git a/docs/CommandLine.html b/docs/CommandLine.html index 09ed2b8c0e..f14defc31f 100644 --- a/docs/CommandLine.html +++ b/docs/CommandLine.html @@ -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><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 @@ library calls to parse the string value into the specified data type.</p> 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 @@ OPTIONS: 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 @@ 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 <filename> - 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 <filename> - Specify output filename -quiet - Don't print informational messages diff --git a/docs/HowToSubmitABug.html b/docs/HowToSubmitABug.html index bdec1c0910..91d4e2bfe9 100644 --- a/docs/HowToSubmitABug.html +++ b/docs/HowToSubmitABug.html @@ -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> |