From a1513f7198ad8617cd028f0e499ccdcfa64ae074 Mon Sep 17 00:00:00 2001 From: Chris Lattner Date: Sat, 6 Oct 2007 05:42:47 +0000 Subject: [PATCH] edits llvm-svn: 42684 --- clang/www/get_involved.html | 37 +++++++++++++++++++++++-------------- 1 file changed, 23 insertions(+), 14 deletions(-) diff --git a/clang/www/get_involved.html b/clang/www/get_involved.html index 783be97defdc..36ac0c25f08b 100644 --- a/clang/www/get_involved.html +++ b/clang/www/get_involved.html @@ -15,19 +15,29 @@ There are many tasks that are open to new developers who want to get involved with the Clang project. Below, you will find details on how to get started with Clang, plus a few tasks that we need help with.

Please note that the information provided here is not completely thorough. This is intentional. If you plan to work on Clang, we would like you to get involved with the other developers. This will allow us to work together better and will give you a better feel for how things are done. -You can talk with other developers at the following mailing list: cfe-dev mailing list. (On the other hand, if you feel uncomfortable getting involved in a public mailing list right away, and you just want to ask a few questions to begin with, then you can contact Chris personally, until you feel comfortable moving to the mailing list.) +You can talk with other developers at the following mailing list: cfe-dev mailing list. +The clang mailing list is a very friendly place. You can see the archives for records of past discussion. Note that a significant amount of design discussion takes place on the cfe-commits mailing list.

Getting Started

A word of warning

-While this work aims to provide a fully functional C/C++/ObjC front- end, it is *still very early work*. In particular, there is no real C++ support yet (this is obviously a big project), and C/ObjC support is still missing some features. Some of the more notable missing pieces of C support are: +While this work aims to provide a fully functional C/C++/ObjC front-end, it is still very early work and is under heavy development. In particular, there is no real C++ support yet (this is obviously a big project), and C/ObjC support is still missing some features. Some of the more notable missing pieces of C support are:
  1. The semantic analyzer does not produce all of the warnings and errors it should. -
  2. The LLVM code generator is still very early on. It does not support many important things, like any support for structs and unions. That said, it does handle scalar operations and vectors. +
  3. The LLVM code generator is still very early on. It does not support many important things, like any support for structs and unions. That said, it does handle scalar operations and vectors. clang is not ready to be used as a general purpose C code generator yet.
  4. We don't consider the API to be stable yet, and reserve the right to change fundamental things :)
Our plan is to continue chipping away at these issues until C works really well, but we'd love help from other interested contributors. +

Follow what's going on

-To avoid spamming the main LLVM mailing list, two lists were setup just for Clang. Please take all Clang related discussion to these two lists. (Note: If all you care about is the Clang front-end, and not the overall LLVM Compiler project, then the two CFE lists are all that you need.)
+ +Clang is a subproject of the LLVM Project, but has +its own mailing lists because the communities have people with different +interests. If you are interested in clang only, these two lists should be all +you need. If you are interested in the LLVM optimizer and code generator, +please consider signing up for llvmdev and llvm-commits +as well.
-
  • Non-mac users: Paths to system header files are currently hard coded into the tool; as a result, non-Mac users will need to change the path in one of the files. +
  • Non-mac users: Paths to system header files are currently hard coded + into the tool; as a result, if clang can't find your system headers, + please follow these instructions: -

    Note that the C front-end uses libsupport and libsystem. You don't need llvm-gcc :) +

    Note that the C front-end uses LLVM, but does not depend on llvm-gcc :)

    +

    We will eventually integrate this better as a sub-project, but for now it builds a single tool named 'clang'.
    Once llvm is built in this way, you can compile C code.

    Examples of using clang

    @@ -65,7 +78,6 @@ $ cat ~/t.c typedef float V __attribute__((vector_size(16))); V foo(V a, V b) { return a+b*a; } - Preprocessing: $ clang ~/t.c -E # 1 "/Users/sabre/t.c" 1 @@ -83,7 +95,7 @@ GCC options: $ clang -fsyntax-only ~/t.c -pedantic /Users/sabre/t.c:2:17: warning: extension used typedef float V __attribute__((vector_size(16))); - ^ + ^ 1 diagnostic generated. @@ -125,12 +137,9 @@ _foo:

    Available tasks

    Here are a few tasks that are currently available for newcomers to work on: -

    Final words

    -In any case, we welcome questions, comments, and especially patches :). -

    -Thanks! -

    --Chris + \ No newline at end of file