Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / da94af763bf7b1a966d05907fa062bd660cdd90f / . / llvm / docs / HowToReleaseLLVM.html
blob: a5763000e68e0092f0337a2a2aebd864e6cdab10 [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>,
20 <a href="mailto:criswell@cs.uiuc.edu">John Criswell</a>
21 </p>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]22</div>
23
24<!-- *********************************************************************** -->
25<div class="doc_section"><a name="introduction">Introduction</a></div>
26<!-- *********************************************************************** -->
27
28<div class="doc_text">
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]29 <p>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]30 This document collects information about successfully releasing LLVM
31 (including subprojects llvm-gcc and Clang) to the public.
32 It is the release manager's responsibility to ensure that a high quality
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]33 build of LLVM is released.
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]34 </p>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]35</div>
36
37<!-- *********************************************************************** -->
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]38<div class="doc_section"><a name="process">Release Timeline</a></div>
39<!-- *********************************************************************** -->
40<div class="doc_text">
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]41 <p>LLVM is released on a time based schedule (currently every 6 months). We
42 do not have dot releases because of the nature of LLVM incremental
43 developement philosophy. The release schedule is roughly as follows:
44 </p>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]45<ol>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]46<li>Set code freeze and branch creation date for 6 months after last code freeze
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]47date. Announce release schedule to the LLVM community and update the website.</li>
48<li>Create release branch and begin release process. </li>
49<li>Send out pre-release for first round of testing. Testing will last 7-10 days.
50During the first round of testing, regressions should be found and fixed. Patches
51are merged from mainline to the release branch.</li>
52<li>Generate and send out second pre-release. Bugs found during this time will
53not be fixed unless absolutely critical. Bugs introduce by patches merged in
54will be fixed and if so, a 3rd round of testing is needed.</li>
55<li>The release notes should be updated during the first and second round of
56pre-release testing.</li>
57<li>Finally, release!</li>
58</ol>
59</div>
60
61
62<!-- *********************************************************************** -->
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]63<div class="doc_section"><a name="process">Release Process</a></div>
64<!-- *********************************************************************** -->
65
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]66<div class="doc_text">
67 <ol>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]68 <li><a href="#release-admin">Release Administrative Tasks</a></li>
69 <ol>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]70 <li><a href="#branch">Create Release Branch</a></li>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]71 <li><a href="#verchanges">Update Version Numbers</a></li>
72 </ol>
73 <li><a href="#release-build">Building the Release</a></li>
74 <ol>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]75 <li><a href="#dist">Build the LLVM Source Distributions</a></li>
Misha Brukman3df07812006-04-10 21:43:05 +0000[diff] [blame]76 <li><a href="#build">Build LLVM</a></li>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]77 <li><a href="#llvmgccbin">Build the LLVM-GCC Binary Distribution</a></li>
78 <li><a href="#clangbin">Build the Clang Binary Distribution</a></li>
79 <li><a href="#target-build">Target Specific Build Details</a></li>
80 </ol>
81
82 <li><a href="#release-qualify">Release Qualification Criteria</a></li>
83 <ol>
84 <li><a href="#llvm-qualify">Qualify LLVM</a></li>
85 <li><a href="#llvmgcc-qualify">Qualify LLVM-GCC</a></li>
86 <li><a href="#clang-qualify">Qualify Clang</a></li>
87 <li><a href="#targets">Specific Target Qualification Details</a></li>
88 </ol>
89
90 <li><a href="#commTest">Community Testing</a></li>
91 <li><a href="#release-patch">Release Patch Rules</a></li>
92
93
94 <li><a href="#release-final">Release final tasks</a></li>
95 <ol>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]96 <li><a href="#updocs">Update Documentation</a></li>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]97 <li><a href="#tag">Tag the LLVM Release Branch</a></li>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]98 <li><a href="#updemo">Update the LLVM Demo Page</a></li>
Tanya Lattnerb3b1dab2006-08-10 00:23:05 +0000[diff] [blame]99 <li><a href="#webupdates">Update the LLVM Website</a></li>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]100 <li><a href="#announce">Announce the Release</a></li>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]101 </ol>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]102
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]103 </ol>
104</div>
105
106<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]107<div class="doc_subsection"><a name="release-admin">
108Release Administrative Tasks</a></div>
109
110<div class="doc_text">
111This section describes a few administrative tasks that need to be done for the
112release process to begin. Specifically, it involves creating the release branch,
113 resetting version numbers, and creating the release tarballs for the release
114 team to begin testing.
115</div>
116
117<!-- ======================================================================= -->
118<div class="doc_subsubsection"><a name="branch">Create Release Branch</a></div>
John Criswell4b8dfb92006-04-11 20:24:28 +0000[diff] [blame]119<div class="doc_text">
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]120<p>Branch the Subversion HEAD using the following procedure:</p>
John Criswell4b8dfb92006-04-11 20:24:28 +0000[diff] [blame]121 <ol>
122 <li>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]123 <p>Verify that the current Subversion HEAD is in decent shape by examining
124 nightly tester or buildbot results.</p></li>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]125 <li>
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]126 <p>Request all developers to refrain from committing. Offenders get commit
127 rights taken away (temporarily).</p></li>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]128 <li>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]129 <p> Create the release branch for <tt>llvm</tt>, <tt>llvm-gcc4.2</tt>,
130 <tt>clang</tt>, and the <tt>test-suite</tt>. The branch name will be
131 <tt>release_XX</tt>,where <tt>XX</tt> is the major and minor release numbers.
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]132 <tt>Clang</tt> will have a different release number than <tt>llvm</tt>/
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]133 <tt>llvm-gcc4</tt> since its first release was years later
134 (still deciding if this will be true or not). These branches
135 can be created without checking out anything from subversion.
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]136 </p>
137
138 <div class="doc_code">
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]139<pre>
140svn copy https://llvm.org/svn/llvm-project/llvm/trunk \
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]141 https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XX</i>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]142svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.2/trunk \
143 https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_<i>XX</i>
144svn copy https://llvm.org/svn/llvm-project/test-suite/trunk \
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]145 https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XX</i>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]146svn copy https://llvm.org/svn/llvm-project/cfe/trunk \
147 https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XX</i>
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]148</pre>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]149 </div>
John Criswell4b8dfb92006-04-11 20:24:28 +0000[diff] [blame]150
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]151 <li>
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]152 <p>Advise developers they can work on Subversion HEAD again.</p></li>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]153
154 <li>
155 <p>The Release Manager should switch to the release branch (as all changes
156 to the release will now be done in the branch). The easiest way to do this
157 is to grab another working copy using the following commands:</p>
John Criswell4b8dfb92006-04-11 20:24:28 +0000[diff] [blame]158
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]159<div class="doc_code">
160<pre>
161svn co https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XX</i>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]162svn co https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_<i>XX</i>
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]163svn co https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XX</i>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]164svn co https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XX</i>
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]165</pre>
Bill Wendling803a6392007-07-23 04:44:02 +0000[diff] [blame]166</div></li>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]167
Bill Wendling803a6392007-07-23 04:44:02 +0000[diff] [blame]168 </ol>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]169</div>
170
171<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]172<div class="doc_subsubsection"><a name="verchanges">Update LLVM Version</a></div>
Tanya Lattnerb3b1dab2006-08-10 00:23:05 +0000[diff] [blame]173<div class="doc_text">
174 <p>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]175 After creating the LLVM release branch, update the release branches'
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]176 autoconf/configure.ac version from X.Xsvn to just X.X. Update it on mainline
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]177 as well to be the next version (X.X+1svn). Regenerated the configure script
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]178 for both. This must be done for both <tt>llvm</tt> and the
179 <tt>test-suite</tt>.
Tanya Lattnerb3b1dab2006-08-10 00:23:05 +0000[diff] [blame]180 </p>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]181 <p>FIXME: Add a note about <tt>clang</tt>.</p>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]182 <p>In addition, the version number of all the Bugzilla components must be
183 updated for the next release.
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]184 </p>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]185</div>
186
187<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]188<div class="doc_subsubsection"><a name="dist">Build the LLVM Source Distributions</a></div>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]189<div class="doc_text">
John Criswell4b8dfb92006-04-11 20:24:28 +0000[diff] [blame]190 <p>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]191 Create source distributions for <tt>LLVM</tt>, <tt>LLVM-GCC</tt>,
192 <tt>clang</tt>, and the llvm <tt>test-suite</tt> by exporting the source from
193 Subversion and archiving it. This can be done with the following commands:
John Criswell4b8dfb92006-04-11 20:24:28 +0000[diff] [blame]194 </p>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]195
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]196<div class="doc_code">
197<pre>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]198svn export https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XX</i> llvm-X.X
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]199svn export https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_<i>XX</i> llvm-gcc4.2-X.X.source
200svn export https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XX</i> llvm-test-X.X
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]201svn export https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XX</i> clang-X.X
202tar -czvf - llvm-X.X | gzip &gt; llvm-X.X.tar.gz
203tar -czvf - llvm-test-X.X | gzip &gt; llvm-test-X.X.tar.gz
204tar -czvf - llvm-gcc4.2-X.X.source | gzip &gt; llvm-gcc-4.2-X.X.source.tar.gz
205tar -czvf - clang-X.X.source | gzip &gt; clang-X.X.source.tar.gz
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]206</pre>
207</div>
Reid Spencer34ddd282006-08-16 00:54:50 +0000[diff] [blame]208</div>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]209
Reid Spencer34ddd282006-08-16 00:54:50 +0000[diff] [blame]210<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]211<div class="doc_subsection"><a name="release-build">
212Building the Release</a></div>
213
214<div class="doc_text">
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]215The build of <tt>llvm</tt>, <tt>llvm-gcc</tt>, and <tt>clang</tt> must be free
216of errors and warnings in both debug and release modes. If both debug and
217release builds are clean, then the release passes build qualification.
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]218</div>
219
220<!-- ======================================================================= -->
221<div class="doc_subsubsection"><a name="build">Build LLVM</a></div>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]222<div class="doc_text">
223 <p>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]224 Build both debug and release (optimized) versions of LLVM on all supported
225 platforms. Direction to build llvm are
226 <a href="http://llvm.org/docs/GettingStarted.html#quickstart">here</a>.
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]227 </p>
228</div>
229
230<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]231<div class="doc_subsubsection"><a name="llvmgccbin">Build the LLVM GCC Binary Distribution</a></div>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]232<div class="doc_text">
233 <p>
234 Creating the LLVM GCC binary distribution (release/optimized) requires
235 performing the following steps for each supported platform:
236 </p>
237
238 <ol>
239 <li>
240 Build the LLVM GCC front-end by following the directions in the README.LLVM
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]241 file. The frontend must be compiled with c, c++, objc (mac only),
242 objc++ (mac only) and fortran support.
243 Be sure to build with LLVM_VERSION_INFO=X.X, where X is the major and
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]244 minor release numbers.
245 </li>
246
247 <li>
248 Copy the installation directory to a directory named for the specific target.
249 For example on Red Hat Enterprise Linux, the directory would be named
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]250 <tt>llvm-gcc4.2-2.6-x86-linux-RHEL4</tt>. Archive and compress the new directory.
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]251 </li>
252 </ol>
253</div>
254
255<!-- ======================================================================= -->
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]256<div class="doc_subsubsection"><a name="clangbin">Build Clang
257Binary Distribution</a></div>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]258<div class="doc_text">
259 <p>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]260 Creating the Clang binary distribution (release/optimized) requires
261 performing the following steps for each supported platform:
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]262 </p>
263
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]264 <ol>
265 <li>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]266 Build clang according to the directions
267 <a href="http://clang.llvm.org/get_started.html">here</a>.
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]268 </li>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]269
270 <li>Build both a debug and release version of clang, but the binary
271 will be a release build.</lI>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]272
273 <li>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]274 Package clang (details to follow).
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]275 </li>
276 </ol>
277</div>
278
279
280<!-- ======================================================================= -->
281<div class="doc_subsubsection"><a name="target-build">Target Specific Build
282Details</a></div>
283<div class="doc_text">
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]284 <p>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]285 The table below specifies which compilers are used for each arch/os combination
286 when qualifying the build of <tt>llvm</tt>, <tt>llvm-gcc</tt>, <tt>clang.
287 </tt></p>
288
289 <p>
290 <table>
291 <tr><th>Architecture</th><th>OS</th><th>compiler</th></tr>
292 <tr><td>x86-32</td><td>Mac OS 10.5</td><td>gcc 4.0.1</td></tr>
293 <tr><td>x86-32</td><td>Linux</td><td>gcc 4.2.X, gcc 4.3.X</td></tr>
294 <tr><td>x86-32</td><td>FreeBSD</td><td>gcc ?</td></tr>
295 <tr><td>x86-32</td><td>mingw</td><td>gcc ?</td></tr>
296 <tr><td>x86-64</td><td>Mac OS 10.5</td><td>gcc 4.0.1</td></tr>
297 <tr><td>x86-64</td><td>Linux</td><td>gcc 4.2.X, gcc 4.3.X</td></tr>
298 <tr><td>x86-64</td><td>FreeBSD</td><td>gcc?</td></tr>
299
300 </table>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]301 </p>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]302
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]303</div>
304
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]305
306<!-- ======================================================================= -->
307<div class="doc_subsection"><a name="release-qualify">
308Building the Release</a></div>
309
310<div class="doc_text">
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]311 A release is qualified when it has no regressions from the previous
312 release (or baseline). Regressions are related to correctness only and not
313 performance at this time. <b>Regressions are new failures in the set of tests that
314 are used to qualify each product and do not include anything not in the list.</b>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]315</div>
316
317
318<!-- ======================================================================= -->
319<div class="doc_subsubsection"><a name="llvm-qualify">Qualify LLVM</a></div>
320<div class="doc_text">
321 <p>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]322 LLVM is qualified when it has a clean dejagnu test run without a frontend and
323 it has no regressions when using either <tt>llvm-gcc</tt> or <tt>clang</tt>
324 with the <tt>test-suite</tt> from the previous release.
325</p>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]326</div>
327
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]328<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]329<div class="doc_subsubsection"><a name="llvmgcc-qualify">Qualify LLVM-GCC</a></div>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]330<div class="doc_text">
331 <p>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]332 <tt>LLVM-GCC</tt> is qualified when front-end specific tests in the
333 <tt>llvm</tt> dejagnu test suite all pass and there are no regressions in
334 the <tt>test-suite</tt>.</p>
335 <p>We do not use the gcc dejagnu test suite as release criteria.</p>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]336</div>
337
338<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]339<div class="doc_subsubsection"><a name="clang-qualify">Qualify Clang</a></div>
Reid Spencer34ddd282006-08-16 00:54:50 +0000[diff] [blame]340<div class="doc_text">
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]341 <tt>Clang</tt> is qualified when front-end specific tests in the
342 <tt>llvm</tt> dejagnu test suite all pass, clang's own test suite passes
343 cleanly, and there are no regressions in the <tt>test-suite</tt>.</p>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]344</div>
345
346<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]347<div class="doc_subsubsection"><a name="targets">Specific Target
348Qualification Details</a></div>
349<div class="doc_text">
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]350 <p><table>
351 <tr><th>Architecture</th><th>OS</th><th>llvm-gcc baseline</th><th>clang baseline
352 </th><th>tests</th></tr>
353 <tr><td>x86-32</td><td>Mac OS 10.5</td><td>last release</td><td>none</td><td>llvm dejagnu, clang tests, test-suite (including spec)</td></tr>
354 <tr><td>x86-32</td><td>Linux</td><td>last release</td><td>none</td><td>llvm dejagnu, clang tests, test-suite (including spec)</td></tr>
355 <tr><td>x86-32</td><td>FreeBSD</td><td>none</td><td>none</td><td>llvm dejagnu, clang tests, test-suite</td></tr>
356 <tr><td>x86-32</td><td>mingw</td><td>last release</td><td>none</td><td>QT</td></tr>
357 <tr><td>x86-64</td><td>Mac OS 10.5</td><td>last release</td><td>none</td><td>llvm dejagnu, clang tests, test-suite (including spec)</td></tr>
358 <tr><td>x86-64</td><td>Linux</td><td>last release</td><td>none</td><td>llvm dejagnu, clang tests, test-suite (including spec)</td></tr>
359 <tr><td>x86-64</td><td>FreeBSD</td><td>none</td><td>none</td><td>llvm dejagnu, clang tests, test-suite</td></tr>
360 </table></p>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]361</div>
362
363<!-- ======================================================================= -->
364<div class="doc_subsection"><a name="commTest">Community Testing</a></div>
John Criswell4b8dfb92006-04-11 20:24:28 +0000[diff] [blame]365<div class="doc_text">
366 <p>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]367 Once all testing has been completed and appropriate bugs filed, the pre-release
368 tar balls may be put on the website and the LLVM community is notified. Ask that
369 all LLVM developers test the release in 2 ways:</p>
John Criswell4b8dfb92006-04-11 20:24:28 +0000[diff] [blame]370 <ol>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]371 <li>Download llvm-X.X, llvm-test-X.X, and the appropriate llvm-gcc4
372 and/or clang binary. Build LLVM.
373 Run "make check" and the full llvm-test suite (make TEST=nightly report).</li>
374 <li>Download llvm-X.X, llvm-test-X.X, and the llvm-gcc4 and/or clang source.
375 Compile everything. Run "make check" and the full llvm-test suite (make TEST=nightly
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]376 report).</li>
John Criswell4b8dfb92006-04-11 20:24:28 +0000[diff] [blame]377 </ol>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]378 <p>Ask LLVM developers to submit the report and make check results to the list.
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]379 Attempt to verify that there are no regressions from the previous release.
380 The results are not used to qualify a release, but to spot other potential
381 problems. For unsupported targets, verify that make check at least is
382 clean.</p>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]383
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]384 <p>During the first round of testing time,
385 all regressions must be fixed before the second pre-release is created.</p>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]386
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]387 <p>If this is the second round of testing, this is only to ensure the bug
388 fixes previously merged in have not created new major problems. This is not
389 the time to solve additional and unrelated bugs. If no patches are merged in,
390 the release is determined to be ready and the release manager may move onto
391 the next step.
392 </p>
John Criswell4b8dfb92006-04-11 20:24:28 +0000[diff] [blame]393</div>
394
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]395<!-- ======================================================================= -->
396<div class="doc_subsection"><a name="release-patch">Release Patch Rules
397</a></div>
398<div class="doc_text">
399 <p>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]400 Below are the rules regarding patching the release branch.</p>
401 <p>
402 <li>Patches applied to the release branch are only applied by the release
403 manager.</li>
404 <li>During the first round of testing, patches that fix regressions or that
405 are small and relatively risk free (verified by the appropriate code owner)
406 are applied to the branch. Code owners are asked to be very conservative in
407 approving patches for the branch and we reserve the right to reject any patch
408 that does not fix a regression as previously defined.</li>
409 <li>During the remaining rounds of testing, only patches that fix regressions
410 may be applied.</li>
411
412 </p>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]413</div>
414
Tanya Lattnerb3b1dab2006-08-10 00:23:05 +0000[diff] [blame]415
416<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]417<div class="doc_subsection"><a name="release-final">Release Final Tasks
418</a></div>
419<div class="doc_text">
420 <p>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]421 The final stages of the release process involving taging the release branch,
422 updating documentation that refers to the release, and updating the demo
423 page.</p>
424 <p>FIXME: Add a note if anything needs to be done to the clang website.
425 Eventually the websites will be merged hopefully.</p>
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]426</div>
427
428
429<!-- ======================================================================= -->
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]430<div class="doc_subsubsection"><a name="updocs">Update Documentation</a></div>
431<div class="doc_text">
432 <p>
433 Review the documentation and ensure that it is up to date. The Release Notes
434 must be updated to reflect bug fixes, new known issues, and changes in the
435 list of supported platforms. The Getting Started Guide should be updated to
436 reflect the new release version number tag avaiable from Subversion and
437 changes in basic system requirements. Merge both changes from mainline into
438 the release branch.
439 </p>
440</div>
441
442<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]443<div class="doc_subsubsection"><a name="tag">Tag the Release Branch</a></div>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]444<div class="doc_text">
445 <p>Tag the release branch using the following procedure:</p>
446<div class="doc_code">
447<pre>
448svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_XX \
449 https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XX</i>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]450svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_XX \
451 https://llvm.org/svn/llvm-project/llvm-gcc-4.2/tags/RELEASE_<i>XX</i>
452svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_XX \
453 https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XX</i>
454</pre>
455</div>
456</div>
457
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]458
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]459
460<!-- ======================================================================= -->
461<div class="doc_subsection"><a name="updemo">Update the LLVM Demo Page</a></div>
462<div class="doc_text">
463 <p>
464 The LLVM demo page must be updated to use the new release. This consists of
465 using the llvm-gcc binary and building LLVM. Update the website demo page
466 configuration to use the new release.</p>
467</div>
468
469<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]470<div class="doc_subsubsection"><a name="webupdates">Update the LLVM Website</a></div>
Tanya Lattnerb3b1dab2006-08-10 00:23:05 +0000[diff] [blame]471<div class="doc_text">
472 <p>
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]473 The website must be updated before the release announcement is sent out. Here is
474 what to do:</p>
475 <ol>
476 <li> Check out the <tt>website</tt> module from CVS. </li>
477 <li> Create a new subdirectory X.X in the releases directory. </li>
Tanya Lattnerda94af72009-08-19 23:07:37 +0000[diff] [blame^]478 <li> Commit the <tt>llvm</tt>, <tt>test-suite</tt>, <tt>llvm-gcc</tt> source,
479 <tt>clang source</tt>, <tt>clang binaries</tt>,
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]480 and <tt>llvm-gcc</tt> binaries in this new directory. </li>
481 <li> Copy and commit the <tt>llvm/docs</tt> and <tt>LICENSE.txt</tt>
482 files into this new directory. The docs should be built with BUILD_FOR_WEBSITE=1.</li>
483 <li> Commit the index.html to the release/X.X directory to redirect (use from previous
484 release. </li>
485 <li> Update the <tt>releases/download.html</tt> file with the new release. </li>
486 <li>Update the <tt>releases/index.html</tt> with the new release and link to
487 release documentation.</li>
488 <li> Finally, update the main page (<tt>index.html</tt> and sidebar) to
Bill Wendling922169c2007-07-23 04:41:42 +0000[diff] [blame]489 point to the new release and release announcement. Make sure this all gets
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]490 commited back into Subversion.</li>
491 </ol>
Tanya Lattnerb3b1dab2006-08-10 00:23:05 +0000[diff] [blame]492</div>
493
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]494<!-- ======================================================================= -->
Tanya Lattner7fb16162009-08-18 22:33:28 +0000[diff] [blame]495<div class="doc_subsubsection"><a name="announce">Announce the Release</a></div>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]496<div class="doc_text">
Tanya Lattner586eb8e2007-09-28 22:50:54 +0000[diff] [blame]497 <p>Have Chris send out the release announcement when everything is finished.</p>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]498</div>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]499
500<!-- *********************************************************************** -->
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]501<hr>
502<address>
503 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman86242e12008-12-11 17:34:48 +0000[diff] [blame]504 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]505 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman21a63702008-12-11 18:23:24 +0000[diff] [blame]506 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]507 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
Misha Brukman21a63702008-12-11 18:23:24 +0000[diff] [blame]508 <br>
Reid Spencerab926de2006-03-23 06:45:42 +0000[diff] [blame]509 Last modified: $Date$
510</address>
511</body>
512</html>