\r
<div id="content">\r
\r
-<h1>Getting Involved</h1>\r
+<h1>Getting Involved with the Clang Project</h1>\r
\r
-<p>There are many tasks that are open to new developers who want to get involved\r
-with the Clang project. Below, you will find details on how to get started with\r
-Clang, plus a few tasks that we need help with.</p>\r
+<p>Once you have <a href="get_started.html">checked out and built</a> clang and\r
+played around with it, you might be wondering what you can do to make it better\r
+and contribute to its development. Alternatively, maybe you just want to follow\r
+the development of the project to see it progress.\r
+</p>\r
\r
-<p>Please note that the information provided here is not completely thorough.\r
-This is intentional. If you plan to work on Clang, we would like you to get\r
-involved with the other developers. This will allow us to work together better\r
-and will give you a better feel for how things are done.</p>\r
-\r
-<p>You can talk with other developers at the following mailing list: <a\r
-href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">cfe-dev mailing\r
-list</a>. The clang mailing list is a very friendly place. You can see the\r
-archives for records of past discussion. Note that a significant amount of\r
-design discussion takes place on the <a \r
-href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits">cfe-commits mailing\r
-list</a>. </p>\r
-\r
-<h2>Getting Started</h2>\r
-\r
-<h3>A word of warning</h3>\r
+<h2>Follow what's going on</h2>\r
\r
-<p>While this work aims to provide a fully functional C/C++/ObjC front-end, it\r
-is <em>still very early work</em> and is under heavy development. In particular,\r
-there is no real C++ support yet (this is obviously a big project), and C/ObjC\r
-support is still missing some features. Some of the more notable missing pieces\r
-of C support are:</p>\r
+<p>Clang is a subproject of the <a href="http://llvm.org">LLVM Project</a>, but\r
+has its own mailing lists because the communities have people with different\r
+interests. The two clang lists are:</p>\r
\r
-<ol>\r
- <li>The semantic analyzer does not produce all of the warnings and errors it\r
- should.</li>\r
- <li>The LLVM code generator is still very early on. It does not support many\r
- important things, like any support for structs and unions. That said, it\r
- does handle scalar operations and vectors. clang is not ready to be used\r
- as a general purpose C code generator yet.</li>\r
- <li>We don't consider the API to be stable yet, and reserve the right to\r
- change fundamental things. :)</li>\r
-</ol>\r
+<ul>\r
+<li><a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits">cfe-commits\r
+</a> - This list is for patch submission/discussion.</li>\r
\r
-<p>Our plan is to continue chipping away at these issues until C works really\r
-well, but we'd love help from other interested contributors.</p>\r
+<li><a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">cfe-dev</a> - \r
+This list is for everything else clang related (questions and answers, bug\r
+reports, etc).</li>\r
\r
-<h3>Follow what's going on</h3>\r
+</ul>\r
\r
-<p>Clang is a subproject of the <a href="http://llvm.org">LLVM Project</a>, but\r
-has its own mailing lists because the communities have people with different\r
-interests. If you are interested in clang only, these two lists should be all\r
+<p>If you are interested in clang only, these two lists should be all\r
you need. If you are interested in the LLVM optimizer and code generator,\r
please consider signing up for <a \r
href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">llvmdev</a> and <a\r
href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits">llvm-commits</a>\r
as well.</p>\r
\r
-<ul>\r
-<li><a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits">cfe-commits\r
-</a> - This list is for patch submission/discussion.</li>\r
\r
-<li><a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">cfe-dev</a> - \r
-This list is for everything else clang related.</li>\r
-</ul>\r
+<p>The best way to talk with other developers on the project is through the <a\r
+href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">cfe-dev mailing\r
+list</a>. The clang mailing list is a very friendly place and we welcome\r
+newcomers. In addition to the cfe-dev list, a significant amount of design\r
+discussion takes place on the <a \r
+href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits">cfe-commits mailing\r
+list</a>. All of these lists have archives, so you can browse through previous\r
+discussions or follow the list development on the web if you prefer.</p>\r
+\r
+\r
+<h2>Open Projects</h2>\r
+\r
+<p>Here are a few tasks that are available for newcomers to work on. This list\r
+is provided to generate ideas, it is not intended to be comprehensive. Please\r
+ask on cfe-dev for more specifics or to verify that one of these isn't already\r
+completed. :)</p>\r
+\r
+<p>Please note that the information provided here is not completely thorough.\r
+This is intentional. If you plan to work on Clang, we would like you to get\r
+involved with the other developers. This will allow us to work together better\r
+and will give you a better feel for how things are done.</p>\r
\r
-<h3><a name="build">Building clang / working with the code</a></h3>\r
-\r
-<p>If you would like to check out and build the project, the current scheme\r
-is:</p>\r
-\r
-<ol>\r
- <li><a href="http://www.llvm.org/docs/GettingStarted.html#checkout">Checkout\r
- and build LLVM</a> from SVN head:</li>\r
- \r
- <ul>\r
- <li><tt>svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm</tt></li>\r
- <li><tt>cd llvm</tt></li>\r
- <li><tt>./configure; make</tt></li>\r
- </ul>\r
- <li>Checkout clang:</li>\r
- <ul>\r
- <li>From within the <tt>llvm</tt> directory (where you\r
- built llvm):</li>\r
- <li><tt>cd llvm/tools</tt>\r
- <li><tt>svn co\r
- http://llvm.org/svn/llvm-project/cfe/trunk clang</tt></li>\r
- \r
- </ul>\r
- <li>Non-mac users: Paths to system header files are currently hard coded\r
- into clang; as a result, if clang can't find your system headers,\r
- please follow these instructions:</li>\r
- \r
- <ul>\r
- <li>'<tt>touch empty.c; gcc -v empty.c -fsyntax-only</tt>' to get the \r
- path.</li>\r
- <li>Look for the comment "FIXME: temporary hack:\r
- hard-coded paths" in <tt>clang/Driver/clang.cpp</tt> and\r
- change the lines below to include that path.</li>\r
- </ul>\r
- \r
- <li>Build clang:</li>\r
- <ul>\r
- <li><tt>cd clang</tt> (assuming that you are in <tt>llvm/tools</tt>)</li>\r
- <li><tt>make</tt></li>\r
- </ul>\r
- \r
- <li>Try it out (assuming you add llvm/Debug/bin to your path):</li>\r
- <ul>\r
- <li><tt>clang --help</tt></li>\r
- <li><tt>clang file.c -fsyntax-only</tt> (check for correctness)</li>\r
- <li><tt>clang file.c -ast-dump</tt> (internal debug dump of ast)</li>\r
- <li><tt>clang file.c -ast-view</tt> (<a \r
- href="http://llvm.org/docs/ProgrammersManual.html#ViewGraph">set up graphviz\r
- and rebuild llvm first</a>)</li>\r
- <li><tt>clang file.c -emit-llvm</tt> (print out unoptimized llvm code)</li>\r
- <li><tt>clang file.c -emit-llvm | llvm-as | opt -std-compile-opts | \r
- llvm-dis</tt> (print out optimized llvm code)</li>\r
- <li><tt>clang file.c -emit-llvm | llvm-as | opt -std-compile-opts | llc\r
- > file.s</tt> (output native machine code)</li>\r
- </ul>\r
-</ol>\r
-\r
-<p>Note that the C front-end uses LLVM, but does not depend on\r
- llvm-gcc. If you encounter problems with building clang, make\r
- sure you have the latest SVN version of LLVM. LLVM contains\r
- support libraries for clang that will be updated as well as\r
- development on clang progresses.</p>\r
- \r
-<h3>Examples of using clang</h3>\r
-\r
-<p>The clang driver takes a lot of GCC compatible options, which you can see\r
-with 'clang --help'. Here are a few examples:</p>\r
-<!-- Thanks to\r
- http://shiflett.org/blog/2006/oct/formatting-and-highlighting-php-code-listings\r
-Site suggested using pre in CSS, but doesn't work in IE, so went for the <pre>\r
-tag. -->\r
-\r
-<pre class="code">\r
-$ cat ~/t.c\r
-\r
-typedef float V __attribute__((vector_size(16)));\r
-V foo(V a, V b) { return a+b*a; }\r
-\r
-Preprocessing:\r
-$ clang ~/t.c -E\r
-# 1 "/Users/sabre/t.c" 1\r
-\r
-typedef float V __attribute__((vector_size(16)));\r
-\r
-V foo(V a, V b) { return a+b*a; }\r
-\r
-\r
-Type checking:\r
-$ clang -fsyntax-only ~/t.c\r
-\r
-\r
-GCC options:\r
-$ clang -fsyntax-only ~/t.c -pedantic\r
-/Users/sabre/t.c:2:17: warning: extension used\r
-typedef float V __attribute__((vector_size(16)));\r
- ^\r
-1 diagnostic generated.\r
-\r
-\r
-\r
-Pretty printing from the AST:\r
-$ clang ~/t.c -ast-print\r
-typedef float V __attribute__(( vector_size(16) ));\r
-\r
-V foo(V a, V b) {\r
- return a + b * a;\r
-}\r
-\r
-\r
-LLVM code generation:\r
-$ clang ~/t.c -emit-llvm | llvm-as | opt -std-compile-opts | llvm-dis\r
-define <4 x float> @foo(<4 x float> %a, <4 x float> %b) {\r
-entry:\r
- %mul = mul <4 x float> %b, %a\r
- %add = add <4 x float> %mul, %a\r
- ret <4 x float> %add\r
-}\r
-$ clang ~/t.c -emit-llvm | llvm-as | opt -std-compile-opts | llc - \r
-march=ppc32 -mcpu=g5\r
-..\r
-_foo:\r
- vmaddfp v2, v3, v2, v2\r
- blr\r
-$ clang ~/t.c -emit-llvm | llvm-as | opt -std-compile-opts | llc - \r
-march=x86 -mcpu=yonah\r
-..\r
-_foo:\r
- mulps %xmm0, %xmm1\r
- addps %xmm0, %xmm1\r
- movaps %xmm1, %xmm0\r
- ret\r
-</pre>\r
-<h2>Available tasks</h2>\r
-Here are a few tasks that are currently available for newcomers to work on:\r
\r
<ul>\r
-<li>None yet, ask on cfe-dev</li>\r
+<li><b>Compile your favorite C/ObjC project with "clang -fsyntax-only"</b>:\r
+the clang type checker and verifier is quite close to complete (but not bug\r
+free!) for C and Objective C. We appreciate all reports of code that is\r
+rejected by the front-end, and if you notice invalid code that is not rejected\r
+by clang, that is also very important to us.</li>\r
+\r
+<li>\r
+\r
+ </li>\r
</ul>\r
+\r
</div>\r
</body>\r
</html>\r
--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"\r
+ "http://www.w3.org/TR/html4/strict.dtd">\r
+<html>\r
+<head>\r
+ <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />\r
+ <title>Clang - Getting Started</title>\r
+ <link type="text/css" rel="stylesheet" href="menu.css" />\r
+ <link type="text/css" rel="stylesheet" href="content.css" />\r
+</head>\r
+<body>\r
+\r
+<!--#include virtual="menu.html.incl"-->\r
+\r
+<div id="content">\r
+\r
+<h1>Getting Started: Building and Running Clang</h1>\r
+\r
+\r
+<p>This page gives you the shortest path to checking out clang and demos a few\r
+options. This should get you up and running with the minimum of muss and fuss.\r
+If you like what you see, please consider <a href="get_involved.html">getting\r
+involved</a> with the clang community.</p>\r
+\r
+\r
+<h2>A word of warning</h2>\r
+\r
+<p>While this work aims to provide a fully functional C/C++/ObjC front-end, it\r
+is <em>still very early work</em> and is under heavy development. In particular,\r
+there is no real C++ support yet (this is obviously a big project), and C/ObjC\r
+support is still missing some features. Some of the more notable missing pieces\r
+of C support are:</p>\r
+\r
+<ol>\r
+ <li>The semantic analyzer does not produce all of the warnings and errors it\r
+ should.</li>\r
+ <li>The LLVM code generator is still missing important features. clang is not\r
+ ready to be used as a general purpose C code generator yet, but if you\r
+ hit problems and report them to cfe-dev, we'll fix them :).</li>\r
+ <li>We don't consider the API to be stable yet, and reserve the right to\r
+ change fundamental things.</li>\r
+</ol>\r
+\r
+<p>Our plan is to continue chipping away at these issues until C works really\r
+well, but we'd love help from other interested contributors. We expect C to be\r
+in good shape by mid to late 2008.</p>\r
+\r
+<h3><a name="build">Building clang / working with the code</a></h3>\r
+\r
+<p>If you would like to check out and build the project, the current scheme\r
+is:</p>\r
+\r
+<ol>\r
+ <li><a href="http://www.llvm.org/docs/GettingStarted.html#checkout">Checkout\r
+ and build LLVM</a> from SVN head:</li>\r
+ \r
+ <ul>\r
+ <li><tt>svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm</tt></li>\r
+ <li><tt>cd llvm</tt></li>\r
+ <li><tt>./configure; make</tt></li>\r
+ </ul>\r
+ <li>Checkout clang:</li>\r
+ <ul>\r
+ <li>From within the <tt>llvm</tt> directory (where you\r
+ built llvm):</li>\r
+ <li><tt>cd llvm/tools</tt>\r
+ <li><tt>svn co http://llvm.org/svn/llvm-project/cfe/trunk clang</tt></li>\r
+ \r
+ </ul>\r
+ <li>Non-mac users: Paths to system header files are currently hard coded\r
+ into clang; as a result, if clang can't find your system headers,\r
+ please follow these instructions:</li>\r
+ \r
+ <ul>\r
+ <li>'<tt>touch empty.c; gcc -v empty.c -fsyntax-only</tt>' to get the \r
+ path.</li>\r
+ <li>Look for the comment "FIXME: temporary hack:\r
+ hard-coded paths" in <tt>clang/Driver/clang.cpp</tt> and\r
+ change the lines below to include that path.</li>\r
+ </ul>\r
+ \r
+ <li>Build clang:</li>\r
+ <ul>\r
+ <li><tt>cd clang</tt> (assuming that you are in <tt>llvm/tools</tt>)</li>\r
+ <li><tt>make</tt> (this will give you a debug build)</li>\r
+ </ul>\r
+ \r
+ <li>Try it out (assuming you add llvm/Debug/bin to your path):</li>\r
+ <ul>\r
+ <li><tt>clang --help</tt></li>\r
+ <li><tt>clang file.c -fsyntax-only</tt> (check for correctness)</li>\r
+ <li><tt>clang file.c -ast-dump</tt> (internal debug dump of ast)</li>\r
+ <li><tt>clang file.c -ast-view</tt> (<a \r
+ href="http://llvm.org/docs/ProgrammersManual.html#ViewGraph">set up graphviz\r
+ and rebuild llvm first</a>)</li>\r
+ <li><tt>clang file.c -emit-llvm</tt> (print out unoptimized llvm code)</li>\r
+ <li><tt>clang file.c -emit-llvm | llvm-as | opt -std-compile-opts | \r
+ llvm-dis</tt> (print out optimized llvm code)</li>\r
+ <li><tt>clang file.c -emit-llvm | llvm-as | opt -std-compile-opts | llc\r
+ > file.s</tt> (output native machine code)</li>\r
+ </ul>\r
+</ol>\r
+\r
+<p>Note that the C front-end uses LLVM, but does not depend on\r
+ llvm-gcc. If you encounter problems with building clang, make\r
+ sure you have the latest SVN version of LLVM. LLVM contains\r
+ support libraries for clang that will be updated as well as\r
+ development on clang progresses.</p>\r
+ \r
+<h3>Examples of using clang</h3>\r
+\r
+<p>The clang driver takes a lot of GCC compatible options, which you can see\r
+with 'clang --help'. Here are a few examples:</p>\r
+<!-- Thanks to\r
+ http://shiflett.org/blog/2006/oct/formatting-and-highlighting-php-code-listings\r
+Site suggested using pre in CSS, but doesn't work in IE, so went for the <pre>\r
+tag. -->\r
+\r
+<pre class="code">\r
+$ <b>cat ~/t.c</b>\r
+typedef float V __attribute__((vector_size(16)));\r
+V foo(V a, V b) { return a+b*a; }\r
+</pre>\r
+\r
+\r
+<h4>Preprocessing:</h4>\r
+\r
+<pre class="code">\r
+$ <b>clang ~/t.c -E</b>\r
+# 1 "/Users/sabre/t.c" 1\r
+\r
+typedef float V __attribute__((vector_size(16)));\r
+\r
+V foo(V a, V b) { return a+b*a; }\r
+</pre>\r
+\r
+\r
+<h4>Type checking:</h4>\r
+\r
+<pre class="code">\r
+$ <b>clang -fsyntax-only ~/t.c</b>\r
+</pre>\r
+\r
+\r
+<h4>GCC options:</h4>\r
+\r
+<pre class="code">\r
+$ <b>clang -fsyntax-only ~/t.c -pedantic</b>\r
+/Users/sabre/t.c:2:17: warning: extension used\r
+typedef float V __attribute__((vector_size(16)));\r
+ ^\r
+1 diagnostic generated.\r
+</pre>\r
+\r
+\r
+<h4>Pretty printing from the AST:</h4>\r
+\r
+<pre class="code">\r
+$ <b>clang ~/t.c -ast-print</b>\r
+typedef float V __attribute__(( vector_size(16) ));\r
+V foo(V a, V b) {\r
+ return a + b * a;\r
+}\r
+</pre>\r
+\r
+\r
+<h4>Code generation with LLVM:</h4>\r
+\r
+<pre class="code">\r
+$ <b>clang ~/t.c -emit-llvm | llvm-as | opt -std-compile-opts | llvm-dis</b>\r
+define <4 x float> @foo(<4 x float> %a, <4 x float> %b) {\r
+entry:\r
+ %mul = mul <4 x float> %b, %a\r
+ %add = add <4 x float> %mul, %a\r
+ ret <4 x float> %add\r
+}\r
+$ <b>clang ~/t.c -emit-llvm | llvm-as | opt -std-compile-opts | llc -march=ppc32 -mcpu=g5</b>\r
+..\r
+_foo:\r
+ vmaddfp v2, v3, v2, v2\r
+ blr\r
+$ <b>clang ~/t.c -emit-llvm | llvm-as | opt -std-compile-opts | llc -march=x86 -mcpu=yonah</b>\r
+..\r
+_foo:\r
+ mulps %xmm0, %xmm1\r
+ addps %xmm0, %xmm1\r
+ movaps %xmm1, %xmm0\r
+ ret\r
+</pre>\r
+\r
+</div>\r
+</body>\r
+</html>\r
\r
<p>The goal of the Clang project is to create a new C, C++, Objective C and\r
Objective C++ front-end for the <a href="http://www.llvm.org/">LLVM</a>\r
- compiler.</p>\r
+ compiler. You can <a href="get_started.html">get and build</a> the source\r
+ today.</p>\r
\r
<!--=====================================================================-->\r
<h2><a name="goals">Features and Goals</a></h2>\r
\r
<ul>\r
<li>Modular library based architecture</li>\r
- <li>Support diverse clients (refactoring, static analysis, code generation, etc)</li>\r
+ <li>Support diverse clients (refactoring, static analysis, code generation,\r
+ etc)</li>\r
<li>Allow tight integration with IDEs</li>\r
<li>Use the LLVM 'BSD' License</li>\r
</ul>\r
respectable C++ support for another 2 years or so.</p>\r
\r
<!--=====================================================================-->\r
- <h2>Get Involved</h2>\r
+ <h2>Get it and get involved!</h2>\r
<!--=====================================================================-->\r
\r
- <p>The developers of Clang include contributers from Apple and numerous\r
- other volunteers. If you are interested in joining the community or\r
- learning more, please consider joining the <a \r
- href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">cfe-dev</a>\r
- mailing list, or start by browsing its archives.</p>\r
-\r
- <p>If you are interested in trying out Clang, please see the build\r
- instructions on the <a href="get_involved.html#build">Get Involved</a> \r
- page.</p> \r
+ <p>Start by <a href="get_started.html">geting the code, building it, and\r
+ playing with it</a>. This will show you the sorts of things we can do\r
+ today and will let you have the "clang experience" first hand: hopefully\r
+ it will "resonate" with you. :)</p>\r
+ \r
+ <p>Once you've done that, please consider <a href="get_involved.html">getting\r
+ involved in the clang community</a>. The clang developers include numerous\r
+ volunteers as well as contributers from Apple. If you're interested in\r
+ following the development of clang, signing up for a mailing list is a good\r
+ way to learn about how the project works.</p>\r
</div>\r
</body>\r
</html>\r
projects / clang / commitdiff