Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / ce2fccffc220b803ed578e2d60c5f2f4a9b4303b / . / llvm / docs / HowToReleaseLLVM.html
blob: 2ea8b431e98aee1f14bd3cd9998c7a36d5d0b4dd [file] [log] [blame]
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
5 <title>How To Release LLVM To The Public</title>
6 <link rel="stylesheet" href="llvm.css" type="text/css">
7</head>
8<body>
9
10<div class="doc_title">How To Release LLVM To The Public</div>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]11<ol>
12 <li><a href="#introduction">Introduction</a></li>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]13 <li><a href="#criteria">Qualification Criteria</a></li>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]14 <li><a href="#introduction">Release Timeline</a></li>
Misha Brukman3df07812006-04-10 21:43:05 +0000[diff] [blame]15 <li><a href="#process">Release Process</a></li>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]16</ol>
17<div class="doc_author">
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]18 <p>Written by <a href="mailto:tonic@nondot.org">Tanya Lattner</a>,
19 <a href="mailto:rspencer@x10sys.com">Reid Spencer</a>,
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]20 <a href="mailto:criswell@cs.uiuc.edu">John Criswell</a>, &amp;
21 <a href="mailto:wendling@apple.com">Bill Wendling</a>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]22 </p>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]23</div>
24
25<!-- *********************************************************************** -->
26<div class="doc_section"><a name="introduction">Introduction</a></div>
27<!-- *********************************************************************** -->
28
29<div class="doc_text">
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]30
31<p>This document contains information about successfully releasing LLVM &mdash;
32 including subprojects: e.g., <tt>llvm-gcc</tt> and <tt>clang</tt> &mdash; to
33 the public. It is the Release Manager's responsibility to ensure that a high
34 quality build of LLVM is released.</p>
35
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]36</div>
37
38<!-- *********************************************************************** -->
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]39<div class="doc_section"><a name="process">Release Timeline</a></div>
40<!-- *********************************************************************** -->
41<div class="doc_text">
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]42
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]43<p>LLVM is released on a time based schedule &mdash; roughly every 6 months. We
44 do not normally have dot releases because of the nature of LLVM's incremental
45 development philosophy. That said, the only thing preventing dot releases for
46 critical bug fixes from happening is a lack of resources &mdash; testers,
47 machines, time, etc. And, because of the high quality we desire for LLVM
48 releases, we cannot allow for a truncated form of release qualification.</p>
49
50<p>The release process is roughly as follows:</p>
51
52<ul>
53 <li><p>Set code freeze and branch creation date for 6 months after last code
54 freeze date. Announce release schedule to the LLVM community and update
55 the website.</p></li>
56
57 <li><p>Create release branch and begin release process.</p></li>
58
59 <li><p>Send out release candidate sources for first round of testing. Testing
60 lasts 7-10 days. During the first round of testing, any regressions found
61 should be fixed. Patches are merged from mainline into the release
62 branch. Also, all features need to be completed during this time. Any
63 features not completed at the end of the first round of testing will be
64 removed or disabled for the release.</p></li>
65
66 <li><p>Generate and send out the second release candidate sources. Only
67 <em>critial</em> bugs found during this testing phase will be fixed. Any
68 bugs introduced by merged patches will be fixed. If so a third round of
69 testing is needed.</p></li>
70
71 <li><p>The release notes are updated.</p></li>
72
73 <li><p>Finally, release!</p></li>
74</ul>
75
76</div>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]77
78<!-- *********************************************************************** -->
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]79<div class="doc_section"><a name="process">Release Process</a></div>
80<!-- *********************************************************************** -->
81
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]82<div class="doc_text">
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]83
84<ol>
85 <li><a href="#release-admin">Release Administrative Tasks</a></li>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]86 <ol>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]87 <li><a href="#branch">Create Release Branch</a></li>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]88 <li><a href="#verchanges">Update Version Numbers</a></li>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]89 </ol>
90 <li><a href="#release-build">Building the Release</a></li>
91 <ol>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]92 <li><a href="#dist">Build the LLVM Source Distributions</a></li>
Misha Brukman3df07812006-04-10 21:43:05 +0000[diff] [blame]93 <li><a href="#build">Build LLVM</a></li>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]94 <li><a href="#llvmgccbin">Build the LLVM-GCC Binary Distribution</a></li>
95 <li><a href="#clangbin">Build the Clang Binary Distribution</a></li>
96 <li><a href="#target-build">Target Specific Build Details</a></li>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]97 </ol>
98 <li><a href="#release-qualify">Release Qualification Criteria</a></li>
99 <ol>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]100 <li><a href="#llvm-qualify">Qualify LLVM</a></li>
101 <li><a href="#llvmgcc-qualify">Qualify LLVM-GCC</a></li>
102 <li><a href="#clang-qualify">Qualify Clang</a></li>
103 <li><a href="#targets">Specific Target Qualification Details</a></li>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]104 </ol>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]105
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]106 <li><a href="#commTest">Community Testing</a></li>
107 <li><a href="#release-patch">Release Patch Rules</a></li>
108 <li><a href="#release-final">Release final tasks</a></li>
109
110 <ol>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]111 <li><a href="#updocs">Update Documentation</a></li>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]112 <li><a href="#tag">Tag the LLVM Final Release</a></li>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]113 <li><a href="#updemo">Update the LLVM Demo Page</a></li>
Tanya Lattnerb3b1dab2006-08-10 00:23:05 +0000[diff] [blame]114 <li><a href="#webupdates">Update the LLVM Website</a></li>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]115 <li><a href="#announce">Announce the Release</a></li>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]116 </ol>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]117</ol>
118
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]119</div>
120
121<!-- ======================================================================= -->
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]122<div class="doc_subsection"><a name="release-admin">Release Administrative Tasks</a></div>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]123
124<div class="doc_text">
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]125
126<p>This section describes a few administrative tasks that need to be done for
127 the release process to begin. Specifically, it involves:</p>
128
129<ul>
130 <li>Creating the release branch,</li>
131 <li>Setting version numbers, and</li>
132 <li>Tagging release candidates for the release team to begin testing</li>
133</ul>
134
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]135</div>
136
137<!-- ======================================================================= -->
138<div class="doc_subsubsection"><a name="branch">Create Release Branch</a></div>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]139
John Criswell4b8dfb92006-04-11 20:24:28 +0000[diff] [blame]140<div class="doc_text">
John Criswell4b8dfb92006-04-11 20:24:28 +0000[diff] [blame]141
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]142<p>Branch the Subversion trunk using the following procedure:</p>
John Criswell4b8dfb92006-04-11 20:24:28 +0000[diff] [blame]143
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]144<ol>
145 <li><p>Remind developers that the release branching is imminent and to refrain
146 from committing patches that might break the build. E.g., new features,
147 large patches for works in progress, an overhaul of the type system, an
148 exciting new TableGen feature, etc.</p></li>
149
150 <li><p>Verify that the current Subversion trunk is in decent shape by
151 examining nightly tester and buildbot results.</p></li>
152
153 <li><p>Create the release branch for <tt>llvm</tt>, <tt>llvm-gcc-4.2</tt>,
154 <tt>clang</tt>, and the <tt>test-suite</tt> from the last known good
155 revision. The branch's name is <tt>release_XY</tt>, where <tt>X</tt> is
156 the major and <tt>Y</tt> the minor release numbers. The branches should be
157 created using the following commands:</p>
158
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]159<div class="doc_code">
160<pre>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]161$ svn copy https://llvm.org/svn/llvm-project/llvm/trunk \
162 https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XY</i>
163
164$ svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.2/trunk \
165 https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_<i>XY</i>
166
167$ svn copy https://llvm.org/svn/llvm-project/test-suite/trunk \
168 https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XY</i>
169
170$ svn copy https://llvm.org/svn/llvm-project/cfe/trunk \
171 https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XY</i>
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]172</pre>
Bill Wendling803a6392007-07-23 04:44:02 +0000[diff] [blame]173</div></li>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]174
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]175 <li><p>Advise developers that they may now check their patches into the
176 Subversion tree again.</p></li>
177
178 <li><p>The Release Manager should switch to the release branch, because all
179 changes to the release will now be done in the branch. The easiest way to
180 do this is to grab a working copy using the following commands:</p>
181
182<div class="doc_code">
183<pre>
184$ svn co https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XY</i> llvm-<i>X.Y</i>
185
186$ svn co https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_<i>XY</i> llvm-gcc-4.2-<i>X.Y</i>
187
188$ svn co https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XY</i> test-suite-<i>X.Y</i>
189
190$ svn co https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XY</i> clang-<i>X.Y</i>
191</pre>
192</div></li>
193</ol>
194
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]195</div>
196
197<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]198<div class="doc_subsubsection"><a name="verchanges">Update LLVM Version</a></div>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]199
Tanya Lattnerb3b1dab2006-08-10 00:23:05 +0000[diff] [blame]200<div class="doc_text">
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]201
202<p>After creating the LLVM release branch, update the release branches'
203 <tt>autoconf</tt> and <tt>configure.ac</tt> versions from '<tt>X.Ysvn</tt>'
204 to '<tt>X.Y</tt>'. Update it on mainline as well to be the next version
205 ('<tt>X.Y+1svn</tt>'). Regenerate the configure scripts for both
206 <tt>llvm</tt> and the <tt>test-suite</tt>.</p>
207
208<p>In addition, the version numbers of all the Bugzilla components must be
209 updated for the next release.</p>
210
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]211</div>
212
213<!-- ======================================================================= -->
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]214<div class="doc_subsubsection"><a name="dist">Build the LLVM Release Candidates</a></div>
215
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]216<div class="doc_text">
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]217
218<p>Create release candidates for <tt>llvm</tt>, <tt>llvm-gcc</tt>,
219 <tt>clang</tt>, and the LLVM <tt>test-suite</tt> by tagging the branch with
220 the respective release candidate number. For instance, to create <b>Release
221 Candidate 1</b> you would issue the following commands:</p>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]222
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]223<div class="doc_code">
224<pre>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]225$ svn mkdir https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XY</i>
226$ svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XY</i> \
Bill Wendling47858852011-03-07 07:37:12 +0000[diff] [blame]227 https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XY</i>/rc1
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]228
229$ svn mkdir https://llvm.org/svn/llvm-project/llvm-gcc-4.2/tags/RELEASE_<i>XY</i>
230$ svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_<i>XY</i> \
Bill Wendling47858852011-03-07 07:37:12 +0000[diff] [blame]231 https://llvm.org/svn/llvm-project/llvm-gcc-4.2/tags/RELEASE_<i>XY</i>/rc1
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]232
233$ svn mkdir https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XY</i>
234$ svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XY</i> \
Bill Wendling47858852011-03-07 07:37:12 +0000[diff] [blame]235 https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XY</i>/rc1
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]236
237$ svn mkdir https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_<i>XY</i>
238$ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XY</i> \
Bill Wendling47858852011-03-07 07:37:12 +0000[diff] [blame]239 https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_<i>XY</i>/rc1
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]240</pre>
241</div>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]242
243<p>Similarly, <b>Release Candidate 2</b> would be named <tt>RC2</tt> and so
244 on. This keeps a permanent copy of the release candidate around for people to
245 export and build as they wish. The final released sources will be tagged in
246 the <tt>RELEASE_<i>XY</i></tt> directory as <tt>Final</tt>
247 (c.f. <a href="#tag">Tag the LLVM Final Release</a>).</p>
248
249<p>The Release Manager may supply pre-packaged source tarballs for users. This
250 can be done with the following commands:</p>
251
252<div class="doc_code">
253<pre>
Bill Wendling47858852011-03-07 07:37:12 +0000[diff] [blame]254$ svn export https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XY</i>/rc1 llvm-<i>X.Y</i>rc1
255$ svn export https://llvm.org/svn/llvm-project/llvm-gcc-4.2/tags/RELEASE_<i>XY</i>/rc1 llvm-gcc4.2-<i>X.Y</i>rc1
256$ svn export https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XY</i>/rc1 llvm-test-<i>X.Y</i>rc1
257$ svn export https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_<i>XY</i>/rc1 clang-<i>X.Y</i>rc1
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]258
Bill Wendlingce2fccf2011-03-25 06:43:59 +0000[diff] [blame^]259$ tar -cvf - llvm-<i>X.Y</i>rc1 | gzip &gt; llvm-<i>X.Y</i>rc1.src.tar.gz
260$ tar -cvf - llvm-test-<i>X.Y</i>rc1 | gzip &gt; llvm-test-<i>X.Y</i>rc1.src.tar.gz
261$ tar -cvf - llvm-gcc4.2-<i>X.Y</i>rc1 | gzip &gt; llvm-gcc-4.2-<i>X.Y</i>rc1.src.tar.gz
262$ tar -cvf - clang-<i>X.Y</i>rc1 | gzip &gt; clang-<i>X.Y</i>rc1.src.tar.gz
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]263</pre>
264</div>
265
Reid Spencer34ddd282006-08-16 00:54:50 +0000[diff] [blame]266</div>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]267
Reid Spencer34ddd282006-08-16 00:54:50 +0000[diff] [blame]268<!-- ======================================================================= -->
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]269<div class="doc_subsection"><a name="release-build">Building the Release</a></div>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]270
271<div class="doc_text">
Tanya Lattner82e57a62009-08-23 04:36:30 +0000[diff] [blame]272
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]273<p>The builds of <tt>llvm</tt>, <tt>llvm-gcc</tt>, and <tt>clang</tt>
274 <em>must</em> be free of errors and warnings in Debug, Release+Asserts, and
275 Release builds. If all builds are clean, then the release passes Build
276 Qualification.</p>
277
278<p>The <tt>make</tt> options for building the different modes:</p>
279
280<table>
281 <tr><th>Mode</th><th>Options</th></tr>
282 <tr align="left"><td>Debug</td><td><tt>ENABLE_OPTIMIZED=0</tt></td></tr>
283 <tr align="left"><td>Release+Asserts</td><td><tt>ENABLE_OPTIMIZED=1</tt></td></tr>
284 <tr align="left"><td>Release</td><td><tt>ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1</tt></td></tr>
285</table>
286
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]287</div>
288
289<!-- ======================================================================= -->
290<div class="doc_subsubsection"><a name="build">Build LLVM</a></div>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]291
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]292<div class="doc_text">
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]293
294<p>Build <tt>Debug</tt>, <tt>Release+Asserts</tt>, and <tt>Release</tt> versions
295 of <tt>llvm</tt> on all supported platforms. Directions to build
296 <tt>llvm</tt> are
297 <a href="http://llvm.org/docs/GettingStarted.html#quickstart">here</a>.</p>
298
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]299</div>
300
301<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]302<div class="doc_subsubsection"><a name="llvmgccbin">Build the LLVM GCC Binary Distribution</a></div>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]303
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]304<div class="doc_text">
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]305
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]306<p>Creating the <tt>llvm-gcc</tt> binary distribution (Release/Optimized)
307 requires performing the following steps for each supported platform:</p>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]308
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]309<ol>
310 <li><p>Build the <tt>llvm-gcc</tt> front-end by following the directions in
311 the <tt>README.LLVM</tt> file. The front-end must be compiled with C, C++,
312 Objective-C (Mac only), Objective-C++ (Mac only), and Fortran
313 support.</p></li>
314
315 <li><p>Boostrapping must be enabled.</p></li>
316
317 <li><p>Be sure to build with <tt>LLVM_VERSION_INFO=X.Y</tt>, where <tt>X</tt>
318 is the major and <tt>Y</tt> is the minor release numbers.</p></li>
319
320 <li><p>Copy the installation directory to a directory named for the specific
321 target. For example on Red Hat Enterprise Linux, the directory would be
322 named <tt>llvm-gcc4.2-2.6-x86-linux-RHEL4</tt>. Archive and compress the
323 new directory.</p></li>
324</ol>
325
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]326</div>
327
328<!-- ======================================================================= -->
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]329<div class="doc_subsubsection"><a name="clangbin">Build Clang Binary Distribution</a></div>
330
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]331<div class="doc_text">
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]332
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]333<p>Creating the <tt>clang</tt> binary distribution
334 (Debug/Release+Asserts/Release) requires performing the following steps for
335 each supported platform:</p>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]336
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]337<ol>
338 <li>Build clang according to the directions
339 <a href="http://clang.llvm.org/get_started.html">here</a>.</li>
340
341 <li>Build both a debug and release version of clang. The binary will be the
342 release build.</lI>
343
344 <li>Package <tt>clang</tt> (details to follow).</li>
345</ol>
346
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]347</div>
348
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]349<!-- ======================================================================= -->
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]350<div class="doc_subsubsection"><a name="target-build">Target Specific Build Details</a></div>
351
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]352<div class="doc_text">
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]353
354<p>The table below specifies which compilers are used for each Arch/OS
355 combination when qualifying the build of <tt>llvm</tt>, <tt>llvm-gcc</tt>,
356 and <tt>clang</tt>.</p>
357
358<table>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame]359 <tr><th>Architecture</th><th>OS</th><th>compiler</th></tr>
360 <tr><td>x86-32</td><td>Mac OS 10.5</td><td>gcc 4.0.1</td></tr>
361 <tr><td>x86-32</td><td>Linux</td><td>gcc 4.2.X, gcc 4.3.X</td></tr>
Tanya Lattner82e57a62009-08-23 04:36:30 +0000[diff] [blame]362 <tr><td>x86-32</td><td>FreeBSD</td><td>gcc 4.2.X</td></tr>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]363 <tr><td>x86-32</td><td>mingw</td><td>gcc 3.4.5</td></tr>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame]364 <tr><td>x86-64</td><td>Mac OS 10.5</td><td>gcc 4.0.1</td></tr>
365 <tr><td>x86-64</td><td>Linux</td><td>gcc 4.2.X, gcc 4.3.X</td></tr>
Tanya Lattner82e57a62009-08-23 04:36:30 +0000[diff] [blame]366 <tr><td>x86-64</td><td>FreeBSD</td><td>gcc 4.2.X</td></tr>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]367</table>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame]368
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]369</div>
370
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]371<!-- ======================================================================= -->
372<div class="doc_subsection"><a name="release-qualify">
373Building the Release</a></div>
374
375<div class="doc_text">
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]376
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]377<p>A release is qualified when it has no regressions from the previous release
378 (or baseline). Regressions are related to correctness first and performance
379 second. (We may tolerate some minor performance regressions if they are
380 deemed necessary for the general quality of the compiler.)</p>
381
382<p><b>Regressions are new failures in the set of tests that are used to qualify
383 each product and only include things on the list. Every release will have
384 some bugs in it. It is the reality of developing a complex piece of
385 software. We need a very concrete and definitive release criteria that
386 ensures we have monotonically improving quality on some metric. The metric we
387 use is described below. This doesn't mean that we don't care about other
388 criteria, but these are the criteria which we found to be most important and
389 which must be satisfied before a release can go out</b></p>
390
391</div>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]392
393<!-- ======================================================================= -->
394<div class="doc_subsubsection"><a name="llvm-qualify">Qualify LLVM</a></div>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]395
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]396<div class="doc_text">
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]397
398<p>LLVM is qualified when it has a clean test run without a front-end. And it
399 has no regressions when using either <tt>llvm-gcc</tt> or <tt>clang</tt> with
400 the <tt>test-suite</tt> from the previous release.</p>
401
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]402</div>
403
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]404<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]405<div class="doc_subsubsection"><a name="llvmgcc-qualify">Qualify LLVM-GCC</a></div>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]406
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]407<div class="doc_text">
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]408
409<p><tt>LLVM-GCC</tt> is qualified when front-end specific tests in the
410 <tt>llvm</tt> regression test suite all pass and there are no regressions in
411 the <tt>test-suite</tt>.</p>
412
413<p>We do not use the GCC DejaGNU test suite as release criteria.</p>
414
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]415</div>
416
417<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]418<div class="doc_subsubsection"><a name="clang-qualify">Qualify Clang</a></div>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]419
Reid Spencer34ddd282006-08-16 00:54:50 +0000[diff] [blame]420<div class="doc_text">
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]421
422<p><tt>Clang</tt> is qualified when front-end specific tests in the
423 <tt>llvm</tt> dejagnu test suite all pass, clang's own test suite passes
424 cleanly, and there are no regressions in the <tt>test-suite</tt>.</p>
425
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]426</div>
427
428<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]429<div class="doc_subsubsection"><a name="targets">Specific Target
430Qualification Details</a></div>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]431
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]432<div class="doc_text">
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]433
434<table>
435 <tr><th>Architecture</th><th>OS</th><th>llvm-gcc baseline</th><th>clang baseline</th><th>tests</th></tr>
Tanya Lattnere30614c2010-04-05 18:35:37 +0000[diff] [blame]436 <tr><td>x86-32</td><td>Linux</td><td>last release</td><td>last release</td><td>llvm dejagnu, clang tests, test-suite (including spec)</td></tr>
437 <tr><td>x86-32</td><td>FreeBSD</td><td>none</td><td>last release</td><td>llvm dejagnu, clang tests, test-suite</td></tr>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame]438 <tr><td>x86-32</td><td>mingw</td><td>last release</td><td>none</td><td>QT</td></tr>
Tanya Lattnere30614c2010-04-05 18:35:37 +0000[diff] [blame]439 <tr><td>x86-64</td><td>Mac OS 10.X</td><td>last release</td><td>last release</td><td>llvm dejagnu, clang tests, test-suite (including spec)</td></tr>
440 <tr><td>x86-64</td><td>Linux</td><td>last release</td><td>last release</td><td>llvm dejagnu, clang tests, test-suite (including spec)</td></tr>
441 <tr><td>x86-64</td><td>FreeBSD</td><td>none</td><td>last release</td><td>llvm dejagnu, clang tests, test-suite</td></tr>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]442</table>
443
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]444</div>
445
446<!-- ======================================================================= -->
447<div class="doc_subsection"><a name="commTest">Community Testing</a></div>
John Criswell4b8dfb92006-04-11 20:24:28 +0000[diff] [blame]448<div class="doc_text">
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]449
450<p>Once all testing has been completed and appropriate bugs filed, the release
451 candidate tarballs are put on the website and the LLVM community is
452 notified. Ask that all LLVM developers test the release in 2 ways:</p>
453
454<ol>
455 <li>Download <tt>llvm-<i>X.Y</i></tt>, <tt>llvm-test-<i>X.Y</i></tt>, and the
456 appropriate <tt>llvm-gcc</tt> and/or <tt>clang</tt> binary. Build
457 LLVM. Run <tt>make check</tt> and the full LLVM test suite (<tt>make
458 TEST=nightly report</tt>).</li>
459
460 <li>Download <tt>llvm-<i>X.Y</i></tt>, <tt>llvm-test-<i>X.Y</i></tt>, and the
461 <tt>llvm-gcc</tt> and/or <tt>clang</tt> source. Compile everything. Run
462 <tt>make check</tt> and the full LLVM test suite (<tt>make TEST=nightly
463 report</tt>).</li>
464</ol>
465
466<p>Ask LLVM developers to submit the test suite report and <tt>make check</tt>
467 results to the list. Verify that there are no regressions from the previous
468 release. The results are not used to qualify a release, but to spot other
469 potential problems. For unsupported targets, verify that <tt>make check</tt>
470 is at least clean.</p>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]471
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]472<p>During the first round of testing, all regressions must be fixed before the
473 second release candidate is tagged.</p>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]474
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]475<p>If this is the second round of testing, the testing is only to ensure that
476 bug fixes previously merged in have not created new major problems. <i>This
477 is not the time to solve additional and unrelated bugs!</i> If no patches are
478 merged in, the release is determined to be ready and the release manager may
479 move onto the next stage.</p>
480
John Criswell4b8dfb92006-04-11 20:24:28 +0000[diff] [blame]481</div>
482
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]483<!-- ======================================================================= -->
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]484<div class="doc_subsection"><a name="release-patch">Release Patch Rules</a></div>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]485
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]486<div class="doc_text">
487
488<p>Below are the rules regarding patching the release branch:</p>
489
490<ol>
491 <li><p>Patches applied to the release branch may only be applied by the
492 release manager.</p></li>
493
494 <li><p>During the first round of testing, patches that fix regressions or that
495 are small and relatively risk free (verified by the appropriate code
496 owner) are applied to the branch. Code owners are asked to be very
497 conservative in approving patches for the branch. We reserve the right to
498 reject any patch that does not fix a regression as previously
499 defined.</p></li>
500
501 <li><p>During the remaining rounds of testing, only patches that fix critical
502 regressions may be applied.</p></li>
503</ol>
504
505</div>
Tanya Lattnerb3b1dab2006-08-10 00:23:05 +0000[diff] [blame]506
507<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]508<div class="doc_subsection"><a name="release-final">Release Final Tasks
509</a></div>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]510
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]511<div class="doc_text">
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]512
513<p>The final stages of the release process involves tagging the "final" release
514 branch, updating documentation that refers to the release, and updating the
515 demo page.</p>
516
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]517</div>
518
519
520<!-- ======================================================================= -->
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame]521<div class="doc_subsubsection"><a name="updocs">Update Documentation</a></div>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]522
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame]523<div class="doc_text">
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]524
525<p>Review the documentation and ensure that it is up to date. The "Release
526 Notes" must be updated to reflect new features, bug fixes, new known issues,
527 and changes in the list of supported platforms. The "Getting Started Guide"
528 should be updated to reflect the new release version number tag avaiable from
529 Subversion and changes in basic system requirements. Merge both changes from
530 mainline into the release branch.</p>
531
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame]532</div>
533
534<!-- ======================================================================= -->
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]535<div class="doc_subsubsection"><a name="tag">Tag the LLVM Final Release</a></div>
536
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]537<div class="doc_text">
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]538
539<p>Tag the final release sources using the following procedure:</p>
540
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]541<div class="doc_code">
542<pre>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]543$ svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_XY \
544 https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XY</i>/Final
545
546$ svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_XY \
547 https://llvm.org/svn/llvm-project/llvm-gcc-4.2/tags/RELEASE_<i>XY</i>/Final
548
549$ svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_XY \
550 https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XY</i>/Final
551
552$ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_XY \
553 https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_<i>XY</i>/Final
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]554</pre>
555</div>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]556
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]557</div>
558
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]559<!-- ======================================================================= -->
560<div class="doc_subsection"><a name="updemo">Update the LLVM Demo Page</a></div>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]561
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]562<div class="doc_text">
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]563
564<p>The LLVM demo page must be updated to use the new release. This consists of
565 using the new <tt>llvm-gcc</tt> binary and building LLVM.</p>
566
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]567</div>
568
569<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]570<div class="doc_subsubsection"><a name="webupdates">Update the LLVM Website</a></div>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]571
Tanya Lattnerb3b1dab2006-08-10 00:23:05 +0000[diff] [blame]572<div class="doc_text">
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]573
574<p>The website must be updated before the release announcement is sent out. Here
575 is what to do:</p>
576
577<ol>
578 <li>Check out the <tt>www</tt> module from Subversion.</li>
579
580 <li>Create a new subdirectory <tt>X.Y</tt> in the releases directory.</li>
581
582 <li>Commit the <tt>llvm</tt>, <tt>test-suite</tt>, <tt>llvm-gcc</tt> source,
583 <tt>clang source</tt>, <tt>clang binaries</tt>, and <tt>llvm-gcc</tt>
584 binaries in this new directory.</li>
585
586 <li>Copy and commit the <tt>llvm/docs</tt> and <tt>LICENSE.txt</tt> files
587 into this new directory. The docs should be built with
588 <tt>BUILD_FOR_WEBSITE=1</tt>.</li>
589
590 <li>Commit the <tt>index.html</tt> to the <tt>release/X.Y</tt> directory to
591 redirect (use from previous release.</li>
592
593 <li>Update the <tt>releases/download.html</tt> file with the new release.</li>
594
595 <li>Update the <tt>releases/index.html</tt> with the new release and link to
596 release documentation.</li>
597
598 <li>Finally, update the main page (<tt>index.html</tt> and sidebar) to point
599 to the new release and release announcement. Make sure this all gets
600 committed back into Subversion.</li>
601</ol>
602
Tanya Lattnerb3b1dab2006-08-10 00:23:05 +0000[diff] [blame]603</div>
604
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]605<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]606<div class="doc_subsubsection"><a name="announce">Announce the Release</a></div>
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]607
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]608<div class="doc_text">
Bill Wendlingb3294fa2011-02-28 01:10:44 +0000[diff] [blame]609
610<p>Have Chris send out the release announcement when everything is finished.</p>
611
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]612</div>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]613
614<!-- *********************************************************************** -->
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]615<hr>
616<address>
617 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman86242e12008-12-11 17:34:48 +0000[diff] [blame]618 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]619 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman21a63702008-12-11 18:23:24 +0000[diff] [blame]620 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]621 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
Misha Brukman21a63702008-12-11 18:23:24 +0000[diff] [blame]622 <br>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]623 Last modified: $Date$
624</address>
625</body>
626</html>