Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / c500566d9fb70472a17f62b4cf1689062c52e095 / . / docs / HowToReleaseLLVM.html
blob: 7f18440504bd5f2eac8476194ae191ad1c16c648 [file] [log] [blame]
Reid Spencercf427e82006-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 Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]11<ol>
12 <li><a href="#introduction">Introduction</a></li>
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]13 <li><a href="#criteria">Qualification Criteria</a></li>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]14 <li><a href="#introduction">Release Timeline</a></li>
Misha Brukman8ebd7f92006-04-10 21:43:05 +0000[diff] [blame]15 <li><a href="#process">Release Process</a></li>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]16</ol>
17<div class="doc_author">
Tanya Lattner4b9e1d22009-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 Spencercf427e82006-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 Wendling462fc8a2007-07-23 04:41:42 +0000[diff] [blame]29 <p>
Tanya Lattner4b9e1d22009-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 Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]33 build of LLVM is released.
Bill Wendling462fc8a2007-07-23 04:41:42 +0000[diff] [blame]34 </p>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]35</div>
36
37<!-- *********************************************************************** -->
Tanya Lattner76385652007-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 Lattner4b9e1d22009-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
Benjamin Kramer8040cd32009-10-12 14:46:08 +0000[diff] [blame]43 development philosophy. The release schedule is roughly as follows:
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]44 </p>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]45<ol>
Tanya Lattner4b9e1d22009-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 Lattner76385652007-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 Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]63<div class="doc_section"><a name="process">Release Process</a></div>
64<!-- *********************************************************************** -->
65
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]66<div class="doc_text">
67 <ol>
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]68 <li><a href="#release-admin">Release Administrative Tasks</a></li>
69 <ol>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]70 <li><a href="#branch">Create Release Branch</a></li>
Tanya Lattner4b9e1d22009-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 Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]75 <li><a href="#dist">Build the LLVM Source Distributions</a></li>
Misha Brukman8ebd7f92006-04-10 21:43:05 +0000[diff] [blame]76 <li><a href="#build">Build LLVM</a></li>
Tanya Lattner4b9e1d22009-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 Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]96 <li><a href="#updocs">Update Documentation</a></li>
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]97 <li><a href="#tag">Tag the LLVM Release Branch</a></li>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]98 <li><a href="#updemo">Update the LLVM Demo Page</a></li>
Tanya Lattner9ceece52006-08-10 00:23:05 +0000[diff] [blame]99 <li><a href="#webupdates">Update the LLVM Website</a></li>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]100 <li><a href="#announce">Announce the Release</a></li>
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]101 </ol>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]102
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]103 </ol>
104</div>
105
106<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-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 Criswellfe48c802006-04-11 20:24:28 +0000[diff] [blame]119<div class="doc_text">
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]120<p>Branch the Subversion HEAD using the following procedure:</p>
John Criswellfe48c802006-04-11 20:24:28 +0000[diff] [blame]121 <ol>
122 <li>
Tanya Lattner4b9e1d22009-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 Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]125 <li>
Bill Wendling462fc8a2007-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 Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]128 <li>
Tanya Lattner4b9e1d22009-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 Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]132 <tt>Clang</tt> will have a different release number than <tt>llvm</tt>/
Tanya Lattner4b9e1d22009-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 Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]136 </p>
137
138 <div class="doc_code">
Bill Wendling462fc8a2007-07-23 04:41:42 +0000[diff] [blame]139<pre>
140svn copy https://llvm.org/svn/llvm-project/llvm/trunk \
Bill Wendling462fc8a2007-07-23 04:41:42 +0000[diff] [blame]141 https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XX</i>
Tanya Lattner76385652007-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 Wendling462fc8a2007-07-23 04:41:42 +0000[diff] [blame]145 https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XX</i>
Tanya Lattner4b9e1d22009-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 Wendling462fc8a2007-07-23 04:41:42 +0000[diff] [blame]148</pre>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]149 </div>
John Criswellfe48c802006-04-11 20:24:28 +0000[diff] [blame]150
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]151 <li>
Bill Wendling462fc8a2007-07-23 04:41:42 +0000[diff] [blame]152 <p>Advise developers they can work on Subversion HEAD again.</p></li>
Tanya Lattner76385652007-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 Criswellfe48c802006-04-11 20:24:28 +0000[diff] [blame]158
Bill Wendling462fc8a2007-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 Lattner76385652007-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 Wendling462fc8a2007-07-23 04:41:42 +0000[diff] [blame]163svn co https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XX</i>
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]164svn co https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XX</i>
Bill Wendling462fc8a2007-07-23 04:41:42 +0000[diff] [blame]165</pre>
Bill Wendlingd4fb7932007-07-23 04:44:02 +0000[diff] [blame]166</div></li>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]167
Bill Wendlingd4fb7932007-07-23 04:44:02 +0000[diff] [blame]168 </ol>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]169</div>
170
171<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]172<div class="doc_subsubsection"><a name="verchanges">Update LLVM Version</a></div>
Tanya Lattner9ceece52006-08-10 00:23:05 +0000[diff] [blame]173<div class="doc_text">
174 <p>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]175 After creating the LLVM release branch, update the release branches'
Bill Wendling462fc8a2007-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 Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]177 as well to be the next version (X.X+1svn). Regenerated the configure script
Tanya Lattner49b91862009-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 Lattner9ceece52006-08-10 00:23:05 +0000[diff] [blame]180 </p>
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]181 <p>FIXME: Add a note about <tt>clang</tt>.</p>
Tanya Lattner76385652007-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 Wendling462fc8a2007-07-23 04:41:42 +0000[diff] [blame]184 </p>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]185</div>
186
187<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]188<div class="doc_subsubsection"><a name="dist">Build the LLVM Source Distributions</a></div>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]189<div class="doc_text">
John Criswellfe48c802006-04-11 20:24:28 +0000[diff] [blame]190 <p>
Tanya Lattner49b91862009-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 Criswellfe48c802006-04-11 20:24:28 +0000[diff] [blame]194 </p>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]195
Bill Wendling462fc8a2007-07-23 04:41:42 +0000[diff] [blame]196<div class="doc_code">
197<pre>
Tanya Lattner76385652007-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 Lattner76385652007-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 Lattner4b9e1d22009-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
Tanya Lattner405ce8d2009-08-23 04:36:30 +0000[diff] [blame]205tar -czvf - clang-X.X | gzip &gt; clang-X.X.tar.gz
Bill Wendling462fc8a2007-07-23 04:41:42 +0000[diff] [blame]206</pre>
207</div>
Reid Spencer103febe2006-08-16 00:54:50 +0000[diff] [blame]208</div>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]209
Reid Spencer103febe2006-08-16 00:54:50 +0000[diff] [blame]210<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-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 Lattner49b91862009-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
Tanya Lattner405ce8d2009-08-23 04:36:30 +0000[diff] [blame]216of errors and warnings in both debug, release, and release-asserts builds.
217If all builds are clean, then the release passes build qualification.
218
219<ol>
220<li>debug: ENABLE_OPTIMIZED=0</li>
221<li>release: ENABLE_OPTIMIZED=1</li>
222<li>release-asserts: ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1</li>
223</ol>
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]224</div>
225
226<!-- ======================================================================= -->
227<div class="doc_subsubsection"><a name="build">Build LLVM</a></div>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]228<div class="doc_text">
229 <p>
Tanya Lattner405ce8d2009-08-23 04:36:30 +0000[diff] [blame]230 Build both debug, release (optimized), and release-asserts versions of
231 LLVM on all supported platforms. Direction to build llvm are
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]232 <a href="http://llvm.org/docs/GettingStarted.html#quickstart">here</a>.
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]233 </p>
234</div>
235
236<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]237<div class="doc_subsubsection"><a name="llvmgccbin">Build the LLVM GCC Binary Distribution</a></div>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]238<div class="doc_text">
239 <p>
240 Creating the LLVM GCC binary distribution (release/optimized) requires
241 performing the following steps for each supported platform:
242 </p>
243
244 <ol>
245 <li>
246 Build the LLVM GCC front-end by following the directions in the README.LLVM
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]247 file. The frontend must be compiled with c, c++, objc (mac only),
Tanya Lattner405ce8d2009-08-23 04:36:30 +0000[diff] [blame]248 objc++ (mac only) and fortran support. </li>
249 <li>Please boostrap as well.</li>
250 <li>Be sure to build with LLVM_VERSION_INFO=X.X, where X is the major and
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]251 minor release numbers.
252 </li>
253
254 <li>
255 Copy the installation directory to a directory named for the specific target.
256 For example on Red Hat Enterprise Linux, the directory would be named
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]257 <tt>llvm-gcc4.2-2.6-x86-linux-RHEL4</tt>. Archive and compress the new directory.
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]258 </li>
259 </ol>
260</div>
261
262<!-- ======================================================================= -->
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]263<div class="doc_subsubsection"><a name="clangbin">Build Clang
264Binary Distribution</a></div>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]265<div class="doc_text">
266 <p>
Tanya Lattner405ce8d2009-08-23 04:36:30 +0000[diff] [blame]267 Creating the Clang binary distribution (debug/release/release-asserts) requires
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]268 performing the following steps for each supported platform:
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]269 </p>
270
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]271 <ol>
272 <li>
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]273 Build clang according to the directions
274 <a href="http://clang.llvm.org/get_started.html">here</a>.
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]275 </li>
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]276
277 <li>Build both a debug and release version of clang, but the binary
278 will be a release build.</lI>
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]279
280 <li>
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]281 Package clang (details to follow).
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]282 </li>
283 </ol>
284</div>
285
286
287<!-- ======================================================================= -->
288<div class="doc_subsubsection"><a name="target-build">Target Specific Build
289Details</a></div>
290<div class="doc_text">
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]291 <p>
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]292 The table below specifies which compilers are used for each arch/os combination
293 when qualifying the build of <tt>llvm</tt>, <tt>llvm-gcc</tt>, <tt>clang.
294 </tt></p>
295
296 <p>
297 <table>
298 <tr><th>Architecture</th><th>OS</th><th>compiler</th></tr>
299 <tr><td>x86-32</td><td>Mac OS 10.5</td><td>gcc 4.0.1</td></tr>
300 <tr><td>x86-32</td><td>Linux</td><td>gcc 4.2.X, gcc 4.3.X</td></tr>
Tanya Lattner405ce8d2009-08-23 04:36:30 +0000[diff] [blame]301 <tr><td>x86-32</td><td>FreeBSD</td><td>gcc 4.2.X</td></tr>
302 <tr><td>x86-32</td><td>mingw</td><td>gcc 3.4.5</td></tr>
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]303 <tr><td>x86-64</td><td>Mac OS 10.5</td><td>gcc 4.0.1</td></tr>
304 <tr><td>x86-64</td><td>Linux</td><td>gcc 4.2.X, gcc 4.3.X</td></tr>
Tanya Lattner405ce8d2009-08-23 04:36:30 +0000[diff] [blame]305 <tr><td>x86-64</td><td>FreeBSD</td><td>gcc 4.2.X</td></tr>
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]306
307 </table>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]308 </p>
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]309
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]310</div>
311
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]312
313<!-- ======================================================================= -->
314<div class="doc_subsection"><a name="release-qualify">
315Building the Release</a></div>
316
317<div class="doc_text">
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]318 A release is qualified when it has no regressions from the previous
319 release (or baseline). Regressions are related to correctness only and not
320 performance at this time. <b>Regressions are new failures in the set of tests that
Tanya Lattner405ce8d2009-08-23 04:36:30 +0000[diff] [blame]321 are used to qualify each product and only include things on the list.
322 Ultimately, there is no end to the number of possible bugs in a release. We
323 need a very concrete and definitive release criteria that ensures we have
324 monotonically improving quality on some metric. The metric we use is
325 described below. This doesn't mean that we don't care about other things,
326 but this are things that must be satisfied before a release can go out</b>
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]327</div>
328
329
330<!-- ======================================================================= -->
331<div class="doc_subsubsection"><a name="llvm-qualify">Qualify LLVM</a></div>
332<div class="doc_text">
333 <p>
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]334 LLVM is qualified when it has a clean dejagnu test run without a frontend and
335 it has no regressions when using either <tt>llvm-gcc</tt> or <tt>clang</tt>
336 with the <tt>test-suite</tt> from the previous release.
337</p>
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]338</div>
339
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]340<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]341<div class="doc_subsubsection"><a name="llvmgcc-qualify">Qualify LLVM-GCC</a></div>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]342<div class="doc_text">
343 <p>
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]344 <tt>LLVM-GCC</tt> is qualified when front-end specific tests in the
345 <tt>llvm</tt> dejagnu test suite all pass and there are no regressions in
346 the <tt>test-suite</tt>.</p>
347 <p>We do not use the gcc dejagnu test suite as release criteria.</p>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]348</div>
349
350<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]351<div class="doc_subsubsection"><a name="clang-qualify">Qualify Clang</a></div>
Reid Spencer103febe2006-08-16 00:54:50 +0000[diff] [blame]352<div class="doc_text">
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]353 <tt>Clang</tt> is qualified when front-end specific tests in the
354 <tt>llvm</tt> dejagnu test suite all pass, clang's own test suite passes
355 cleanly, and there are no regressions in the <tt>test-suite</tt>.</p>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]356</div>
357
358<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]359<div class="doc_subsubsection"><a name="targets">Specific Target
360Qualification Details</a></div>
361<div class="doc_text">
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]362 <p><table>
363 <tr><th>Architecture</th><th>OS</th><th>llvm-gcc baseline</th><th>clang baseline
364 </th><th>tests</th></tr>
365 <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>
366 <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>
367 <tr><td>x86-32</td><td>FreeBSD</td><td>none</td><td>none</td><td>llvm dejagnu, clang tests, test-suite</td></tr>
368 <tr><td>x86-32</td><td>mingw</td><td>last release</td><td>none</td><td>QT</td></tr>
369 <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>
370 <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>
371 <tr><td>x86-64</td><td>FreeBSD</td><td>none</td><td>none</td><td>llvm dejagnu, clang tests, test-suite</td></tr>
372 </table></p>
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]373</div>
374
375<!-- ======================================================================= -->
376<div class="doc_subsection"><a name="commTest">Community Testing</a></div>
John Criswellfe48c802006-04-11 20:24:28 +0000[diff] [blame]377<div class="doc_text">
378 <p>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]379 Once all testing has been completed and appropriate bugs filed, the pre-release
380 tar balls may be put on the website and the LLVM community is notified. Ask that
381 all LLVM developers test the release in 2 ways:</p>
John Criswellfe48c802006-04-11 20:24:28 +0000[diff] [blame]382 <ol>
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]383 <li>Download llvm-X.X, llvm-test-X.X, and the appropriate llvm-gcc4
384 and/or clang binary. Build LLVM.
385 Run "make check" and the full llvm-test suite (make TEST=nightly report).</li>
386 <li>Download llvm-X.X, llvm-test-X.X, and the llvm-gcc4 and/or clang source.
387 Compile everything. Run "make check" and the full llvm-test suite (make TEST=nightly
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]388 report).</li>
John Criswellfe48c802006-04-11 20:24:28 +0000[diff] [blame]389 </ol>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]390 <p>Ask LLVM developers to submit the report and make check results to the list.
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]391 Attempt to verify that there are no regressions from the previous release.
392 The results are not used to qualify a release, but to spot other potential
393 problems. For unsupported targets, verify that make check at least is
394 clean.</p>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]395
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]396 <p>During the first round of testing time,
397 all regressions must be fixed before the second pre-release is created.</p>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]398
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]399 <p>If this is the second round of testing, this is only to ensure the bug
400 fixes previously merged in have not created new major problems. This is not
401 the time to solve additional and unrelated bugs. If no patches are merged in,
402 the release is determined to be ready and the release manager may move onto
403 the next step.
404 </p>
John Criswellfe48c802006-04-11 20:24:28 +0000[diff] [blame]405</div>
406
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]407<!-- ======================================================================= -->
408<div class="doc_subsection"><a name="release-patch">Release Patch Rules
409</a></div>
410<div class="doc_text">
411 <p>
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]412 Below are the rules regarding patching the release branch.</p>
413 <p>
414 <li>Patches applied to the release branch are only applied by the release
415 manager.</li>
416 <li>During the first round of testing, patches that fix regressions or that
417 are small and relatively risk free (verified by the appropriate code owner)
418 are applied to the branch. Code owners are asked to be very conservative in
419 approving patches for the branch and we reserve the right to reject any patch
420 that does not fix a regression as previously defined.</li>
421 <li>During the remaining rounds of testing, only patches that fix regressions
422 may be applied.</li>
423
424 </p>
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]425</div>
426
Tanya Lattner9ceece52006-08-10 00:23:05 +0000[diff] [blame]427
428<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]429<div class="doc_subsection"><a name="release-final">Release Final Tasks
430</a></div>
431<div class="doc_text">
432 <p>
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]433 The final stages of the release process involving taging the release branch,
434 updating documentation that refers to the release, and updating the demo
435 page.</p>
436 <p>FIXME: Add a note if anything needs to be done to the clang website.
437 Eventually the websites will be merged hopefully.</p>
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]438</div>
439
440
441<!-- ======================================================================= -->
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]442<div class="doc_subsubsection"><a name="updocs">Update Documentation</a></div>
443<div class="doc_text">
444 <p>
445 Review the documentation and ensure that it is up to date. The Release Notes
446 must be updated to reflect bug fixes, new known issues, and changes in the
447 list of supported platforms. The Getting Started Guide should be updated to
448 reflect the new release version number tag avaiable from Subversion and
449 changes in basic system requirements. Merge both changes from mainline into
450 the release branch.
451 </p>
452</div>
453
454<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]455<div class="doc_subsubsection"><a name="tag">Tag the Release Branch</a></div>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]456<div class="doc_text">
457 <p>Tag the release branch using the following procedure:</p>
458<div class="doc_code">
459<pre>
460svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_XX \
461 https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XX</i>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]462svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_XX \
463 https://llvm.org/svn/llvm-project/llvm-gcc-4.2/tags/RELEASE_<i>XX</i>
464svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_XX \
465 https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XX</i>
466</pre>
467</div>
468</div>
469
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]470
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]471
472<!-- ======================================================================= -->
473<div class="doc_subsection"><a name="updemo">Update the LLVM Demo Page</a></div>
474<div class="doc_text">
475 <p>
476 The LLVM demo page must be updated to use the new release. This consists of
477 using the llvm-gcc binary and building LLVM. Update the website demo page
478 configuration to use the new release.</p>
479</div>
480
481<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]482<div class="doc_subsubsection"><a name="webupdates">Update the LLVM Website</a></div>
Tanya Lattner9ceece52006-08-10 00:23:05 +0000[diff] [blame]483<div class="doc_text">
484 <p>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]485 The website must be updated before the release announcement is sent out. Here is
486 what to do:</p>
487 <ol>
488 <li> Check out the <tt>website</tt> module from CVS. </li>
489 <li> Create a new subdirectory X.X in the releases directory. </li>
Tanya Lattner49b91862009-08-19 23:07:37 +0000[diff] [blame]490 <li> Commit the <tt>llvm</tt>, <tt>test-suite</tt>, <tt>llvm-gcc</tt> source,
491 <tt>clang source</tt>, <tt>clang binaries</tt>,
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]492 and <tt>llvm-gcc</tt> binaries in this new directory. </li>
493 <li> Copy and commit the <tt>llvm/docs</tt> and <tt>LICENSE.txt</tt>
494 files into this new directory. The docs should be built with BUILD_FOR_WEBSITE=1.</li>
495 <li> Commit the index.html to the release/X.X directory to redirect (use from previous
496 release. </li>
497 <li> Update the <tt>releases/download.html</tt> file with the new release. </li>
498 <li>Update the <tt>releases/index.html</tt> with the new release and link to
499 release documentation.</li>
500 <li> Finally, update the main page (<tt>index.html</tt> and sidebar) to
Bill Wendling462fc8a2007-07-23 04:41:42 +0000[diff] [blame]501 point to the new release and release announcement. Make sure this all gets
Benjamin Kramer8040cd32009-10-12 14:46:08 +0000[diff] [blame]502 committed back into Subversion.</li>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]503 </ol>
Tanya Lattner9ceece52006-08-10 00:23:05 +0000[diff] [blame]504</div>
505
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]506<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame]507<div class="doc_subsubsection"><a name="announce">Announce the Release</a></div>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]508<div class="doc_text">
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]509 <p>Have Chris send out the release announcement when everything is finished.</p>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]510</div>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]511
512<!-- *********************************************************************** -->
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]513<hr>
514<address>
515 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000[diff] [blame]516 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]517 <a href="http://validator.w3.org/check/referer"><img
Misha Brukmanf00ddb02008-12-11 18:23:24 +0000[diff] [blame]518 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]519 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
Misha Brukmanf00ddb02008-12-11 18:23:24 +0000[diff] [blame]520 <br>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]521 Last modified: $Date$
522</address>
523</body>
524</html>