Chris Lattner | de9a4f5 | 2007-12-13 05:42:27 +0000 | [diff] [blame] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
|
| 2 | "http://www.w3.org/TR/html4/strict.dtd">
|
Kevin | aef89fc | 2007-10-06 01:28:23 +0000 | [diff] [blame] | 3 | <html>
|
Kevin | bc8e50f | 2007-10-05 21:18:52 +0000 | [diff] [blame] | 4 | <head>
|
Chris Lattner | de9a4f5 | 2007-12-13 05:42:27 +0000 | [diff] [blame] | 5 | <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
|
| 6 | <title>Clang - Get Involved</title>
|
| 7 | <link type="text/css" rel="stylesheet" href="menu.css" />
|
| 8 | <link type="text/css" rel="stylesheet" href="content.css" />
|
Kevin | bc8e50f | 2007-10-05 21:18:52 +0000 | [diff] [blame] | 9 | </head>
|
| 10 | <body>
|
Chris Lattner | de9a4f5 | 2007-12-13 05:42:27 +0000 | [diff] [blame] | 11 |
|
Kevin | bc8e50f | 2007-10-05 21:18:52 +0000 | [diff] [blame] | 12 | <!--#include virtual="menu.html.incl"-->
|
Chris Lattner | de9a4f5 | 2007-12-13 05:42:27 +0000 | [diff] [blame] | 13 |
|
Kevin | bc8e50f | 2007-10-05 21:18:52 +0000 | [diff] [blame] | 14 | <div id="content">
|
Chris Lattner | de9a4f5 | 2007-12-13 05:42:27 +0000 | [diff] [blame] | 15 |
|
Chris Lattner | 623ec62 | 2007-12-13 06:20:15 +0000 | [diff] [blame] | 16 | <h1>Getting Involved with the Clang Project</h1>
|
Chris Lattner | de9a4f5 | 2007-12-13 05:42:27 +0000 | [diff] [blame] | 17 |
|
Chris Lattner | 623ec62 | 2007-12-13 06:20:15 +0000 | [diff] [blame] | 18 | <p>Once you have <a href="get_started.html">checked out and built</a> clang and
|
| 19 | played around with it, you might be wondering what you can do to make it better
|
| 20 | and contribute to its development. Alternatively, maybe you just want to follow
|
| 21 | the development of the project to see it progress.
|
| 22 | </p>
|
Chris Lattner | de9a4f5 | 2007-12-13 05:42:27 +0000 | [diff] [blame] | 23 |
|
Chris Lattner | 623ec62 | 2007-12-13 06:20:15 +0000 | [diff] [blame] | 24 | <h2>Follow what's going on</h2>
|
Chris Lattner | a08ee28 | 2007-10-06 05:42:47 +0000 | [diff] [blame] | 25 |
|
Chris Lattner | de9a4f5 | 2007-12-13 05:42:27 +0000 | [diff] [blame] | 26 | <p>Clang is a subproject of the <a href="http://llvm.org">LLVM Project</a>, but
|
| 27 | has its own mailing lists because the communities have people with different
|
Chris Lattner | 623ec62 | 2007-12-13 06:20:15 +0000 | [diff] [blame] | 28 | interests. The two clang lists are:</p>
|
Chris Lattner | de9a4f5 | 2007-12-13 05:42:27 +0000 | [diff] [blame] | 29 |
|
Kevin | bc8e50f | 2007-10-05 21:18:52 +0000 | [diff] [blame] | 30 | <ul>
|
Chris Lattner | de9a4f5 | 2007-12-13 05:42:27 +0000 | [diff] [blame] | 31 | <li><a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits">cfe-commits
|
| 32 | </a> - This list is for patch submission/discussion.</li>
|
| 33 |
|
| 34 | <li><a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">cfe-dev</a> -
|
Chris Lattner | 623ec62 | 2007-12-13 06:20:15 +0000 | [diff] [blame] | 35 | This list is for everything else clang related (questions and answers, bug
|
| 36 | reports, etc).</li>
|
| 37 |
|
Kevin | bc8e50f | 2007-10-05 21:18:52 +0000 | [diff] [blame] | 38 | </ul>
|
Chris Lattner | de9a4f5 | 2007-12-13 05:42:27 +0000 | [diff] [blame] | 39 |
|
Chris Lattner | 623ec62 | 2007-12-13 06:20:15 +0000 | [diff] [blame] | 40 | <p>If you are interested in clang only, these two lists should be all
|
| 41 | you need. If you are interested in the LLVM optimizer and code generator,
|
| 42 | please consider signing up for <a
|
| 43 | href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">llvmdev</a> and <a
|
| 44 | href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits">llvm-commits</a>
|
| 45 | as well.</p>
|
Kevin | bc8e50f | 2007-10-05 21:18:52 +0000 | [diff] [blame] | 46 |
|
| 47 |
|
Chris Lattner | 623ec62 | 2007-12-13 06:20:15 +0000 | [diff] [blame] | 48 | <p>The best way to talk with other developers on the project is through the <a
|
| 49 | href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">cfe-dev mailing
|
| 50 | list</a>. The clang mailing list is a very friendly place and we welcome
|
| 51 | newcomers. In addition to the cfe-dev list, a significant amount of design
|
| 52 | discussion takes place on the <a
|
| 53 | href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits">cfe-commits mailing
|
| 54 | list</a>. All of these lists have archives, so you can browse through previous
|
| 55 | discussions or follow the list development on the web if you prefer.</p>
|
Kevin | bc8e50f | 2007-10-05 21:18:52 +0000 | [diff] [blame] | 56 |
|
| 57 |
|
Chris Lattner | 623ec62 | 2007-12-13 06:20:15 +0000 | [diff] [blame] | 58 | <h2>Open Projects</h2>
|
Kevin | bc8e50f | 2007-10-05 21:18:52 +0000 | [diff] [blame] | 59 |
|
Chris Lattner | 36952d9 | 2007-12-13 06:41:15 +0000 | [diff] [blame] | 60 | <p>Here are a few tasks that are available for newcomers to work on, depending
|
| 61 | on what your interests are. This list is provided to generate ideas, it is not
|
| 62 | intended to be comprehensive. Please ask on cfe-dev for more specifics or to
|
| 63 | verify that one of these isn't already completed. :)</p>
|
Kevin | bc8e50f | 2007-10-05 21:18:52 +0000 | [diff] [blame] | 64 |
|
Chris Lattner | a08ee28 | 2007-10-06 05:42:47 +0000 | [diff] [blame] | 65 | <ul>
|
Chris Lattner | 623ec62 | 2007-12-13 06:20:15 +0000 | [diff] [blame] | 66 | <li><b>Compile your favorite C/ObjC project with "clang -fsyntax-only"</b>:
|
| 67 | the clang type checker and verifier is quite close to complete (but not bug
|
| 68 | free!) for C and Objective C. We appreciate all reports of code that is
|
| 69 | rejected by the front-end, and if you notice invalid code that is not rejected
|
| 70 | by clang, that is also very important to us.</li>
|
| 71 |
|
Chris Lattner | 36952d9 | 2007-12-13 06:41:15 +0000 | [diff] [blame] | 72 | <li><b>Compile your favorite C project with "clang -emit-llvm"</b>:
|
| 73 | The clang to LLVM converter is getting more mature, so you may be able to
|
| 74 | compile it. If not, please let us know. Once it compiles it should run. If
|
| 75 | not, that's a bug :)</li>
|
Chris Lattner | 623ec62 | 2007-12-13 06:20:15 +0000 | [diff] [blame] | 76 |
|
Chris Lattner | 2fbb049 | 2007-12-13 17:25:36 +0000 | [diff] [blame] | 77 | <li><b>Work on code generation for Objective C</b>: -emit-llvm support for
|
Chris Lattner | b62f651 | 2007-12-13 17:27:09 +0000 | [diff] [blame^] | 78 | Objective C is basically nonexistent at the time of this writing, this is a
|
Chris Lattner | 36952d9 | 2007-12-13 06:41:15 +0000 | [diff] [blame] | 79 | nice open project that can be tackled incrementally (one language feature at a
|
| 80 | time).</li>
|
| 81 |
|
Chris Lattner | 2fbb049 | 2007-12-13 17:25:36 +0000 | [diff] [blame] | 82 | <li><b>Debug Info Generation</b>: -emit-llvm doesn't currently support emission
|
| 83 | of <a href="http://llvm.org/docs/SourceLevelDebugging.html">LLVM debug info</a>
|
| 84 | (which the code generator turns into DWARF). Adding this should be
|
| 85 | straight-forward if you follow the example of what llvm-gcc generates.</li>
|
| 86 |
|
Chris Lattner | 36952d9 | 2007-12-13 06:41:15 +0000 | [diff] [blame] | 87 | <li><b>Continue work on C++ support</b>: Implementing all of C++ is a very big
|
| 88 | job, but there are lots of little things that can be done. Right now we support
|
| 89 | some small things like references and bool. We also support parsing of
|
Bill Wendling | 05faa37 | 2007-12-13 09:57:40 +0000 | [diff] [blame] | 90 | namespaces, but don't build ASTs for it. It would be straight-forward to
|
Chris Lattner | 36952d9 | 2007-12-13 06:41:15 +0000 | [diff] [blame] | 91 | implement support for representing namespaces, then add support for things like
|
| 92 | foo::bar::baz. Likewise, lots of other little pieces can be picked off and
|
| 93 | implemented.</li>
|
| 94 |
|
| 95 | <li><b>Improve target support</b>: The current target interfaces are heavily
|
| 96 | stubbed out and need to be implemented fully. See the FIXME's in TargetInfo.
|
| 97 | Additionally, the actual target implementations (instances of TargetInfoImpl)
|
| 98 | also need to be completed. This includes defining builtin macros for linux
|
| 99 | targets and other stuff like that.</li>
|
| 100 |
|
| 101 | <li><b>Implement 'builtin' headers</b>: GCC provides a bunch of builtin headers,
|
| 102 | such as stdbool.h, iso646.h, float.h, limits.h, etc. It also provides a bunch
|
| 103 | of target-specific headers like altivec.h and xmmintrin.h. clang will
|
| 104 | eventually need to provide its own copies of these (and there is a <a href=
|
| 105 | "http://lists.cs.uiuc.edu/pipermail/cfe-dev/2007-December/000560.html">lot of
|
| 106 | improvement</a> that can be made to the GCC ones!) that are clean-room
|
| 107 | implemented to avoid GPL taint.</li>
|
| 108 |
|
| 109 | <li><b>Implement a clang 'libgcc'</b>: As with the headers, clang (or a another
|
| 110 | related subproject of llvm) will need to implement the features that libgcc
|
| 111 | provides. libgcc provides a bunch of routines the code generator uses for
|
| 112 | "fallback" when the chip doesn't support some operation (e.g. 64-bit divide on
|
| 113 | a 32-bit chip). It also provides software floating point support and many other
|
| 114 | things. I don't think that there is a specific licensing reason to reimplement
|
| 115 | libgcc, but there is a lot of room for improvement in it in many
|
| 116 | dimensions.</li>
|
| 117 |
|
Chris Lattner | a08ee28 | 2007-10-06 05:42:47 +0000 | [diff] [blame] | 118 | </ul>
|
Chris Lattner | 623ec62 | 2007-12-13 06:20:15 +0000 | [diff] [blame] | 119 |
|
Chris Lattner | 36952d9 | 2007-12-13 06:41:15 +0000 | [diff] [blame] | 120 | <p>If you hit a bug with clang, it is very useful for us if you reduce the code
|
| 121 | that demonstrates the problem down to something small. There are many ways to
|
Ted Kremenek | 3cbe428 | 2007-12-13 16:41:01 +0000 | [diff] [blame] | 122 | do this; ask on cfe-dev for advice.</p>
|
Chris Lattner | 36952d9 | 2007-12-13 06:41:15 +0000 | [diff] [blame] | 123 |
|
Kevin | bc8e50f | 2007-10-05 21:18:52 +0000 | [diff] [blame] | 124 | </div>
|
| 125 | </body>
|
Chris Lattner | ae3758d | 2007-10-11 00:38:03 +0000 | [diff] [blame] | 126 | </html>
|