diff --git a/clang/www/get_started.html b/clang/www/get_started.html index 1809362a6177..1393981c5b30 100644 --- a/clang/www/get_started.html +++ b/clang/www/get_started.html @@ -15,14 +15,12 @@
This page gives you the shortest path to checking out clang and demos a few +
This page gives you the shortest path to checking out Clang and demos a few options. This should get you up and running with the minimum of muss and fuss. If you like what you see, please consider getting -involved with the clang community.
+involved with the Clang community. - -While this work aims to provide a fully functional C/C++/ObjC front-end, it is still early work and is under heavy development. In particular, @@ -43,10 +41,10 @@ href="http://llvm.org/bugs/">LLVM Bugzilla or bring up the issue on the Clang development mailing list.
-If you would like to check out and build the project, the current scheme -is:
+If you would like to check out and build Clang, the current procedure is as +follows:
Note: Here clang-cc is the "low-level" frontend + executable that is similar in purpose to cc1. Clang also has a high-level compiler driver that acts as a drop-in + replacement for gcc.
Note that the C front-end uses LLVM, but does not depend on - llvm-gcc. If you encounter problems with building clang, make - sure you have the latest SVN version of LLVM. LLVM contains - support libraries for clang that will be updated as well as - development on clang progresses.
+Note that the C front-end uses LLVM, but does not depend on llvm-gcc. If you +encounter problems with building Clang, make sure you have the latest SVN +version of LLVM. LLVM contains support libraries for Clang that will be updated +as well as development on Clang progresses.
-Since you've checked out clang into the llvm source tree you can - build them all at once with a simple Makefile change. This moves - Step 1 above to Step 4.
-Once you have checked out Clang into the llvm source tree it will build along +with the rest of llvm. To build all of LLVM and Clang together all at +once simply run make from the root LLVM directory.
+ +Note: Observe that Clang is technically part of a separate +Subversion repository. As mentioned above, the latest Clang sources are tied to +the latest sources in the LLVM tree. You can update your toplevel LLVM project +and all (possibly unrelated) projects inside it with make +update. This will run svn update on all subdirectories related +to subversion.
+ +While the clang-cc executable is a low-level frontend executable +that can perform code generation, program analysis, and other actions, it is not +designed to be a drop-in replacement for GCC's cc. For this purpose, +use the high-level driver, aptly named clang. Here are some +examples of how to use the high-level driver: +
+ ++$ cat t.c +#include <stdio.h> +int main(int argc, char **argv) { printf("hello world\n"); } +$ clang t.c +$ ./a.out +hello world ++ +
The high-level driver clang is designed to understand most of GCC's +options, and the lower-level clang-cc executable also directly takes +many of GCC's options. You can see which options clang-cc accepts with +'clang-cc --help'. Here are a few examples of using clang and +clang-cc:
-The clang driver takes a lot of GCC compatible options, which you can see -with 'clang --help'. Here are a few examples: