NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 2 | "http://www.w3.org/TR/html4/strict.dtd"> |
| 3 | <!-- Material used from: HTML 4.01 specs: http://www.w3.org/TR/html401/ --> |
| 4 | <html> |
| 5 | <head> |
Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 6 | <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 7 | <title>Hacking on clang</title> |
Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 8 | <link type="text/css" rel="stylesheet" href="menu.css"> |
| 9 | <link type="text/css" rel="stylesheet" href="content.css"> |
| 10 | <style type="text/css"> |
| 11 | pre { margin-left: 1.5em; } |
| 12 | </style> |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 13 | </head> |
| 14 | <body> |
| 15 | <!--#include virtual="menu.html.incl"--> |
| 16 | <div id="content"> |
| 17 | <!--*********************************************************************--> |
| 18 | <h1>Hacking on Clang</h1> |
| 19 | <!--*********************************************************************--> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 20 | |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 21 | <p>This document provides some hints for how to get started hacking |
| 22 | on Clang for developers who are new to the Clang and/or LLVM |
| 23 | codebases.</p> |
| 24 | <ul> |
Daniel Dunbar | 79bba50 | 2010-01-22 02:04:46 +0000 | [diff] [blame] | 25 | <li><a href="#style">Coding Standards</a></li> |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 26 | <li><a href="#docs">Developer Documentation</a></li> |
| 27 | <li><a href="#debugging">Debugging</a></li> |
Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 28 | <li><a href="#testing">Testing</a> |
Eli Friedman | d1e1ef3 | 2009-08-03 19:42:28 +0000 | [diff] [blame] | 29 | <ul> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 30 | <li><a href="#testingNonWindows">Testing on Unix-like Systems</a></li> |
| 31 | <li><a href="#testingWindows">Testing using Visual Studio on Windows</a></li> |
| 32 | <li><a href="#testingCommands">Testing on the Command Line</a></li> |
| 33 | </ul> |
Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 34 | </li> |
Eli Friedman | d1e1ef3 | 2009-08-03 19:42:28 +0000 | [diff] [blame] | 35 | <li><a href="#patches">Creating Patch Files</a></li> |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 36 | <li><a href="#irgen">LLVM IR Generation</a></li> |
| 37 | </ul> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 38 | |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 39 | <!--=====================================================================--> |
Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 40 | <h2 id="style">Coding Standards</h2> |
Daniel Dunbar | 79bba50 | 2010-01-22 02:04:46 +0000 | [diff] [blame] | 41 | <!--=====================================================================--> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 42 | |
Daniel Dunbar | 79bba50 | 2010-01-22 02:04:46 +0000 | [diff] [blame] | 43 | <p>Clang follows the |
| 44 | LLVM <a href="http://llvm.org/docs/CodingStandards.html">Coding |
| 45 | Standards</a>. When submitting patches, please take care to follow these standards |
| 46 | and to match the style of the code to that present in Clang (for example, in |
| 47 | terms of indentation, bracing, and statement spacing).</p> |
| 48 | |
| 49 | <p>Clang has a few additional coding standards:</p> |
| 50 | <ul> |
| 51 | <li><i>cstdio is forbidden</i>: library code should not output diagnostics |
| 52 | or other information using <tt>cstdio</tt>; debugging routines should |
| 53 | use <tt>llvm::errs()</tt>. Other uses of <tt>cstdio</tt> impose behavior |
| 54 | upon clients and block integrating Clang as a library. Libraries should |
| 55 | support <tt>raw_ostream</tt> based interfaces for textual |
| 56 | output. See <a href="http://llvm.org/docs/CodingStandards.html#ll_raw_ostream">Coding |
| 57 | Standards</a>.</li> |
| 58 | </ul> |
| 59 | |
| 60 | <!--=====================================================================--> |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 61 | <h2 id="docs">Developer Documentation</h2> |
| 62 | <!--=====================================================================--> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 63 | |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 64 | <p>Both Clang and LLVM use doxygen to provide API documentation. Their |
| 65 | respective web pages (generated nightly) are here:</p> |
| 66 | <ul> |
| 67 | <li><a href="http://clang.llvm.org/doxygen">Clang</a></li> |
| 68 | <li><a href="http://llvm.org/doxygen">LLVM</a></li> |
| 69 | </ul> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 70 | |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 71 | <p>For work on the LLVM IR generation, the LLVM assembly language |
| 72 | <a href="http://llvm.org/docs/LangRef.html">reference manual</a> is |
| 73 | also useful.</p> |
| 74 | |
| 75 | <!--=====================================================================--> |
| 76 | <h2 id="debugging">Debugging</h2> |
| 77 | <!--=====================================================================--> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 78 | |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 79 | <p>Inspecting data structures in a debugger:</p> |
| 80 | <ul> |
| 81 | <li>Many LLVM and Clang data structures provide |
| 82 | a <tt>dump()</tt> method which will print a description of the |
| 83 | data structure to <tt>stderr</tt>.</li> |
| 84 | <li>The <a href="docs/InternalsManual.html#QualType"><tt>QualType</tt></a> |
| 85 | structure is used pervasively. This is a simple value class for |
| 86 | wrapping types with qualifiers; you can use |
| 87 | the <tt>isConstQualified()</tt>, for example, to get one of the |
| 88 | qualifiers, and the <tt>getTypePtr()</tt> method to get the |
| 89 | wrapped <tt>Type*</tt> which you can then dump.</li> |
Argyrios Kyrtzidis | 40b48a1 | 2012-11-16 00:25:28 +0000 | [diff] [blame] | 90 | <li>For <a href="http://lldb.llvm.org"> <tt>LLDB</tt></a> users there are |
| 91 | data formatters for clang data structures in |
| 92 | <a href="http://llvm.org/svn/llvm-project/cfe/trunk/utils/ClangDataFormat.py"> |
| 93 | <tt>utils/ClangDataFormat.py</tt></a>.</li> |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 94 | </ul> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 95 | |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 96 | <!--=====================================================================--> |
Douglas Gregor | 3ef1ad2 | 2011-07-27 05:22:46 +0000 | [diff] [blame] | 97 | <h3 id="debuggingVisualStudio">Debugging using Visual Studio</h3> |
| 98 | <!--=====================================================================--> |
| 99 | |
Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 100 | <p>The files |
| 101 | <a href="http://llvm.org/svn/llvm-project/llvm/trunk/utils/llvm.natvis"> |
| 102 | <tt>utils/llvm.natvis</tt></a> and |
| 103 | <a href="http://llvm.org/svn/llvm-project/cfe/trunk/utils/clang.natvis"> |
| 104 | <tt>utils/clang.natvis</tt></a> provide debugger visualizers |
| 105 | that make debugging of more complex data types much easier.</p> |
| 106 | <p>Put the files into |
| 107 | <tt>%USERPROFILE%\Documents\Visual Studio 2012\Visualizers</tt> or |
| 108 | create a symbolic link so they update automatically.</p> |
Douglas Gregor | 3ef1ad2 | 2011-07-27 05:22:46 +0000 | [diff] [blame] | 109 | |
| 110 | <!--=====================================================================--> |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 111 | <h2 id="testing">Testing</h2> |
| 112 | <!--=====================================================================--> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 113 | |
Eli Friedman | d1e1ef3 | 2009-08-03 19:42:28 +0000 | [diff] [blame] | 114 | <!--=====================================================================--> |
| 115 | <h3 id="testingNonWindows">Testing on Unix-like Systems</h3> |
| 116 | <!--=====================================================================--> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 117 | |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 118 | <p>Clang includes a basic regression suite in the tree which can be |
| 119 | run with <tt>make test</tt> from the top-level clang directory, or |
Eli Friedman | d1e1ef3 | 2009-08-03 19:42:28 +0000 | [diff] [blame] | 120 | just <tt>make</tt> in the <em>test</em> sub-directory. |
| 121 | <tt>make VERBOSE=1</tt> can be used to show more detail |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 122 | about what is being run.</p> |
| 123 | |
Daniel Dunbar | df29378 | 2010-06-10 17:01:45 +0000 | [diff] [blame] | 124 | <p>If you built LLVM and Clang using CMake, the test suite can be run |
| 125 | with <tt>make clang-test</tt> from the top-level LLVM directory.</p> |
| 126 | |
Eli Friedman | d1e1ef3 | 2009-08-03 19:42:28 +0000 | [diff] [blame] | 127 | <p>The tests primarily consist of a test runner script running the compiler |
| 128 | under test on individual test files grouped in the directories under the |
| 129 | test directory. The individual test files include comments at the |
| 130 | beginning indicating the Clang compile options to use, to be read |
| 131 | by the test runner. Embedded comments also can do things like telling |
| 132 | the test runner that an error is expected at the current line. |
| 133 | Any output files produced by the test will be placed under |
| 134 | a created Output directory.</p> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 135 | |
Eli Friedman | d1e1ef3 | 2009-08-03 19:42:28 +0000 | [diff] [blame] | 136 | <p>During the run of <tt>make test</tt>, the terminal output will |
| 137 | display a line similar to the following:</p> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 138 | |
Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 139 | <pre>--- Running clang tests for i686-pc-linux-gnu ---</pre> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 140 | |
Eli Friedman | d1e1ef3 | 2009-08-03 19:42:28 +0000 | [diff] [blame] | 141 | <p>followed by a line continually overwritten with the current test |
| 142 | file being compiled, and an overall completion percentage.</p> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 143 | |
Eli Friedman | d1e1ef3 | 2009-08-03 19:42:28 +0000 | [diff] [blame] | 144 | <p>After the <tt>make test</tt> run completes, the absence of any |
| 145 | <tt>Failing Tests (count):</tt> message indicates that no tests |
| 146 | failed unexpectedly. If any tests did fail, the |
| 147 | <tt>Failing Tests (count):</tt> message will be followed by a list |
| 148 | of the test source file paths that failed. For example:</p> |
| 149 | |
Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 150 | <pre> |
Eli Friedman | d1e1ef3 | 2009-08-03 19:42:28 +0000 | [diff] [blame] | 151 | Failing Tests (3): |
| 152 | /home/john/llvm/tools/clang/test/SemaCXX/member-name-lookup.cpp |
| 153 | /home/john/llvm/tools/clang/test/SemaCXX/namespace-alias.cpp |
| 154 | /home/john/llvm/tools/clang/test/SemaCXX/using-directive.cpp |
Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 155 | </pre> |
Eli Friedman | d1e1ef3 | 2009-08-03 19:42:28 +0000 | [diff] [blame] | 156 | |
| 157 | <p>If you used the <tt>make VERBOSE=1</tt> option, the terminal |
| 158 | output will reflect the error messages from the compiler and |
| 159 | test runner.</p> |
| 160 | |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 161 | <p>The regression suite can also be run with Valgrind by running |
| 162 | <tt>make test VG=1</tt> in the top-level clang directory.</p> |
| 163 | |
| 164 | <p>For more intensive changes, running |
| 165 | the <a href="http://llvm.org/docs/TestingGuide.html#testsuiterun">LLVM |
| 166 | Test Suite</a> with clang is recommended. Currently the best way to |
Daniel Dunbar | 12e57bc | 2009-08-06 16:47:53 +0000 | [diff] [blame] | 167 | override LLVMGCC, as in: <tt>make LLVMGCC="clang -std=gnu89" |
| 168 | TEST=nightly report</tt> (make sure <tt>clang</tt> is in your PATH or use the |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 169 | full path).</p> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 170 | |
Eli Friedman | d1e1ef3 | 2009-08-03 19:42:28 +0000 | [diff] [blame] | 171 | <!--=====================================================================--> |
| 172 | <h3 id="testingWindows">Testing using Visual Studio on Windows</h3> |
| 173 | <!--=====================================================================--> |
| 174 | |
John Thompson | 99ff8da | 2009-11-06 00:06:29 +0000 | [diff] [blame] | 175 | <p>The Clang test suite can be run from either Visual Studio or |
| 176 | the command line.</p> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 177 | |
John Thompson | 99ff8da | 2009-11-06 00:06:29 +0000 | [diff] [blame] | 178 | <p>Note that the test runner is based on |
Eli Friedman | d1e1ef3 | 2009-08-03 19:42:28 +0000 | [diff] [blame] | 179 | Python, which must be installed. Find Python at: |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 180 | <a href="http://www.python.org/download/">http://www.python.org/download/</a>. |
Eli Friedman | d1e1ef3 | 2009-08-03 19:42:28 +0000 | [diff] [blame] | 181 | Download the latest stable version (2.6.2 at the time of this writing).</p> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 182 | |
Chris Lattner | 357f7ce | 2009-08-20 06:17:11 +0000 | [diff] [blame] | 183 | <p>The GnuWin32 tools are also necessary for running the tests. |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 184 | Get them from <a href="http://getgnuwin32.sourceforge.net/"> |
NAKAMURA Takumi | da0f45d | 2011-03-18 03:21:44 +0000 | [diff] [blame] | 185 | http://getgnuwin32.sourceforge.net/</a>. |
| 186 | If the environment variable <tt>%PATH%</tt> does not have GnuWin32, |
| 187 | or if other grep(s) supercedes GnuWin32 on <tt>%PATH%,</tt> |
| 188 | you should specify <tt>LLVM_LIT_TOOLS_DIR</tt> |
| 189 | to CMake explicitly.</p> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 190 | |
John Thompson | 99ff8da | 2009-11-06 00:06:29 +0000 | [diff] [blame] | 191 | <p>The cmake build tool is set up to create Visual Studio project files |
| 192 | for running the tests, "clang-test" being the root. Therefore, to |
| 193 | run the test from Visual Studio, right-click the clang-test project |
| 194 | and select "Build".</p> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 195 | |
NAKAMURA Takumi | da0f45d | 2011-03-18 03:21:44 +0000 | [diff] [blame] | 196 | <p> |
| 197 | Please see also |
| 198 | <a href="http://llvm.org/docs/GettingStartedVS.html">Getting Started |
| 199 | with the LLVM System using Microsoft Visual Studio</a> and |
| 200 | <a href="http://llvm.org/docs/CMake.html">Building LLVM with CMake</a>. |
| 201 | </p> |
| 202 | |
Dawn Perchik | 217a345 | 2010-09-03 17:01:13 +0000 | [diff] [blame] | 203 | <!--=====================================================================--> |
| 204 | <h3 id="testingCommands">Testing on the Command Line</h3> |
| 205 | <!--=====================================================================--> |
| 206 | |
Eli Friedman | 275a850 | 2012-04-16 05:04:45 +0000 | [diff] [blame] | 207 | <p>If you want more control over how the tests are run, it may |
| 208 | be convenient to run the test harness on the command-line directly. Before |
| 209 | running tests from the command line, you will need to ensure that |
| 210 | <tt>lit.site.cfg</tt> files have been created for your build. You can do |
| 211 | this by running the tests as described in the previous sections. Once the |
| 212 | tests have started running, you can stop them with control+C, as the |
| 213 | files are generated before running any tests.</p> |
| 214 | |
| 215 | <p>Once that is done, to run all the tests from the command line, |
| 216 | execute a command like the following:</p> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 217 | |
Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 218 | <pre> |
Aaron Ballman | e7d923d | 2012-02-09 15:23:18 +0000 | [diff] [blame] | 219 | python (path to llvm)\llvm\utils\lit\lit.py -sv |
| 220 | --param=build_mode=Win32 --param=build_config=Debug |
| 221 | --param=clang_site_config=(build dir)\tools\clang\test\lit.site.cfg |
| 222 | (path to llvm)\llvm\tools\clang\test |
Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 223 | </pre> |
John Thompson | 99ff8da | 2009-11-06 00:06:29 +0000 | [diff] [blame] | 224 | |
Douglas Gregor | a71ef5d | 2011-01-24 18:04:58 +0000 | [diff] [blame] | 225 | <p>For CMake builds e.g. on Windows with Visual Studio, you will need |
| 226 | to specify your build configuration (Debug, Release, etc.) via |
Aaron Ballman | e7d923d | 2012-02-09 15:23:18 +0000 | [diff] [blame] | 227 | <tt>--param=build_config=(build config)</tt>. You may also need to specify |
| 228 | the build mode (Win32, etc) via <tt>--param=build_mode=(build mode)</tt>.</p> |
| 229 | |
| 230 | <p>Additionally, you will need to specify the lit site configuration which |
| 231 | lives in (build dir)\tools\clang\test, via |
| 232 | <tt>--param=clang_site_config=(build dir)\tools\clang\test\lit.site.cfg</tt>. |
| 233 | </p> |
Douglas Gregor | a71ef5d | 2011-01-24 18:04:58 +0000 | [diff] [blame] | 234 | |
John Thompson | 99ff8da | 2009-11-06 00:06:29 +0000 | [diff] [blame] | 235 | <p>To run a single test:</p> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 236 | |
Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 237 | <pre> |
Aaron Ballman | e7d923d | 2012-02-09 15:23:18 +0000 | [diff] [blame] | 238 | python (path to llvm)\llvm\utils\lit\lit.py -sv |
| 239 | --param=build_mode=Win32 --param=build_config=Debug |
| 240 | --param=clang_site_config=(build dir)\tools\clang\test\lit.site.cfg |
| 241 | (path to llvm)\llvm\tools\clang\test\(dir)\(test) |
Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 242 | </pre> |
John Thompson | 99ff8da | 2009-11-06 00:06:29 +0000 | [diff] [blame] | 243 | |
| 244 | <p>For example:</p> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 245 | |
Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 246 | <pre> |
Aaron Ballman | e7d923d | 2012-02-09 15:23:18 +0000 | [diff] [blame] | 247 | python C:\Tool\llvm\utils\lit\lit.py -sv |
| 248 | --param=build_mode=Win32 --param=build_config=Debug |
| 249 | --param=clang_site_config=c:\Tools\build\tools\clang\test\lit.site.cfg |
| 250 | C:\Tools\llvm\tools\clang\test\Sema\wchar.c |
Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 251 | </pre> |
John Thompson | 99ff8da | 2009-11-06 00:06:29 +0000 | [diff] [blame] | 252 | |
| 253 | <p>The -sv option above tells the runner to show the test output if |
| 254 | any tests failed, to help you determine the cause of failure.</p> |
| 255 | |
Aaron Ballman | e7d923d | 2012-02-09 15:23:18 +0000 | [diff] [blame] | 256 | <p>You can also pass in the --no-progress-bar option if you wish to disable |
| 257 | progress indications while the tests are running.</p> |
| 258 | |
Francois Pichet | b2043d7 | 2010-09-11 21:16:11 +0000 | [diff] [blame] | 259 | <p>Your output might look something like this:</p> |
John Thompson | 99ff8da | 2009-11-06 00:06:29 +0000 | [diff] [blame] | 260 | |
Aaron Ballman | e7d923d | 2012-02-09 15:23:18 +0000 | [diff] [blame] | 261 | <pre>lit.py: lit.cfg:152: note: using clang: 'C:\Tools\llvm\bin\Release\clang.EXE' |
Francois Pichet | b2043d7 | 2010-09-11 21:16:11 +0000 | [diff] [blame] | 262 | -- Testing: Testing: 2534 tests, 4 threads -- |
| 263 | Testing: 0 .. 10.. 20.. 30.. 40.. 50.. 60.. 70.. 80.. 90.. |
| 264 | Testing Time: 81.52s |
| 265 | Expected Passes : 2503 |
| 266 | Expected Failures : 28 |
| 267 | Unsupported Tests : 3 |
Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 268 | </pre> |
John Thompson | 99ff8da | 2009-11-06 00:06:29 +0000 | [diff] [blame] | 269 | |
Francois Pichet | b2043d7 | 2010-09-11 21:16:11 +0000 | [diff] [blame] | 270 | <p>The statistic, "Unexpected Failures" (not shown if all tests pass), is the important one.</p> |
Eli Friedman | d1e1ef3 | 2009-08-03 19:42:28 +0000 | [diff] [blame] | 271 | |
| 272 | <!--=====================================================================--> |
| 273 | <h2 id="patches">Creating Patch Files</h2> |
| 274 | <!--=====================================================================--> |
| 275 | |
| 276 | <p>To return changes to the Clang team, unless you have checkin |
Chris Lattner | fc8f0e1 | 2011-04-15 05:22:18 +0000 | [diff] [blame] | 277 | privileges, the preferred way is to send patch files to the |
Douglas Gregor | 8b06d6b | 2011-11-19 19:14:26 +0000 | [diff] [blame] | 278 | cfe-commits mailing list, with an explanation of what the patch is |
Stephen Hines | c568f1e | 2014-07-21 00:47:37 -0700 | [diff] [blame] | 279 | for. clang follows <a |
| 280 | href="http://llvm.org/docs/DeveloperPolicy.html">LLVM's developer policy</a>. |
| 281 | If your patch requires a wider discussion (for example, because it is an |
| 282 | architectural change), you can use the cfe-dev mailing list.</p> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 283 | |
Eli Friedman | d1e1ef3 | 2009-08-03 19:42:28 +0000 | [diff] [blame] | 284 | <p>To create these patch files, change directory |
| 285 | to the llvm/tools/clang root and run:</p> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 286 | |
Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 287 | <pre>svn diff (relative path) >(patch file name)</pre> |
Eli Friedman | d1e1ef3 | 2009-08-03 19:42:28 +0000 | [diff] [blame] | 288 | |
| 289 | <p>For example, for getting the diffs of all of clang:</p> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 290 | |
Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 291 | <pre>svn diff . >~/mypatchfile.patch</pre> |
Eli Friedman | d1e1ef3 | 2009-08-03 19:42:28 +0000 | [diff] [blame] | 292 | |
| 293 | <p>For example, for getting the diffs of a single file:</p> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 294 | |
Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 295 | <pre>svn diff lib/Parse/ParseDeclCXX.cpp >~/ParseDeclCXX.patch</pre> |
Eli Friedman | d1e1ef3 | 2009-08-03 19:42:28 +0000 | [diff] [blame] | 296 | |
| 297 | <p>Note that the paths embedded in the patch depend on where you run it, |
| 298 | so changing directory to the llvm/tools/clang directory is recommended.</p> |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 299 | |
| 300 | <!--=====================================================================--> |
| 301 | <h2 id="irgen">LLVM IR Generation</h2> |
| 302 | <!--=====================================================================--> |
| 303 | |
| 304 | <p>The LLVM IR generation part of clang handles conversion of the |
| 305 | AST nodes output by the Sema module to the LLVM Intermediate |
| 306 | Representation (IR). Historically, this was referred to as |
| 307 | "codegen", and the Clang code for this lives |
| 308 | in <tt>lib/CodeGen</tt>.</p> |
NAKAMURA Takumi | 6975d07 | 2011-03-18 03:21:38 +0000 | [diff] [blame] | 309 | |
Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 310 | <p>The output is most easily inspected using the <tt>-emit-llvm</tt> |
| 311 | option to clang (possibly in conjunction with <tt>-o -</tt>). You |
| 312 | can also use <tt>-emit-llvm-bc</tt> to write an LLVM bitcode file |
| 313 | which can be processed by the suite of LLVM tools |
| 314 | like <tt>llvm-dis</tt>, <tt>llvm-nm</tt>, etc. See the LLVM |
| 315 | <a href="http://llvm.org/docs/CommandGuide/">Command Guide</a> |
| 316 | for more information.</p> |
| 317 | |
| 318 | </div> |
| 319 | </body> |
| 320 | </html> |