docs/HowToReleaseLLVM.html

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