summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorReid Spencer <rspencer@reidspencer.com>2007-02-03 00:44:47 +0000
committerReid Spencer <rspencer@reidspencer.com>2007-02-03 00:44:47 +0000
commit776b16d07514be6bd322c82a23cd527c183af9f9 (patch)
tree904645e9e375ec59fb83d9aadf65475c8053b69b /docs
parent5efdecc030f1a71cdb5b49d97c6c1c45e68ff731 (diff)
downloadllvm-776b16d07514be6bd322c82a23cd527c183af9f9.tar.gz
llvm-776b16d07514be6bd322c82a23cd527c183af9f9.tar.bz2
llvm-776b16d07514be6bd322c82a23cd527c183af9f9.tar.xz
For PR1152:
Update documentation to reflect that this isn't a full-blown executable any more. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@33807 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
-rw-r--r--docs/CommandGuide/gccas.pod28
1 files changed, 14 insertions, 14 deletions
diff --git a/docs/CommandGuide/gccas.pod b/docs/CommandGuide/gccas.pod
index 779d468ce3..56a1749df7 100644
--- a/docs/CommandGuide/gccas.pod
+++ b/docs/CommandGuide/gccas.pod
@@ -2,7 +2,7 @@
=head1 NAME
-gccas - optimizing LLVM assembler
+gccas - convenience script to run B<llvm-as> and B<opt>
=head1 SYNOPSIS
@@ -10,19 +10,19 @@ B<gccas> [I<options>] I<filename>
=head1 DESCRIPTION
-The B<gccas> utility takes an LLVM assembly file generated by the
-L<llvmgcc|llvmgcc> or L<llvmg++|llvmgxx> front-ends and converts
-it into an LLVM bytecode file. It is primarily used by the GCC
-front end, and as such, attempts to mimic the interface provided
-by the default system assembler so that it can act as a "drop-in"
-replacement.
+The B<gccas> shell script passes an LLVM assembly file through the B<llvm-as>
+and B<opt> programs to generate an optimized bytecode file. Its name is an
+historical artifact from when it was a full executable used to process LLVM
+assembly generated by the L<llvmgcc|llvmgcc> or L<llvmg++|llvmgxx> front-ends.
+Currently this is a shell script that simulates what the old B<gccas> executable
+once did.
-B<gccas> performs a number of optimizations on the input program,
-including but not limited to: promotion of stack values to SSA
-registers; elimination of dead globals, function arguments, code,
-and types; tail-call elimination; loop-invariant code motion; global
-common-subexpression elimination; and sparse conditional constant
-propagation.
+B<gccas> performs a number of optimizations on the input program, including but
+not limited to: promotion of stack values to SSA registers; elimination of dead
+globals, function arguments, code, and types; tail-call elimination;
+loop-invariant code motion; global common-subexpression elimination; and
+sparse conditional constant propagation. It accomplishes this by using the
+B<-std-compile-opts> option to the B<opt> tool.
=head1 OPTIONS
@@ -71,7 +71,7 @@ status.
=head1 SEE ALSO
-L<llvm-as|llvm-as>, L<gccld|gccld>
+L<llvm-as|llvm-as>, L<opt|opt>, L<gccld|gccld>
=head1 AUTHORS