/usr/share/doc/llvm-3.5-doc/html/HowToReleaseLLVM.html is in llvm-3.5-doc 1:3.5-10.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>How To Release LLVM To The Public — LLVM 3.5 documentation</title>
<link rel="stylesheet" href="_static/llvm-theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '3.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="LLVM 3.5 documentation" href="index.html" />
<link rel="next" title="Advice on Packaging LLVM" href="Packaging.html" />
<link rel="prev" title="LLVMBuild Guide" href="LLVMBuild.html" />
<style type="text/css">
table.right { float: right; margin-left: 20px; }
table.right td { border: 1px solid #ccc; }
</style>
</head>
<body>
<div class="logo">
<a href="index.html">
<img src="_static/logo.png"
alt="LLVM Logo" width="250" height="88"/></a>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="Packaging.html" title="Advice on Packaging LLVM"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="LLVMBuild.html" title="LLVMBuild Guide"
accesskey="P">previous</a> |</li>
<li><a href="http://llvm.org/">LLVM Home</a> | </li>
<li><a href="index.html">Documentation</a>»</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="body">
<div class="section" id="how-to-release-llvm-to-the-public">
<h1>How To Release LLVM To The Public<a class="headerlink" href="#how-to-release-llvm-to-the-public" title="Permalink to this headline">¶</a></h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#introduction" id="id2">Introduction</a></li>
<li><a class="reference internal" href="#release-timeline" id="id3">Release Timeline</a></li>
<li><a class="reference internal" href="#release-process" id="id4">Release Process</a></li>
</ul>
</div>
<div class="section" id="introduction">
<h2><a class="toc-backref" href="#id2">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p>This document contains information about successfully releasing LLVM —
including subprojects: e.g., <tt class="docutils literal"><span class="pre">clang</span></tt> and <tt class="docutils literal"><span class="pre">dragonegg</span></tt> — to the public. It
is the Release Manager’s responsibility to ensure that a high quality build of
LLVM is released.</p>
<p>If you’re looking for the document on how to test the release candidates and
create the binary packages, please refer to the <a class="reference internal" href="ReleaseProcess.html"><em>How To Validate a New Release</em></a> instead.</p>
</div>
<div class="section" id="release-timeline">
<span id="timeline"></span><h2><a class="toc-backref" href="#id3">Release Timeline</a><a class="headerlink" href="#release-timeline" title="Permalink to this headline">¶</a></h2>
<p>LLVM is released on a time based schedule — with major releases roughly
every 6 months. In between major releases there may be dot releases.
The release manager will determine if and when to make a dot release based
on feedback from the community. Typically, dot releases should be made if
there are large number of bug-fixes in the stable branch or a critical bug
has been discovered that affects a large number of users.</p>
<p>Unless otherwise stated, dot releases will follow the same procedure as
major releases.</p>
<p>The release process is roughly as follows:</p>
<ul class="simple">
<li>Set code freeze and branch creation date for 6 months after last code freeze
date. Announce release schedule to the LLVM community and update the website.</li>
<li>Create release branch and begin release process.</li>
<li>Send out release candidate sources for first round of testing. Testing lasts
7-10 days. During the first round of testing, any regressions found should be
fixed. Patches are merged from mainline into the release branch. Also, all
features need to be completed during this time. Any features not completed at
the end of the first round of testing will be removed or disabled for the
release.</li>
<li>Generate and send out the second release candidate sources. Only <em>critial</em>
bugs found during this testing phase will be fixed. Any bugs introduced by
merged patches will be fixed. If so a third round of testing is needed.</li>
<li>The release notes are updated.</li>
<li>Finally, release!</li>
</ul>
<p>The release process will be accelerated for dot releases. If the first round
of testing finds no critical bugs and no regressions since the last major release,
then additional rounds of testing will not be required.</p>
</div>
<div class="section" id="release-process">
<h2><a class="toc-backref" href="#id4">Release Process</a><a class="headerlink" href="#release-process" title="Permalink to this headline">¶</a></h2>
<div class="contents local topic" id="id1">
<ul class="simple">
<li><a class="reference internal" href="#release-administrative-tasks" id="id5">Release Administrative Tasks</a><ul>
<li><a class="reference internal" href="#create-release-branch" id="id6">Create Release Branch</a></li>
<li><a class="reference internal" href="#update-llvm-version" id="id7">Update LLVM Version</a></li>
<li><a class="reference internal" href="#build-the-llvm-release-candidates" id="id8">Build the LLVM Release Candidates</a></li>
</ul>
</li>
<li><a class="reference internal" href="#building-the-release" id="id9">Building the Release</a><ul>
<li><a class="reference internal" href="#build-llvm" id="id10">Build LLVM</a></li>
<li><a class="reference internal" href="#build-clang-binary-distribution" id="id11">Build Clang Binary Distribution</a></li>
<li><a class="reference internal" href="#target-specific-build-details" id="id12">Target Specific Build Details</a></li>
</ul>
</li>
<li><a class="reference internal" href="#release-qualification-criteria" id="id13">Release Qualification Criteria</a><ul>
<li><a class="reference internal" href="#qualify-llvm" id="id14">Qualify LLVM</a></li>
<li><a class="reference internal" href="#qualify-clang" id="id15">Qualify Clang</a></li>
<li><a class="reference internal" href="#specific-target-qualification-details" id="id16">Specific Target Qualification Details</a></li>
</ul>
</li>
<li><a class="reference internal" href="#community-testing" id="id17">Community Testing</a></li>
<li><a class="reference internal" href="#release-patch-rules" id="id18">Release Patch Rules</a></li>
<li><a class="reference internal" href="#release-final-tasks" id="id19">Release Final Tasks</a><ul>
<li><a class="reference internal" href="#update-documentation" id="id20">Update Documentation</a></li>
<li><a class="reference internal" href="#tag-the-llvm-final-release" id="id21">Tag the LLVM Final Release</a></li>
</ul>
</li>
<li><a class="reference internal" href="#update-the-llvm-demo-page" id="id22">Update the LLVM Demo Page</a><ul>
<li><a class="reference internal" href="#update-the-llvm-website" id="id23">Update the LLVM Website</a></li>
<li><a class="reference internal" href="#announce-the-release" id="id24">Announce the Release</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="release-administrative-tasks">
<h3><a class="toc-backref" href="#id5">Release Administrative Tasks</a><a class="headerlink" href="#release-administrative-tasks" title="Permalink to this headline">¶</a></h3>
<p>This section describes a few administrative tasks that need to be done for the
release process to begin. Specifically, it involves:</p>
<ul class="simple">
<li>Creating the release branch,</li>
<li>Setting version numbers, and</li>
<li>Tagging release candidates for the release team to begin testing.</li>
</ul>
<div class="section" id="create-release-branch">
<h4><a class="toc-backref" href="#id6">Create Release Branch</a><a class="headerlink" href="#create-release-branch" title="Permalink to this headline">¶</a></h4>
<p>Branch the Subversion trunk using the following procedure:</p>
<ol class="arabic">
<li><p class="first">Remind developers that the release branching is imminent and to refrain from
committing patches that might break the build. E.g., new features, large
patches for works in progress, an overhaul of the type system, an exciting
new TableGen feature, etc.</p>
</li>
<li><p class="first">Verify that the current Subversion trunk is in decent shape by
examining nightly tester and buildbot results.</p>
</li>
<li><p class="first">Create the release branch for <tt class="docutils literal"><span class="pre">llvm</span></tt>, <tt class="docutils literal"><span class="pre">clang</span></tt>, the <tt class="docutils literal"><span class="pre">test-suite</span></tt>, and
<tt class="docutils literal"><span class="pre">dragonegg</span></tt> from the last known good revision. The branch’s name is
<tt class="docutils literal"><span class="pre">release_XY</span></tt>, where <tt class="docutils literal"><span class="pre">X</span></tt> is the major and <tt class="docutils literal"><span class="pre">Y</span></tt> the minor release
numbers. The branches should be created using the following commands:</p>
<div class="highlight-python"><div class="highlight"><pre>$ svn copy https://llvm.org/svn/llvm-project/llvm/trunk \
https://llvm.org/svn/llvm-project/llvm/branches/release_XY
$ svn copy https://llvm.org/svn/llvm-project/cfe/trunk \
https://llvm.org/svn/llvm-project/cfe/branches/release_XY
$ svn copy https://llvm.org/svn/llvm-project/dragonegg/trunk \
https://llvm.org/svn/llvm-project/dragonegg/branches/release_XY
$ svn copy https://llvm.org/svn/llvm-project/test-suite/trunk \
https://llvm.org/svn/llvm-project/test-suite/branches/release_XY
</pre></div>
</div>
</li>
<li><p class="first">Advise developers that they may now check their patches into the Subversion
tree again.</p>
</li>
<li><p class="first">The Release Manager should switch to the release branch, because all changes
to the release will now be done in the branch. The easiest way to do this is
to grab a working copy using the following commands:</p>
<div class="highlight-python"><div class="highlight"><pre>$ svn co https://llvm.org/svn/llvm-project/llvm/branches/release_XY llvm-X.Y
$ svn co https://llvm.org/svn/llvm-project/cfe/branches/release_XY clang-X.Y
$ svn co https://llvm.org/svn/llvm-project/dragonegg/branches/release_XY dragonegg-X.Y
$ svn co https://llvm.org/svn/llvm-project/test-suite/branches/release_XY test-suite-X.Y
</pre></div>
</div>
</li>
</ol>
</div>
<div class="section" id="update-llvm-version">
<h4><a class="toc-backref" href="#id7">Update LLVM Version</a><a class="headerlink" href="#update-llvm-version" title="Permalink to this headline">¶</a></h4>
<p>After creating the LLVM release branch, update the release branches’
<tt class="docutils literal"><span class="pre">autoconf</span></tt> and <tt class="docutils literal"><span class="pre">configure.ac</span></tt> versions from ‘<tt class="docutils literal"><span class="pre">X.Ysvn</span></tt>‘ to ‘<tt class="docutils literal"><span class="pre">X.Y</span></tt>‘.
Update it on mainline as well to be the next version (‘<tt class="docutils literal"><span class="pre">X.Y+1svn</span></tt>‘).
Regenerate the configure scripts for both <tt class="docutils literal"><span class="pre">llvm</span></tt> and the <tt class="docutils literal"><span class="pre">test-suite</span></tt>.</p>
<p>In addition, the version numbers of all the Bugzilla components must be updated
for the next release.</p>
</div>
<div class="section" id="build-the-llvm-release-candidates">
<h4><a class="toc-backref" href="#id8">Build the LLVM Release Candidates</a><a class="headerlink" href="#build-the-llvm-release-candidates" title="Permalink to this headline">¶</a></h4>
<p>Create release candidates for <tt class="docutils literal"><span class="pre">llvm</span></tt>, <tt class="docutils literal"><span class="pre">clang</span></tt>, <tt class="docutils literal"><span class="pre">dragonegg</span></tt>, and the LLVM
<tt class="docutils literal"><span class="pre">test-suite</span></tt> by tagging the branch with the respective release candidate
number. For instance, to create <strong>Release Candidate 1</strong> you would issue the
following commands:</p>
<div class="highlight-python"><div class="highlight"><pre>$ svn mkdir https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_XYZ
$ svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_XY \
https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_XYZ/rc1
$ svn mkdir https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_XYZ
$ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_XY \
https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_XYZ/rc1
$ svn mkdir https://llvm.org/svn/llvm-project/dragonegg/tags/RELEASE_XYZ
$ svn copy https://llvm.org/svn/llvm-project/dragonegg/branches/release_XY \
https://llvm.org/svn/llvm-project/dragonegg/tags/RELEASE_XYZ/rc1
$ svn mkdir https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_XYZ
$ svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_XY \
https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_XYZ/rc1
</pre></div>
</div>
<p>Similarly, <strong>Release Candidate 2</strong> would be named <tt class="docutils literal"><span class="pre">RC2</span></tt> and so on. This keeps
a permanent copy of the release candidate around for people to export and build
as they wish. The final released sources will be tagged in the <tt class="docutils literal"><span class="pre">RELEASE_XYZ</span></tt>
directory as <tt class="docutils literal"><span class="pre">Final</span></tt> (c.f. <a class="reference internal" href="#tag"><em>Tag the LLVM Final Release</em></a>).</p>
<p>The Release Manager may supply pre-packaged source tarballs for users. This can
be done with the following commands:</p>
<div class="highlight-python"><div class="highlight"><pre>$ svn export https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_XYZ/rc1 llvm-X.Yrc1
$ svn export https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_XYZ/rc1 clang-X.Yrc1
$ svn export https://llvm.org/svn/llvm-project/dragonegg/tags/RELEASE_XYZ/rc1 dragonegg-X.Yrc1
$ svn export https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_XYZ/rc1 llvm-test-X.Yrc1
$ tar -cvf - llvm-X.Yrc1 | gzip > llvm-X.Yrc1.src.tar.gz
$ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.gz
$ tar -cvf - dragonegg-X.Yrc1 | gzip > dragonegg-X.Yrc1.src.tar.gz
$ tar -cvf - llvm-test-X.Yrc1 | gzip > llvm-test-X.Yrc1.src.tar.gz
</pre></div>
</div>
</div>
</div>
<div class="section" id="building-the-release">
<h3><a class="toc-backref" href="#id9">Building the Release</a><a class="headerlink" href="#building-the-release" title="Permalink to this headline">¶</a></h3>
<p>The builds of <tt class="docutils literal"><span class="pre">llvm</span></tt>, <tt class="docutils literal"><span class="pre">clang</span></tt>, and <tt class="docutils literal"><span class="pre">dragonegg</span></tt> <em>must</em> be free of
errors and warnings in Debug, Release+Asserts, and Release builds. If all
builds are clean, then the release passes Build Qualification.</p>
<p>The <tt class="docutils literal"><span class="pre">make</span></tt> options for building the different modes:</p>
<table border="1" class="docutils">
<colgroup>
<col width="27%" />
<col width="73%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Mode</th>
<th class="head">Options</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Debug</td>
<td><tt class="docutils literal"><span class="pre">ENABLE_OPTIMIZED=0</span></tt></td>
</tr>
<tr class="row-odd"><td>Release+Asserts</td>
<td><tt class="docutils literal"><span class="pre">ENABLE_OPTIMIZED=1</span></tt></td>
</tr>
<tr class="row-even"><td>Release</td>
<td><tt class="docutils literal"><span class="pre">ENABLE_OPTIMIZED=1</span> <span class="pre">DISABLE_ASSERTIONS=1</span></tt></td>
</tr>
</tbody>
</table>
<div class="section" id="build-llvm">
<h4><a class="toc-backref" href="#id10">Build LLVM</a><a class="headerlink" href="#build-llvm" title="Permalink to this headline">¶</a></h4>
<p>Build <tt class="docutils literal"><span class="pre">Debug</span></tt>, <tt class="docutils literal"><span class="pre">Release+Asserts</span></tt>, and <tt class="docutils literal"><span class="pre">Release</span></tt> versions
of <tt class="docutils literal"><span class="pre">llvm</span></tt> on all supported platforms. Directions to build <tt class="docutils literal"><span class="pre">llvm</span></tt>
are <a class="reference internal" href="GettingStarted.html"><em>here</em></a>.</p>
</div>
<div class="section" id="build-clang-binary-distribution">
<h4><a class="toc-backref" href="#id11">Build Clang Binary Distribution</a><a class="headerlink" href="#build-clang-binary-distribution" title="Permalink to this headline">¶</a></h4>
<p>Creating the <tt class="docutils literal"><span class="pre">clang</span></tt> binary distribution (Debug/Release+Asserts/Release)
requires performing the following steps for each supported platform:</p>
<ol class="arabic simple">
<li>Build clang according to the directions <a class="reference external" href="http://clang.llvm.org/get_started.html">here</a>.</li>
<li>Build both a Debug and Release version of clang. The binary will be the
Release build.</li>
<li>Package <tt class="docutils literal"><span class="pre">clang</span></tt> (details to follow).</li>
</ol>
</div>
<div class="section" id="target-specific-build-details">
<h4><a class="toc-backref" href="#id12">Target Specific Build Details</a><a class="headerlink" href="#target-specific-build-details" title="Permalink to this headline">¶</a></h4>
<p>The table below specifies which compilers are used for each Arch/OS combination
when qualifying the build of <tt class="docutils literal"><span class="pre">llvm</span></tt>, <tt class="docutils literal"><span class="pre">clang</span></tt>, and <tt class="docutils literal"><span class="pre">dragonegg</span></tt>.</p>
<table border="1" class="docutils">
<colgroup>
<col width="27%" />
<col width="29%" />
<col width="43%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Architecture</th>
<th class="head">OS</th>
<th class="head">compiler</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>x86-32</td>
<td>Mac OS 10.5</td>
<td>gcc 4.0.1</td>
</tr>
<tr class="row-odd"><td>x86-32</td>
<td>Linux</td>
<td>gcc 4.2.X, gcc 4.3.X</td>
</tr>
<tr class="row-even"><td>x86-32</td>
<td>FreeBSD</td>
<td>gcc 4.2.X</td>
</tr>
<tr class="row-odd"><td>x86-32</td>
<td>mingw</td>
<td>gcc 3.4.5</td>
</tr>
<tr class="row-even"><td>x86-64</td>
<td>Mac OS 10.5</td>
<td>gcc 4.0.1</td>
</tr>
<tr class="row-odd"><td>x86-64</td>
<td>Linux</td>
<td>gcc 4.2.X, gcc 4.3.X</td>
</tr>
<tr class="row-even"><td>x86-64</td>
<td>FreeBSD</td>
<td>gcc 4.2.X</td>
</tr>
<tr class="row-odd"><td>ARMv7</td>
<td>Linux</td>
<td>gcc 4.6.X, gcc 4.7.X</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="release-qualification-criteria">
<h3><a class="toc-backref" href="#id13">Release Qualification Criteria</a><a class="headerlink" href="#release-qualification-criteria" title="Permalink to this headline">¶</a></h3>
<p>A release is qualified when it has no regressions from the previous release (or
baseline). Regressions are related to correctness first and performance second.
(We may tolerate some minor performance regressions if they are deemed
necessary for the general quality of the compiler.)</p>
<p><strong>Regressions are new failures in the set of tests that are used to qualify
each product and only include things on the list. Every release will have
some bugs in it. It is the reality of developing a complex piece of
software. We need a very concrete and definitive release criteria that
ensures we have monotonically improving quality on some metric. The metric we
use is described below. This doesn’t mean that we don’t care about other
criteria, but these are the criteria which we found to be most important and
which must be satisfied before a release can go out.</strong></p>
<div class="section" id="qualify-llvm">
<h4><a class="toc-backref" href="#id14">Qualify LLVM</a><a class="headerlink" href="#qualify-llvm" title="Permalink to this headline">¶</a></h4>
<p>LLVM is qualified when it has a clean test run without a front-end. And it has
no regressions when using either <tt class="docutils literal"><span class="pre">clang</span></tt> or <tt class="docutils literal"><span class="pre">dragonegg</span></tt> with the
<tt class="docutils literal"><span class="pre">test-suite</span></tt> from the previous release.</p>
</div>
<div class="section" id="qualify-clang">
<h4><a class="toc-backref" href="#id15">Qualify Clang</a><a class="headerlink" href="#qualify-clang" title="Permalink to this headline">¶</a></h4>
<p><tt class="docutils literal"><span class="pre">Clang</span></tt> is qualified when front-end specific tests in the <tt class="docutils literal"><span class="pre">llvm</span></tt> regression
test suite all pass, clang’s own test suite passes cleanly, and there are no
regressions in the <tt class="docutils literal"><span class="pre">test-suite</span></tt>.</p>
</div>
<div class="section" id="specific-target-qualification-details">
<h4><a class="toc-backref" href="#id16">Specific Target Qualification Details</a><a class="headerlink" href="#specific-target-qualification-details" title="Permalink to this headline">¶</a></h4>
<table border="1" class="docutils">
<colgroup>
<col width="19%" />
<col width="18%" />
<col width="22%" />
<col width="40%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Architecture</th>
<th class="head">OS</th>
<th class="head">clang baseline</th>
<th class="head">tests</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>x86-32</td>
<td>Linux</td>
<td>last release</td>
<td>llvm regression tests,
clang regression tests,
test-suite (including spec)</td>
</tr>
<tr class="row-odd"><td>x86-32</td>
<td>FreeBSD</td>
<td>last release</td>
<td>llvm regression tests,
clang regression tests,
test-suite</td>
</tr>
<tr class="row-even"><td>x86-32</td>
<td>mingw</td>
<td>none</td>
<td>QT</td>
</tr>
<tr class="row-odd"><td>x86-64</td>
<td>Mac OS 10.X</td>
<td>last release</td>
<td>llvm regression tests,
clang regression tests,
test-suite (including spec)</td>
</tr>
<tr class="row-even"><td>x86-64</td>
<td>Linux</td>
<td>last release</td>
<td>llvm regression tests,
clang regression tests,
test-suite (including spec)</td>
</tr>
<tr class="row-odd"><td>x86-64</td>
<td>FreeBSD</td>
<td>last release</td>
<td>llvm regression tests,
clang regression tests,
test-suite</td>
</tr>
<tr class="row-even"><td>ARMv7A</td>
<td>Linux</td>
<td>last release</td>
<td>llvm regression tests,
clang regression tests,
test-suite</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="community-testing">
<h3><a class="toc-backref" href="#id17">Community Testing</a><a class="headerlink" href="#community-testing" title="Permalink to this headline">¶</a></h3>
<p>Once all testing has been completed and appropriate bugs filed, the release
candidate tarballs are put on the website and the LLVM community is notified.
Ask that all LLVM developers test the release in 2 ways:</p>
<ol class="arabic simple">
<li>Download <tt class="docutils literal"><span class="pre">llvm-X.Y</span></tt>, <tt class="docutils literal"><span class="pre">llvm-test-X.Y</span></tt>, and the appropriate <tt class="docutils literal"><span class="pre">clang</span></tt>
binary. Build LLVM. Run <tt class="docutils literal"><span class="pre">make</span> <span class="pre">check</span></tt> and the full LLVM test suite (<tt class="docutils literal"><span class="pre">make</span>
<span class="pre">TEST=nightly</span> <span class="pre">report</span></tt>).</li>
<li>Download <tt class="docutils literal"><span class="pre">llvm-X.Y</span></tt>, <tt class="docutils literal"><span class="pre">llvm-test-X.Y</span></tt>, and the <tt class="docutils literal"><span class="pre">clang</span></tt> sources. Compile
everything. Run <tt class="docutils literal"><span class="pre">make</span> <span class="pre">check</span></tt> and the full LLVM test suite (<tt class="docutils literal"><span class="pre">make</span>
<span class="pre">TEST=nightly</span> <span class="pre">report</span></tt>).</li>
</ol>
<p>Ask LLVM developers to submit the test suite report and <tt class="docutils literal"><span class="pre">make</span> <span class="pre">check</span></tt> results
to the list. Verify that there are no regressions from the previous release.
The results are not used to qualify a release, but to spot other potential
problems. For unsupported targets, verify that <tt class="docutils literal"><span class="pre">make</span> <span class="pre">check</span></tt> is at least
clean.</p>
<p>During the first round of testing, all regressions must be fixed before the
second release candidate is tagged.</p>
<p>If this is the second round of testing, the testing is only to ensure that bug
fixes previously merged in have not created new major problems. <em>This is not
the time to solve additional and unrelated bugs!</em> If no patches are merged in,
the release is determined to be ready and the release manager may move onto the
next stage.</p>
</div>
<div class="section" id="release-patch-rules">
<h3><a class="toc-backref" href="#id18">Release Patch Rules</a><a class="headerlink" href="#release-patch-rules" title="Permalink to this headline">¶</a></h3>
<p>Below are the rules regarding patching the release branch:</p>
<ol class="arabic simple">
<li>Patches applied to the release branch may only be applied by the release
manager.</li>
<li>During the first round of testing, patches that fix regressions or that are
small and relatively risk free (verified by the appropriate code owner) are
applied to the branch. Code owners are asked to be very conservative in
approving patches for the branch. We reserve the right to reject any patch
that does not fix a regression as previously defined.</li>
<li>During the remaining rounds of testing, only patches that fix critical
regressions may be applied.</li>
<li>For dot releases all patches must mantain both API and ABI compatibility with
the previous major release. Only bugfixes will be accepted.</li>
</ol>
</div>
<div class="section" id="release-final-tasks">
<h3><a class="toc-backref" href="#id19">Release Final Tasks</a><a class="headerlink" href="#release-final-tasks" title="Permalink to this headline">¶</a></h3>
<p>The final stages of the release process involves tagging the “final” release
branch, updating documentation that refers to the release, and updating the
demo page.</p>
<div class="section" id="update-documentation">
<h4><a class="toc-backref" href="#id20">Update Documentation</a><a class="headerlink" href="#update-documentation" title="Permalink to this headline">¶</a></h4>
<p>Review the documentation and ensure that it is up to date. The “Release Notes”
must be updated to reflect new features, bug fixes, new known issues, and
changes in the list of supported platforms. The “Getting Started Guide” should
be updated to reflect the new release version number tag available from
Subversion and changes in basic system requirements. Merge both changes from
mainline into the release branch.</p>
</div>
<div class="section" id="tag-the-llvm-final-release">
<span id="tag"></span><h4><a class="toc-backref" href="#id21">Tag the LLVM Final Release</a><a class="headerlink" href="#tag-the-llvm-final-release" title="Permalink to this headline">¶</a></h4>
<p>Tag the final release sources using the following procedure:</p>
<div class="highlight-python"><div class="highlight"><pre>$ svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_XY \
https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_XYZ/Final
$ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_XY \
https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_XYZ/Final
$ svn copy https://llvm.org/svn/llvm-project/dragonegg/branches/release_XY \
https://llvm.org/svn/llvm-project/dragonegg/tags/RELEASE_XYZ/Final
$ svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_XY \
https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_XYZ/Final
</pre></div>
</div>
</div>
</div>
<div class="section" id="update-the-llvm-demo-page">
<h3><a class="toc-backref" href="#id22">Update the LLVM Demo Page</a><a class="headerlink" href="#update-the-llvm-demo-page" title="Permalink to this headline">¶</a></h3>
<p>The LLVM demo page must be updated to use the new release. This consists of
using the new <tt class="docutils literal"><span class="pre">clang</span></tt> binary and building LLVM.</p>
<div class="section" id="update-the-llvm-website">
<h4><a class="toc-backref" href="#id23">Update the LLVM Website</a><a class="headerlink" href="#update-the-llvm-website" title="Permalink to this headline">¶</a></h4>
<p>The website must be updated before the release announcement is sent out. Here
is what to do:</p>
<ol class="arabic simple">
<li>Check out the <tt class="docutils literal"><span class="pre">www</span></tt> module from Subversion.</li>
<li>Create a new subdirectory <tt class="docutils literal"><span class="pre">X.Y</span></tt> in the releases directory.</li>
<li>Commit the <tt class="docutils literal"><span class="pre">llvm</span></tt>, <tt class="docutils literal"><span class="pre">test-suite</span></tt>, <tt class="docutils literal"><span class="pre">clang</span></tt> source, <tt class="docutils literal"><span class="pre">clang</span> <span class="pre">binaries</span></tt>,
<tt class="docutils literal"><span class="pre">dragonegg</span></tt> source, and <tt class="docutils literal"><span class="pre">dragonegg</span></tt> binaries in this new directory.</li>
<li>Copy and commit the <tt class="docutils literal"><span class="pre">llvm/docs</span></tt> and <tt class="docutils literal"><span class="pre">LICENSE.txt</span></tt> files into this new
directory. The docs should be built with <tt class="docutils literal"><span class="pre">BUILD_FOR_WEBSITE=1</span></tt>.</li>
<li>Commit the <tt class="docutils literal"><span class="pre">index.html</span></tt> to the <tt class="docutils literal"><span class="pre">release/X.Y</span></tt> directory to redirect (use
from previous release).</li>
<li>Update the <tt class="docutils literal"><span class="pre">releases/download.html</span></tt> file with the new release.</li>
<li>Update the <tt class="docutils literal"><span class="pre">releases/index.html</span></tt> with the new release and link to release
documentation.</li>
<li>Finally, update the main page (<tt class="docutils literal"><span class="pre">index.html</span></tt> and sidebar) to point to the
new release and release announcement. Make sure this all gets committed back
into Subversion.</li>
</ol>
</div>
<div class="section" id="announce-the-release">
<h4><a class="toc-backref" href="#id24">Announce the Release</a><a class="headerlink" href="#announce-the-release" title="Permalink to this headline">¶</a></h4>
<p>Have Chris send out the release announcement when everything is finished.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="Packaging.html" title="Advice on Packaging LLVM"
>next</a> |</li>
<li class="right" >
<a href="LLVMBuild.html" title="LLVMBuild Guide"
>previous</a> |</li>
<li><a href="http://llvm.org/">LLVM Home</a> | </li>
<li><a href="index.html">Documentation</a>»</li>
</ul>
</div>
<div class="footer">
© Copyright 2003-2014, LLVM Project.
Last updated on 2015-02-27.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>
|