<body>
<div class="doc_title">How To Release LLVM To The Public</div>
-<p class="doc_warning">NOTE: THIS DOCUMENT IS A WORK IN PROGRESS!</p>
<ol>
<li><a href="#introduction">Introduction</a></li>
+ <li><a href="#criteria">Qualification Criteria</a></li>
+ <li><a href="#introduction">Release Timeline</a></li>
<li><a href="#process">Release Process</a></li>
- <li><a href="#dist">Distribution Make Targets</a></li>
</ol>
<div class="doc_author">
- <p>Written by <a href="mailto:rspencer@x10sys.com">Reid Spencer</a>,
- <a href="mailto:criswell@cs.uiuc.edu">John Criswell</a></p>
+ <p>Written by <a href="mailto:tonic@nondot.org">Tanya Lattner</a>,
+ <a href="mailto:rspencer@x10sys.com">Reid Spencer</a>,
+ <a href="mailto:criswell@cs.uiuc.edu">John Criswell</a>, &
+ <a href="mailto:wendling@apple.com">Bill Wendling</a>
+ </p>
</div>
<!-- *********************************************************************** -->
<!-- *********************************************************************** -->
<div class="doc_text">
-<p>This document collects information about successfully releasing LLVM to the
-public. It is the release manager's guide to ensuring that a high quality build
-of LLVM is released. Mostly, it's just a bunch of reminders of things to do at
-release time so we don't inadvertently ship something that is utility
-deficient.</p>
-
-<p>
-There are three main tasks for building a release of LLVM:
-<ol>
- <li>Create the LLVM source distribution.</li>
- <li>Create the LLVM GCC source distribtuion.</li>
- <li>Create a set of LLVM GCC binary distribtuions for each supported
- platform. These binary distributions must include compiled versions
- of the libraries found in <tt>llvm/runtime</tt> from the LLVM
- source distribution created in Step 1.</li>
-</ol>
-</p>
+
+<p>This document contains information about successfully releasing LLVM —
+ including subprojects: e.g., <tt>llvm-gcc</tt> and <tt>clang</tt> — to
+ the public. It is the Release Manager's responsibility to ensure that a high
+ quality build of LLVM is released.</p>
+
+</div>
+
+<!-- *********************************************************************** -->
+<div class="doc_section"><a name="process">Release Timeline</a></div>
+<!-- *********************************************************************** -->
+<div class="doc_text">
+
+<p>LLVM is released on a time based schedule — roughly every 6 months. We
+ do not normally have dot releases because of the nature of LLVM's incremental
+ development philosophy. That said, the only thing preventing dot releases for
+ critical bug fixes from happening is a lack of resources — testers,
+ machines, time, etc. And, because of the high quality we desire for LLVM
+ releases, we cannot allow for a truncated form of release qualification.</p>
+
+<p>The release process is roughly as follows:</p>
+
+<ul>
+ <li><p>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.</p></li>
+
+ <li><p>Create release branch and begin release process.</p></li>
+
+ <li><p>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.</p></li>
+
+ <li><p>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.</p></li>
+
+ <li><p>The release notes are updated.</p></li>
+
+ <li><p>Finally, release!</p></li>
+</ul>
+
</div>
<!-- *********************************************************************** -->
<div class="doc_section"><a name="process">Release Process</a></div>
<!-- *********************************************************************** -->
-<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="overview">Process Overview</a></div>
<div class="doc_text">
+
+<ol>
+ <li><a href="#release-admin">Release Administrative Tasks</a></li>
+ <ol>
+ <li><a href="#branch">Create Release Branch</a></li>
+ <li><a href="#verchanges">Update Version Numbers</a></li>
+ </ol>
+ <li><a href="#release-build">Building the Release</a></li>
<ol>
- <li><a href="#updocs">Update Documentation</a></li>
- <li><a href="#merge">Merge Branches</a></li>
- <li><a href="#deps">Make LibDeps.txt</a></li>
- <li><a href="#settle">Settle LLVM HEAD</a></li>
- <li><a href="#tag">Tag LLVM and Create the Release Branch</a></li>
- <li><a href="#build">Build LLVM</a></li>
- <li><a href="#check">Run 'make check'</a></li>
- <li><a href="#test">Run LLVM Test Suite</a></li>
<li><a href="#dist">Build the LLVM Source Distributions</a></li>
- <li><a href="#llvmgccbin">Build the LLVM GCC Binary Distribution</a></li>
+ <li><a href="#build">Build LLVM</a></li>
+ <li><a href="#llvmgccbin">Build the LLVM-GCC Binary Distribution</a></li>
+ <li><a href="#clangbin">Build the Clang Binary Distribution</a></li>
+ <li><a href="#target-build">Target Specific Build Details</a></li>
+ </ol>
+ <li><a href="#release-qualify">Release Qualification Criteria</a></li>
+ <ol>
+ <li><a href="#llvm-qualify">Qualify LLVM</a></li>
+ <li><a href="#llvmgcc-qualify">Qualify LLVM-GCC</a></li>
+ <li><a href="#clang-qualify">Qualify Clang</a></li>
+ <li><a href="#targets">Specific Target Qualification Details</a></li>
</ol>
+
+ <li><a href="#commTest">Community Testing</a></li>
+ <li><a href="#release-patch">Release Patch Rules</a></li>
+ <li><a href="#release-final">Release final tasks</a></li>
+
+ <ol>
+ <li><a href="#updocs">Update Documentation</a></li>
+ <li><a href="#tag">Tag the LLVM Final Release</a></li>
+ <li><a href="#updemo">Update the LLVM Demo Page</a></li>
+ <li><a href="#webupdates">Update the LLVM Website</a></li>
+ <li><a href="#announce">Announce the Release</a></li>
+ </ol>
+</ol>
+
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="updocs">Update Documentation</a></div>
+<div class="doc_subsection"><a name="release-admin">Release Administrative Tasks</a></div>
+
<div class="doc_text">
- <p>
- Review the documentation and ensure that it is up to date. The Release Notes
- must be updated to reflect 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 avaiable from CVS and changes in
- basic system requirements.
- </p>
+
+<p>This section describes a few administrative tasks that need to be done for
+ the release process to begin. Specifically, it involves:</p>
+
+<ul>
+ <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>
+
+<!-- ======================================================================= -->
+<div class="doc_subsubsection"><a name="branch">Create Release Branch</a></div>
+
+<div class="doc_text">
+
+<p>Branch the Subversion trunk using the following procedure:</p>
+
+<ol>
+ <li><p>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>Verify that the current Subversion trunk is in decent shape by
+ examining nightly tester and buildbot results.</p></li>
+
+ <li><p>Create the release branch for <tt>llvm</tt>, <tt>llvm-gcc-4.2</tt>,
+ <tt>clang</tt>, and the <tt>test-suite</tt> from the last known good
+ revision. The branch's name is <tt>release_XY</tt>, where <tt>X</tt> is
+ the major and <tt>Y</tt> the minor release numbers. The branches should be
+ created using the following commands:</p>
+
+<div class="doc_code">
+<pre>
+$ svn copy https://llvm.org/svn/llvm-project/llvm/trunk \
+ https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XY</i>
+
+$ svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.2/trunk \
+ https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_<i>XY</i>
+
+$ svn copy https://llvm.org/svn/llvm-project/test-suite/trunk \
+ https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XY</i>
+
+$ svn copy https://llvm.org/svn/llvm-project/cfe/trunk \
+ https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XY</i>
+</pre>
+</div></li>
+
+ <li><p>Advise developers that they may now check their patches into the
+ Subversion tree again.</p></li>
+
+ <li><p>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="doc_code">
+<pre>
+$ svn co https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XY</i> llvm-<i>X.Y</i>
+
+$ 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>
+
+$ svn co https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XY</i> test-suite-<i>X.Y</i>
+
+$ svn co https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XY</i> clang-<i>X.Y</i>
+</pre>
+</div></li>
+</ol>
+
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="merge">Merge Branches</a></div>
+<div class="doc_subsubsection"><a name="verchanges">Update LLVM Version</a></div>
+
<div class="doc_text">
-<p>
-Merge any work done on branches intended for release into mainline. Finish and
-commit all new features or bug fixes that are scheduled to go into the release.
-Work that is not to be incorporated into the release should not be merged from
-branchs or commited from developer's working directories.
-</p>
-
-<p>
-From this point until the release branch is created, developers should
-<em>not</em>
-commit changes to the llvm and llvm-gcc CVS repositories unless it is a bug
-fix <em>for the release</em>.
-</p>
+
+<p>After creating the LLVM release branch, update the release branches'
+ <tt>autoconf</tt> and <tt>configure.ac</tt> versions from '<tt>X.Ysvn</tt>'
+ to '<tt>X.Y</tt>'. Update it on mainline as well to be the next version
+ ('<tt>X.Y+1svn</tt>'). Regenerate the configure scripts for both
+ <tt>llvm</tt> and the <tt>test-suite</tt>.</p>
+
+<p>In addition, the version numbers of all the Bugzilla components must be
+ updated for the next release.</p>
+
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="deps">Make LibDeps.txt</a></div>
+<div class="doc_subsubsection"><a name="dist">Build the LLVM Release Candidates</a></div>
+
<div class="doc_text">
- <p>Rebuild the <tt>LibDeps.txt</tt> target in <tt>utils/llvm-config</tt>. This
- makes sure that the <tt>llvm-config</tt> utility remains relevant for the
- release, reflecting any changes in the library dependencies.</p>
+
+<p>Create release candidates for <tt>llvm</tt>, <tt>llvm-gcc</tt>,
+ <tt>clang</tt>, and the LLVM <tt>test-suite</tt> by tagging the branch with
+ the respective release candidate number. For instance, to create <b>Release
+ Candidate 1</b> you would issue the following commands:</p>
+
+<div class="doc_code">
+<pre>
+$ svn mkdir https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XY</i>
+$ svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XY</i> \
+ https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XY</i>/rc1
+
+$ svn mkdir https://llvm.org/svn/llvm-project/llvm-gcc-4.2/tags/RELEASE_<i>XY</i>
+$ svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_<i>XY</i> \
+ https://llvm.org/svn/llvm-project/llvm-gcc-4.2/tags/RELEASE_<i>XY</i>/rc1
+
+$ svn mkdir https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XY</i>
+$ svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XY</i> \
+ https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XY</i>/rc1
+
+$ svn mkdir https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_<i>XY</i>
+$ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XY</i> \
+ https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_<i>XY</i>/rc1
+</pre>
</div>
+<p>Similarly, <b>Release Candidate 2</b> would be named <tt>RC2</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>RELEASE_<i>XY</i></tt> directory as <tt>Final</tt>
+ (c.f. <a href="#tag">Tag the LLVM Final Release</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="doc_code">
+<pre>
+$ svn export https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XY</i>/rc1 llvm-<i>X.Y</i>rc1
+$ 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
+$ svn export https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XY</i>/rc1 llvm-test-<i>X.Y</i>rc1
+$ svn export https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_<i>XY</i>/rc1 clang-<i>X.Y</i>rc1
+
+$ tar -czvf - llvm-<i>X.Y</i>rc1 | gzip > llvm-<i>X.Y</i>rc1.src.tar.gz
+$ tar -czvf - llvm-test-<i>X.Y</i>rc1 | gzip > llvm-test-<i>X.Y</i>rc1.src.tar.gz
+$ tar -czvf - llvm-gcc4.2-<i>X.Y</i>rc1 | gzip > llvm-gcc-4.2-<i>X.Y</i>rc1.src.tar.gz
+$ tar -czvf - clang-<i>X.Y</i>rc1 | gzip > clang-<i>X.Y</i>rc1.src.tar.gz
+</pre>
+</div>
+
+</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="settle">Settle CVS HEAD</a></div>
+<div class="doc_subsection"><a name="release-build">Building the Release</a></div>
+
<div class="doc_text">
- <p>
- Use the nightly test reports and 'make check' (deja-gnu based tests) to
- ensure that recent changes and merged branches have not destabilized LLVM.
- Platforms which are used less often should be given special attention as they
- are the most likely to break from commits from the previous step.
- </p>
+
+<p>The builds of <tt>llvm</tt>, <tt>llvm-gcc</tt>, and <tt>clang</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>make</tt> options for building the different modes:</p>
+
+<table>
+ <tr><th>Mode</th><th>Options</th></tr>
+ <tr align="left"><td>Debug</td><td><tt>ENABLE_OPTIMIZED=0</tt></td></tr>
+ <tr align="left"><td>Release+Asserts</td><td><tt>ENABLE_OPTIMIZED=1</tt></td></tr>
+ <tr align="left"><td>Release</td><td><tt>ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1</tt></td></tr>
+</table>
+
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="tag">CVS Tag And Branch</a></div>
+<div class="doc_subsubsection"><a name="build">Build LLVM</a></div>
+
<div class="doc_text">
- <p>Tag and branch the CVS HEAD using the following procedure:</p>
- <ol>
- <li>
- Request all developers to refrain from committing. Offenders get commit
- rights taken away (temporarily).
- </li>
-
- <li>
- The Release Manager updates his/her llvm, llvm-test, and llvm-gcc source
- trees with the
- latest sources from mainline CVS. The Release Manage may want to consider
- using a new working directory for this to keep current uncommitted work
- separate from release work.
- </li>
-
- <li>
- The Release Manager tags his/her llvm, llvm-test, and llvm-gcc working
- directories with
- "ROOT_RELEASE_XX" where XX is the major and minor
- release numbers (you can't have . in a cvs tag name). So, for Release 1.2,
- XX=12 and for Release 1.10, XX=110.
- </li>
-
- <li>
- Immediately create cvs branches based on the ROOT_RELEASE_XX tag. The tag
- should be "release_XX" (where XX matches that used for the ROOT_RELEASE_XX
- tag). This is where the release distribution will be created.
- </li>
-
- <li>
- Advise developers they can work on CVS HEAD again.
- </li>
-
- <li>
- The Release Manager and any developers working on the release should switch
- to the release branch (as all changes to the release will now be done in
- the branch). The easiest way to do this is to grab another working copy
- using the following commands:
-
- <p>
- <tt>cvs -d <CVS Repository> co -r release_XX llvm</tt><br>
- <tt>cvs -d <CVS Repository> co -r release_XX llvm-test</tt><br>
- <tt>cvs -d <CVS Repository> co -r release_XX llvm-gcc</tt><br>
- </p>
- </li>
+
+<p>Build <tt>Debug</tt>, <tt>Release+Asserts</tt>, and <tt>Release</tt> versions
+ of <tt>llvm</tt> on all supported platforms. Directions to build
+ <tt>llvm</tt> are
+ <a href="http://llvm.org/docs/GettingStarted.html#quickstart">here</a>.</p>
+
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="build">Build LLVM</a></div>
+<div class="doc_subsubsection"><a name="llvmgccbin">Build the LLVM GCC Binary Distribution</a></div>
+
<div class="doc_text">
- <p>
- Build both debug and release (optimized) versions of LLVM on all
- platforms. Ensure the build is warning and error free on each platform.
- </p>
- <p>
- Build a new version of the LLVM GCC front-end after building the LLVM tools.
- Once that is complete, go back to the LLVM source tree and build and install
- the <tt>llvm/runtime</tt> libraries.
- </p>
+<p>Creating the <tt>llvm-gcc</tt> binary distribution (Release/Optimized)
+ requires performing the following steps for each supported platform:</p>
+
+<ol>
+ <li><p>Build the <tt>llvm-gcc</tt> front-end by following the directions in
+ the <tt>README.LLVM</tt> file. The front-end must be compiled with C, C++,
+ Objective-C (Mac only), Objective-C++ (Mac only), and Fortran
+ support.</p></li>
+
+ <li><p>Boostrapping must be enabled.</p></li>
+
+ <li><p>Be sure to build with <tt>LLVM_VERSION_INFO=X.Y</tt>, where <tt>X</tt>
+ is the major and <tt>Y</tt> is the minor release numbers.</p></li>
+
+ <li><p>Copy the installation directory to a directory named for the specific
+ target. For example on Red Hat Enterprise Linux, the directory would be
+ named <tt>llvm-gcc4.2-2.6-x86-linux-RHEL4</tt>. Archive and compress the
+ new directory.</p></li>
+</ol>
+
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="check">Run 'make check'</a></div>
+<div class="doc_subsubsection"><a name="clangbin">Build Clang Binary Distribution</a></div>
+
<div class="doc_text">
- <p>Run <tt>make check</tt> and ensure there are no unexpected failures. If
- there are, resolve the failures, commit them back into the release branch,
- and restart testing by <a href="#build">re-building LLVM</a>.
- </p>
- <p>
- Ensure that 'make check' passes on all platforms for all targets. If certain
- failures cannot be resolved before release time, determine if marking them
- XFAIL is appropriate. If not, fix the bug and go back. The test suite must
- complete with "0 unexpected failures" for release.
- </p>
+<p>Creating the <tt>clang</tt> binary distribution
+ (Debug/Release+Asserts/Release) requires performing the following steps for
+ each supported platform:</p>
+
+<ol>
+ <li>Build clang according to the directions
+ <a 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>clang</tt> (details to follow).</li>
+</ol>
+
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="test">LLVM Test Suite</a></div>
+<div class="doc_subsubsection"><a name="target-build">Target Specific Build Details</a></div>
+
<div class="doc_text">
- <p>Run the llvm-test suite and ensure there are no unacceptable failures.
- If there are, resolve the failures and go back to
- <a href="#build">re-building LLVM</a>. The test suite
- should be run in Nightly Test mode. All tests must pass.
+
+<p>The table below specifies which compilers are used for each Arch/OS
+ combination when qualifying the build of <tt>llvm</tt>, <tt>llvm-gcc</tt>,
+ and <tt>clang</tt>.</p>
+
+<table>
+ <tr><th>Architecture</th><th>OS</th><th>compiler</th></tr>
+ <tr><td>x86-32</td><td>Mac OS 10.5</td><td>gcc 4.0.1</td></tr>
+ <tr><td>x86-32</td><td>Linux</td><td>gcc 4.2.X, gcc 4.3.X</td></tr>
+ <tr><td>x86-32</td><td>FreeBSD</td><td>gcc 4.2.X</td></tr>
+ <tr><td>x86-32</td><td>mingw</td><td>gcc 3.4.5</td></tr>
+ <tr><td>x86-64</td><td>Mac OS 10.5</td><td>gcc 4.0.1</td></tr>
+ <tr><td>x86-64</td><td>Linux</td><td>gcc 4.2.X, gcc 4.3.X</td></tr>
+ <tr><td>x86-64</td><td>FreeBSD</td><td>gcc 4.2.X</td></tr>
+</table>
+
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="dist">Build the LLVM Source Distributions</a></div>
+<div class="doc_subsection"><a name="release-qualify">
+Building the Release</a></div>
+
<div class="doc_text">
- <p>
- Create source distributions for LLVM, LLVM GCC, and the LLVM Test Suite by
- exporting the source
- from CVS and archiving it. This can be done with the following commands:
- </p>
- <p>
- <tt>cvs -d <CVS Repository> export -r release_XX llvm</tt><br>
- <tt>cvs -d <CVS Repository> export -r release_XX llvm-test</tt><br>
- <tt>cvs -d <CVS Repository> export -r release_XX llvm-gcc</tt><br>
- <tt>mkdir cfrontend; mv llvm-gcc cfrontend/src</tt><br>
- <tt>tar -cvf - llvm | gzip > llvm-X.X.tar.gz</tt><br>
- <tt>tar -cvf - llvm-test | gzip > llvm-test-X.X.tar.gz</tt><br>
- <tt>tar -cvf - cfrontend/src | gzip > cfrontend-X.X.source.tar.gz</tt><br>
- </p>
+<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><b>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</b></p>
- <!-- This is a
- two step process. First, use "make dist" to simply build the distribution. Any
- failures need to be corrected (on the branch). Once "make dist" can be
- successful, do "make dist-check". This target will do the same thing as the
- 'dist' target but also test that distribution to make sure it works. This
- ensures that needed files are not missing and that the src tarball can be
- successfully unbacked, built, installed, and cleaned. This two-level testing
- needs to be done on each target platform.
- -->
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="llvmgccbin">Build the LLVM GCC Binary Distribution</a></div>
+<div class="doc_subsubsection"><a name="llvm-qualify">Qualify LLVM</a></div>
+
<div class="doc_text">
- <p>
- Creating the LLVM GCC binary distribution requires performing the following
- steps for each supported platform:
- </p>
- <ol>
- <li>
- Build the LLVM GCC front-end. The LLVM GCC front-end must be installed in
- a directory named <tt>cfrontend/<platform>/llvm-gcc</tt>. For
- example, the Sparc/Solaris directory is named
- <tt>cfrontend/sparc/llvm-gcc</tt>.
- </li>
-
- <li>
- Build the libraries in <tt>llvm/runtime</tt> and install them into the
- created LLVM GCC installation directory.
- </li>
-
- <li>
- For systems with non-distributable header files (e.g. Solaris), manually
- remove header files that the GCC build process has "fixed." This process
- is admittedly painful, but not as bad as it looks; these header files are
- almost always easily identifiable with simple grep expressions and are
- installed in only a few directories in the GCC installation directory.
- </li>
-
- <li>
- Add the copyright files and header file fix script.
- </li>
-
- <li>
- Archive and compress the installation directory. These can be found in
- previous releases of the LLVM-GCC front-end.
- </li>
- </ol>
+<p>LLVM is qualified when it has a clean test run without a front-end. And it
+ has no regressions when using either <tt>llvm-gcc</tt> or <tt>clang</tt> with
+ the <tt>test-suite</tt> from the previous release.</p>
+
</div>
-<!--
-<div class="doc_subsection"><a name="release">Release</a></div>
+<!-- ======================================================================= -->
+<div class="doc_subsubsection"><a name="llvmgcc-qualify">Qualify LLVM-GCC</a></div>
+
<div class="doc_text">
- <p>Release the distribution tarball to the public. This consists of generating
- several tarballs. The first set, the source distributions, are automatically
- generated by the "make dist" and "make dist-check". There are gzip, bzip2, and
- zip versions of these bundles.</p>
- <p>The second set of tarballs is the binary release. When "make dist-check"
- succeeds, it will have created an _install directory into which it installed
- the binary release. You need to rename that directory as "llvm" and then
- create tarballs from the contents of that "llvm" directory.</p>
- <p>Finally, use rpm to make an rpm package based on the llvm.spec file. Don't
- forget to update the version number, documentation, etc. in the llvm.spec
- file.</p>
+
+<p><tt>LLVM-GCC</tt> is qualified when front-end specific tests in the
+ <tt>llvm</tt> regression test suite all pass and there are no regressions in
+ the <tt>test-suite</tt>.</p>
+
+<p>We do not use the GCC DejaGNU test suite as release criteria.</p>
+
</div>
--->
-<!-- *********************************************************************** -->
-<div class="doc_section"><a name="dist">Distribution Make Targets</a></div>
-<!-- *********************************************************************** -->
<!-- ======================================================================= -->
-<div class="doc_subsection">Overview</div>
+<div class="doc_subsubsection"><a name="clang-qualify">Qualify Clang</a></div>
+
<div class="doc_text">
-<p>The first thing you need to understand is that there are multiple make
-targets to support this feature. Here's an overview, we'll delve into the
-details later.</p>
-<ul>
- <li><b>distdir</b> - builds the distribution directory from which the
- distribution will be packaged</li>
- <li><b>dist</b> - builds each of the distribution tarballs (tar.gz,
- tar.bzip2, .zip). These can be built individually as well, with separate
- targets.</li>
- <li><b>dist-check</b> - this is identical to <tt>dist</tt> but includes a
- check on the distribution that ensures the tarball can: unpack successfully,
- compile correctly, pass 'make check', and pass 'make clean'.</li>
- <li><b>dist-clean</b>- this just does a normal clean but also cleans up the
- stuff generated by the other three <tt>dist</tt> targets (above).</li>
-</ul>
-<p>Okay, that's the basic functionality. When making a release, we want to
-ensure that the tree you build the distribution from passes
-<tt>dist-check</tt>. Beyond fixing the usual bugs, there is generally one
-impediment to making the release in this fashion: missing files. The
-<tt>dist-check</tt> process guards against that possibility. It will either
-fail and that failure will indicate what's missing, or it will succeed
-meaning that it has proved that the tarballs can actually succeed in
-building LLVM correctly and that it passes <tt>make check</tt>.</p>
+
+<p><tt>Clang</tt> is qualified when front-end specific tests in the
+ <tt>llvm</tt> dejagnu test suite all pass, clang's own test suite passes
+ cleanly, and there are no regressions in the <tt>test-suite</tt>.</p>
+
+</div>
+
<!-- ======================================================================= -->
-<div class="doc_subsection">distdir</div>
-<p>This target builds the distribution directory which is the directory from
-which the tarballs are generated. The distribution directory has the same
-name as the release, e.g. LLVM-1.7). This target goes through the following
-process:
-<ol>
- <li>First, if there was an old distribution directory (for the current
- release), it is removed in its entirety and you see <tt>Removing old
- LLVM-1.7</tt></li>
- <li>Second, it issues a <tt>make all ENABLE_OPTIMIZED=3D1</tt> to ensure
- that the everything in your tree can be built in release mode. Often times
- there are discrepancies in building between debug and release modes so it
- enforces release mode first. If that fails, the <tt>distdir</tt> target
- fails too. This is preceded by the message <tt>Making 'all' to verify
- build</tt>.</li>
- <li>Next, it traverses your source tree and copies it to a new directory
- that has the name of the release (<tt>LLVM-M.m</tt> in our current case).
- This is the directory that will get tar'd. It contains all the software
- that needs to be in the distribution. During the copying process, it omits
- generated files, CVS directories, and any other "cruft" that's in your
- build tree. This is done to eliminate the possibility of huge distribution
- tarballs that include useless or irrelevant stuff in them. This is the
- trickiest part of making the distribution. Done manually you will either
- include stuff that shouldn't be in the distribution or exclude stuff that
- should. This step is preceded by the message <tt>Building Distribution
- Directory LLVM-1.7</tt></li>
- <li>The distribution directory is then traversed and all <tt>CVS</tt> or
- <tt>.svn</tt> directories are removed. You see: <tt>Eliminating CVS/.svn
- directories from distribution</tt></li>
- <li>The recursive <tt>dist-hook</tt> target is executed. This gives each
- directory a chance to modify the distribution in some way (more on this
- below).</li>
- <li>The distribution directory is traversed and the correct file
- permissions and modes are set based on the type of file.</li>
-</ol>
-<p>To control the process of making the distribution directory correctly,
-each Makefile can utilize two features:</p>
+<div class="doc_subsubsection"><a name="targets">Specific Target
+Qualification Details</a></div>
+
+<div class="doc_text">
+
+<table>
+ <tr><th>Architecture</th><th>OS</th><th>llvm-gcc baseline</th><th>clang baseline</th><th>tests</th></tr>
+ <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>
+ <tr><td>x86-32</td><td>FreeBSD</td><td>none</td><td>last release</td><td>llvm dejagnu, clang tests, test-suite</td></tr>
+ <tr><td>x86-32</td><td>mingw</td><td>last release</td><td>none</td><td>QT</td></tr>
+ <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>
+ <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>
+ <tr><td>x86-64</td><td>FreeBSD</td><td>none</td><td>last release</td><td>llvm dejagnu, clang tests, test-suite</td></tr>
+</table>
+
+</div>
+
+<!-- ======================================================================= -->
+<div class="doc_subsection"><a name="commTest">Community Testing</a></div>
+<div class="doc_text">
+
+<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>
- <li><b><tt>EXTRA_DIST</tt></B> - this make variable specifies which files
- it should distribute. By default, all source files are automatically
- included for distribution as well as certain <tt>well known</tt> files
- (see DistAlways variable in Makefile.rules for details). Each Makefile
- specifies, via the <tt>EXTRA_DIST</tt> variable, which additional files
- need to be distributed. Only those files that are needed to build LLVM
- should be added to <tt>EXTRA_DIST</tt>. <tt>EXTRA_DIST</tt> contains a
- list of file or directory names that should be distributed. For example,
- the top level Makefile contains
- <tt>EXTRA_DIST := test llvm.spec include</tt>.
- This means that in addition to regular things that are distributed at the
- top level (<tt>CREDITS.txt, LICENSE.txt</tt>, etc.) the distribution should
- contain the entire <tt>test</tt> and <tt>include</tt> directories as well
- as the <tt>llvm.spec</tt> file.</li>
- <li><b><tt>dist-hook</tt></B> - this make target can be used to alter the
- content of the distribution directory. For example, in the top level
- Makefile there is some logic to eliminate files in the <tt>include</tt>
- subtree that are generated by the configure script. These should not be
- distributed. Similarly, any <tt>dist-hook</tt> target found in any
- directory can add or remove or modify things just before it gets packaged.
- Any transformation is permitted. Generally, not much is needed.
+ <li>Download <tt>llvm-<i>X.Y</i></tt>, <tt>llvm-test-<i>X.Y</i></tt>, and the
+ appropriate <tt>llvm-gcc</tt> and/or <tt>clang</tt> binary. Build
+ LLVM. Run <tt>make check</tt> and the full LLVM test suite (<tt>make
+ TEST=nightly report</tt>).</li>
+
+ <li>Download <tt>llvm-<i>X.Y</i></tt>, <tt>llvm-test-<i>X.Y</i></tt>, and the
+ <tt>llvm-gcc</tt> and/or <tt>clang</tt> source. Compile everything. Run
+ <tt>make check</tt> and the full LLVM test suite (<tt>make TEST=nightly
+ report</tt>).</li>
</ol>
-<p>You will see various messages if things go wrong:</p>
+
+<p>Ask LLVM developers to submit the test suite report and <tt>make check</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>make check</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. <i>This
+ is not the time to solve additional and unrelated bugs!</i> 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="doc_subsection"><a name="release-patch">Release Patch Rules</a></div>
+
+<div class="doc_text">
+
+<p>Below are the rules regarding patching the release branch:</p>
+
<ol>
- <li>During the copying process, any files that are missing will be flagged
- with: <tt>===== WARNING: Distribution Source 'dir/file' Not Found!</tt>
- These must be corrected by either adding the file or removing it from
- <tt>EXTRA_DIST</tt>.
- <li>If you build the distribution with <tt>VERBOSE=1</tt>, then you might
- also see: <tt>Skipping non-existent 'dir/file'</tt> in certain cases where
- its okay to skip the file.</li>
- <li>The target can fail if any of the things it does fail. Error messages
- should indicate what went wrong.</li>
+ <li><p>Patches applied to the release branch may only be applied by the
+ release manager.</p></li>
+
+ <li><p>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.</p></li>
+
+ <li><p>During the remaining rounds of testing, only patches that fix critical
+ regressions may be applied.</p></li>
</ol>
+
+</div>
+
<!-- ======================================================================= -->
-<div class="doc_subsection">dist</div>
-<p>This target does exactly what <tt>distdir</tt> target does, but also
-includes assembling the tarballs. There are actually four related targets
-here:<p>
- <ul>
- <li><b><tt>dist-gzip</tt></b>: package the gzipped distribution tar
- file. The distribution directory is packaged into a single file ending in
- <tt>.tar.gz</tt> which is gzip compressed.</li>
- <li><b><tt>dist-bzip2</tt></b>: package the bzip2 distribution tar file.
- The distribution directory is packaged into a single file ending in
- <tt>.tar.bzip2</tt> which is bzip2 compressed.</li>
- <li><b><tt>dist-zip</tt></b>: package the zip distribution file. The
- distribution directory is packaged into a single file ending in
- <tt>.zip</tt> which is zip compressed.</li>
- <li><b><tt>dist</tt></b>: does all three, dist-gzip, dist-bzip2,
- dist-zip</li>
- </ul>
+<div class="doc_subsection"><a name="release-final">Release Final Tasks
+</a></div>
+
+<div class="doc_text">
+
+<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>
+
+
+<!-- ======================================================================= -->
+<div class="doc_subsubsection"><a name="updocs">Update Documentation</a></div>
+
+<div class="doc_text">
+
+<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 avaiable from
+ Subversion and changes in basic system requirements. Merge both changes from
+ mainline into the release branch.</p>
+
+</div>
+
+<!-- ======================================================================= -->
+<div class="doc_subsubsection"><a name="tag">Tag the LLVM Final Release</a></div>
+
+<div class="doc_text">
+
+<p>Tag the final release sources using the following procedure:</p>
+
+<div class="doc_code">
+<pre>
+$ svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_XY \
+ https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XY</i>/Final
+
+$ svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_XY \
+ https://llvm.org/svn/llvm-project/llvm-gcc-4.2/tags/RELEASE_<i>XY</i>/Final
+
+$ svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_XY \
+ https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XY</i>/Final
+
+$ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_XY \
+ https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_<i>XY</i>/Final
+</pre>
+</div>
+
+</div>
+
+<!-- ======================================================================= -->
+<div class="doc_subsection"><a name="updemo">Update the LLVM Demo Page</a></div>
+
+<div class="doc_text">
+
+<p>The LLVM demo page must be updated to use the new release. This consists of
+ using the new <tt>llvm-gcc</tt> binary and building LLVM.</p>
+
+</div>
+
<!-- ======================================================================= -->
-<div class="doc_subsection">dist-check</div>
-<p>This target checks the distribution. The basic idea is that it unpacks the
-distribution tarball and ensures that it can build. It takes the following
-actions:</p>
+<div class="doc_subsubsection"><a name="webupdates">Update the LLVM Website</a></div>
+
+<div class="doc_text">
+
+<p>The website must be updated before the release announcement is sent out. Here
+ is what to do:</p>
+
<ol>
- <li>It depends on the <tt>dist-gzip</tt> target which, if it hasn't already
- been built, builds the gzip tar bundle (see dist and distdir above).</li>
- <li>removes any pre-existing <tt>_distcheckdir</tt> at the top level.</li>
- <li>creates a new <tt>_distcheckdir</tt> directory at the top level.</li>
- <li>creates a <tt>build</tt> subdirectory and an <tt>install</tt>
- subdirectory under <tt>_distcheckdir</tt>.</li>
- <li>unzips and untars the release tarball into <tt>_distcheckdir</tt>,
- creating <tt>LLVM-1.7</tt> directory (from the tarball).</li>
- <li>in the build subdirectory, it configures with appropriate options to build
- from the unpacked source tarball into the <tt>build</tt> directory with
- installation in the <tt>install</tt> directory.</li>
- <li>runs <tt>make all</tt></li>
- <li>runs <tt>make </tt><tt>check</tt></li>
- <li>runs <tt>make install</tt></li>
- <li>runs <tt>make uninstall</tt></li>
- <li>runs <tt>make dist</tt></li>
- <li>runs <tt>make clean</tt></li>
- <li>runs <tt>make dist-clean</tt></li>
+ <li>Check out the <tt>www</tt> module from Subversion.</li>
+
+ <li>Create a new subdirectory <tt>X.Y</tt> in the releases directory.</li>
+
+ <li>Commit the <tt>llvm</tt>, <tt>test-suite</tt>, <tt>llvm-gcc</tt> source,
+ <tt>clang source</tt>, <tt>clang binaries</tt>, and <tt>llvm-gcc</tt>
+ binaries in this new directory.</li>
+
+ <li>Copy and commit the <tt>llvm/docs</tt> and <tt>LICENSE.txt</tt> files
+ into this new directory. The docs should be built with
+ <tt>BUILD_FOR_WEBSITE=1</tt>.</li>
+
+ <li>Commit the <tt>index.html</tt> to the <tt>release/X.Y</tt> directory to
+ redirect (use from previous release.</li>
+
+ <li>Update the <tt>releases/download.html</tt> file with the new release.</li>
+
+ <li>Update the <tt>releases/index.html</tt> with the new release and link to
+ release documentation.</li>
+
+ <li>Finally, update the main page (<tt>index.html</tt> and sidebar) to point
+ to the new release and release announcement. Make sure this all gets
+ committed back into Subversion.</li>
</ol>
-<p>If it can pass all that, the distribution will be deemed distribution
-worth y and you will see:<p>
-<pre>===== LLVM-1.7.tar.gz Ready For Distribution =====</pre>
-<p>This means the tarball should then be tested on other platforms and have the
-nightly test run against it. If those all pass, THEN it is ready for
-distribution.</p>
-<p>
-A note about disk space: using <tt>dist-check</tt> will easily triple the
-amount of disk space your build tree is using. You might want to check
-available space before you begin.</p>
+
+</div>
+
<!-- ======================================================================= -->
-<div class="doc_subsection">dist-clean</div>
-<h2>dist-clean</h2>
-<p>In addition to doing a normal <tt>clean</tt>, this target will clean up the
-files and directories created by the distribution targets. In particular the
-distribution directory <tt>(LLVM-X.X</tt>), check directory
-(<tt>_distcheckdir</tt>), and the various tarballs will be removed. You do
-this after the release has shipped and you no longer need this stuff in your
-build tree.</p>
+<div class="doc_subsubsection"><a name="announce">Announce the Release</a></div>
+
+<div class="doc_text">
+
+<p>Have Chris send out the release announcement when everything is finished.</p>
+
</div>
<!-- *********************************************************************** -->
<hr>
<address>
<a href="http://jigsaw.w3.org/css-validator/check/referer"><img
- src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
+ src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
<a href="http://validator.w3.org/check/referer"><img
- src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
-
- <a href="mailto:rspencer@x10sys.com">Reid Spencer</a><br>
+ src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
<a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
- <br/>
+ <br>
Last modified: $Date$
</address>
</body>
projects / oota-llvm.git / blobdiff