Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 4b9e1d291c83a35b08253d88861e736b2a6b45c8 / . / docs / HowToReleaseLLVM.html
blob: 0fd5903a10ad239ea4b20f40493b16fbc11fd167 [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
43 developement philosophy. The release schedule is roughly as follows:
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="#tag">Tag the LLVM Release Branch</a></li>
97 <li><a href="#updocs">Update Documentation</a></li>
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.
132 Clang will have a different release number than <tt>llvm</tt>/
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
178 for both. This must be done for both llvm and the test-suite.
Tanya Lattner9ceece52006-08-10 00:23:05 +0000[diff] [blame]179 </p>
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]180 <p>FIXME: Add a note about clang.</p>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]181 <p>In addition, the version number of all the Bugzilla components must be
182 updated for the next release.
Bill Wendling462fc8a2007-07-23 04:41:42 +0000[diff] [blame]183 </p>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]184</div>
185
186<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]187<div class="doc_subsubsection"><a name="dist">Build the LLVM Source Distributions</a></div>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]188<div class="doc_text">
John Criswellfe48c802006-04-11 20:24:28 +0000[diff] [blame]189 <p>
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]190 Create source distributions for LLVM, LLVM GCC, Clang, and the LLVM Test
191 Suite by exporting the source from Subversion and archiving it. This can be
192 done with the following commands:
John Criswellfe48c802006-04-11 20:24:28 +0000[diff] [blame]193 </p>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]194
Bill Wendling462fc8a2007-07-23 04:41:42 +0000[diff] [blame]195<div class="doc_code">
196<pre>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]197svn 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]198svn export https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_<i>XX</i> llvm-gcc4.2-X.X.source
199svn 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^]200svn export https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XX</i> clang-X.X
201tar -czvf - llvm-X.X | gzip &gt; llvm-X.X.tar.gz
202tar -czvf - llvm-test-X.X | gzip &gt; llvm-test-X.X.tar.gz
203tar -czvf - llvm-gcc4.2-X.X.source | gzip &gt; llvm-gcc-4.2-X.X.source.tar.gz
204tar -czvf - clang-X.X.source | gzip &gt; clang-X.X.source.tar.gz
Bill Wendling462fc8a2007-07-23 04:41:42 +0000[diff] [blame]205</pre>
206</div>
Reid Spencer103febe2006-08-16 00:54:50 +0000[diff] [blame]207</div>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]208
Reid Spencer103febe2006-08-16 00:54:50 +0000[diff] [blame]209<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]210<div class="doc_subsection"><a name="release-build">
211Building the Release</a></div>
212
213<div class="doc_text">
214Info about this. Criteria for a successful build.
215</div>
216
217<!-- ======================================================================= -->
218<div class="doc_subsubsection"><a name="build">Build LLVM</a></div>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]219<div class="doc_text">
220 <p>
221 Build both debug and release (optimized) versions of LLVM on all
222 platforms. Ensure the build is warning and error free on each platform.
223 Note that when building the LLVM GCC Binary, use a release build of LLVM.
224 </p>
225</div>
226
227<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]228<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]229<div class="doc_text">
230 <p>
231 Creating the LLVM GCC binary distribution (release/optimized) requires
232 performing the following steps for each supported platform:
233 </p>
234
235 <ol>
236 <li>
237 Build the LLVM GCC front-end by following the directions in the README.LLVM
238 file. Be sure to build with LLVM_VERSION_INFO=X.X, where X is the major and
239 minor release numbers.
240 </li>
241
242 <li>
243 Copy the installation directory to a directory named for the specific target.
244 For example on Red Hat Enterprise Linux, the directory would be named
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]245 <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]246 </li>
247 </ol>
248</div>
249
250<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]251<div class="doc_subsubsection"><a name="clangbin">Build Clang Binary Distribution</a></div>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]252<div class="doc_text">
253 <p>
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]254 Creating the Clang binary distribution (release/optimized) requires
255 performing the following steps for each supported platform:
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]256 </p>
257
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]258 <ol>
259 <li>
260 Instructions how to build it.
261 </li>
262
263 <li>
264 Instructions on how to package
265 </li>
266 </ol>
267</div>
268
269
270<!-- ======================================================================= -->
271<div class="doc_subsubsection"><a name="target-build">Target Specific Build
272Details</a></div>
273<div class="doc_text">
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]274 <p>
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]275 Specify what is used to build llvm, llvm-gcc, clang on each target.
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]276 </p>
277</div>
278
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]279
280<!-- ======================================================================= -->
281<div class="doc_subsection"><a name="release-qualify">
282Building the Release</a></div>
283
284<div class="doc_text">
285How to qualify the release.
286</div>
287
288
289<!-- ======================================================================= -->
290<div class="doc_subsubsection"><a name="llvm-qualify">Qualify LLVM</a></div>
291<div class="doc_text">
292 <p>
293 Details</p>
294</div>
295
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]296<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]297<div class="doc_subsubsection"><a name="llvmgcc-qualify">Qualify LLVM-GCC</a></div>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]298<div class="doc_text">
299 <p>
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]300 Details.</p>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]301</div>
302
303<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]304<div class="doc_subsubsection"><a name="clang-qualify">Qualify Clang</a></div>
Reid Spencer103febe2006-08-16 00:54:50 +0000[diff] [blame]305<div class="doc_text">
Bill Wendling462fc8a2007-07-23 04:41:42 +0000[diff] [blame]306 <p>
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]307 Details.</p>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]308</div>
309
310<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]311<div class="doc_subsubsection"><a name="targets">Specific Target
312Qualification Details</a></div>
313<div class="doc_text">
314 <p>
315 Details</p>
316</div>
317
318<!-- ======================================================================= -->
319<div class="doc_subsection"><a name="commTest">Community Testing</a></div>
John Criswellfe48c802006-04-11 20:24:28 +0000[diff] [blame]320<div class="doc_text">
321 <p>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]322 Once all testing has been completed and appropriate bugs filed, the pre-release
323 tar balls may be put on the website and the LLVM community is notified. Ask that
324 all LLVM developers test the release in 2 ways:</p>
John Criswellfe48c802006-04-11 20:24:28 +0000[diff] [blame]325 <ol>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]326 <li>Download llvm-X.X, llvm-test-X.X, and the appropriate llvm-gcc4 binary.
327 Run "make check" and the full llvm-test suite (make TEST=nightly report).<li>
328 <li>Download llvm-X.X, llvm-test-X.X, and the llvm-gcc4 source. Compile
329 everything. Run "make check" and the full llvm-test suite (make TEST=nightly
330 report).</li>
John Criswellfe48c802006-04-11 20:24:28 +0000[diff] [blame]331 </ol>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]332 <p>Ask LLVM developers to submit the report and make check results to the list.
333 Verify that there are no regressions from the previous release. For
334 unsupported targets, verify that make check at least is clean.</p>
335
336 <p>The first round of pre-release testing will be the longest. During this time,
337 all regressions must be fixed before the second pre-release is created (repeat
338 steps 4-8).</p>
339
340 <p>If this is the second round of testing, this is only to ensure the bug fixes
341 previously merged in have not created new major problems. This is not the time
342 to solve additional and unrelated bugs. If no patches are merged in, the release
343 is determined to be ready and the release manager may move onto the next step.</p>
John Criswellfe48c802006-04-11 20:24:28 +0000[diff] [blame]344</div>
345
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]346<!-- ======================================================================= -->
347<div class="doc_subsection"><a name="release-patch">Release Patch Rules
348</a></div>
349<div class="doc_text">
350 <p>
351 Details</p>
352</div>
353
Tanya Lattner9ceece52006-08-10 00:23:05 +0000[diff] [blame]354
355<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]356<div class="doc_subsection"><a name="release-final">Release Final Tasks
357</a></div>
358<div class="doc_text">
359 <p>
360 Details</p>
361</div>
362
363
364<!-- ======================================================================= -->
365<div class="doc_subsubsection"><a name="tag">Tag the Release Branch</a></div>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]366<div class="doc_text">
367 <p>Tag the release branch using the following procedure:</p>
368<div class="doc_code">
369<pre>
370svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_XX \
371 https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XX</i>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]372svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_XX \
373 https://llvm.org/svn/llvm-project/llvm-gcc-4.2/tags/RELEASE_<i>XX</i>
374svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_XX \
375 https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XX</i>
376</pre>
377</div>
378</div>
379
380<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]381<div class="doc_subsubsection"><a name="updocs">Update Documentation</a></div>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]382<div class="doc_text">
383 <p>
384 Review the documentation and ensure that it is up to date. The Release Notes
385 must be updated to reflect bug fixes, new known issues, and changes in the
386 list of supported platforms. The Getting Started Guide should be updated to
387 reflect the new release version number tag avaiable from Subversion and
388 changes in basic system requirements. Merge both changes from mainline into
389 the release branch.
390 </p>
391</div>
392
393<!-- ======================================================================= -->
394<div class="doc_subsection"><a name="updemo">Update the LLVM Demo Page</a></div>
395<div class="doc_text">
396 <p>
397 The LLVM demo page must be updated to use the new release. This consists of
398 using the llvm-gcc binary and building LLVM. Update the website demo page
399 configuration to use the new release.</p>
400</div>
401
402<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]403<div class="doc_subsubsection"><a name="webupdates">Update the LLVM Website</a></div>
Tanya Lattner9ceece52006-08-10 00:23:05 +0000[diff] [blame]404<div class="doc_text">
405 <p>
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]406 The website must be updated before the release announcement is sent out. Here is
407 what to do:</p>
408 <ol>
409 <li> Check out the <tt>website</tt> module from CVS. </li>
410 <li> Create a new subdirectory X.X in the releases directory. </li>
411 <li> Commit the <tt>llvm</tt>, <tt>test-suite</tt>, <tt>llvm-gcc</tt> source,
412 and <tt>llvm-gcc</tt> binaries in this new directory. </li>
413 <li> Copy and commit the <tt>llvm/docs</tt> and <tt>LICENSE.txt</tt>
414 files into this new directory. The docs should be built with BUILD_FOR_WEBSITE=1.</li>
415 <li> Commit the index.html to the release/X.X directory to redirect (use from previous
416 release. </li>
417 <li> Update the <tt>releases/download.html</tt> file with the new release. </li>
418 <li>Update the <tt>releases/index.html</tt> with the new release and link to
419 release documentation.</li>
420 <li> Finally, update the main page (<tt>index.html</tt> and sidebar) to
Bill Wendling462fc8a2007-07-23 04:41:42 +0000[diff] [blame]421 point to the new release and release announcement. Make sure this all gets
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]422 commited back into Subversion.</li>
423 </ol>
Tanya Lattner9ceece52006-08-10 00:23:05 +0000[diff] [blame]424</div>
425
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]426<!-- ======================================================================= -->
Tanya Lattner4b9e1d22009-08-18 22:33:28 +0000[diff] [blame^]427<div class="doc_subsubsection"><a name="announce">Announce the Release</a></div>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]428<div class="doc_text">
Tanya Lattner76385652007-09-28 22:50:54 +0000[diff] [blame]429 <p>Have Chris send out the release announcement when everything is finished.</p>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]430</div>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]431
432<!-- *********************************************************************** -->
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]433<hr>
434<address>
435 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000[diff] [blame]436 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]437 <a href="http://validator.w3.org/check/referer"><img
Misha Brukmanf00ddb02008-12-11 18:23:24 +0000[diff] [blame]438 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]439 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
Misha Brukmanf00ddb02008-12-11 18:23:24 +0000[diff] [blame]440 <br>
Reid Spencercf427e82006-03-23 06:45:42 +0000[diff] [blame]441 Last modified: $Date$
442</address>
443</body>
444</html>