<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_targets">Distribution 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>
+ </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.
+ This document collects information about successfully releasing LLVM
+ (including subprojects llvm-gcc and Clang) to the public.
+ It is the release manager's responsibility to ensure that a high quality
+ build of LLVM is released.
</p>
+</div>
- <p>
- There are three main tasks for building a release of LLVM:
+<!-- *********************************************************************** -->
+<div class="doc_section"><a name="process">Release Timeline</a></div>
+<!-- *********************************************************************** -->
+<div class="doc_text">
+ <p>LLVM is released on a time based schedule (currently every 6 months). We
+ do not have dot releases because of the nature of LLVM incremental
+ development philosophy. The release schedule is roughly as follows:
</p>
-
- <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>
+<ol>
+<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 pre-release for first round of testing. Testing will last 7-10 days.
+During the first round of testing, regressions should be found and fixed. Patches
+are merged from mainline to the release branch.</li>
+<li>Generate and send out second pre-release. Bugs found during this time will
+not be fixed unless absolutely critical. Bugs introduce by patches merged in
+will be fixed and if so, a 3rd round of testing is needed.</li>
+<li>The release notes should be updated during the first and second round of
+pre-release testing.</li>
+<li>Finally, release!</li>
+</ol>
</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="#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="#verchanges">Update LLVM Version </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="#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="#dist">Build the LLVM Source Distributions</a></li>
- <li><a href="#rpm">Build RPM Packages (optional)</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 Release Branch</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_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 Subversion and
- changes in basic system requirements.
- </p>
-</div>
-
-<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="merge">Merge Branches</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 <tt>llvm</tt> and <tt>llvm-gcc</tt>
- Subversion repositories unless it is a bug fix <em>for the release</em>.
- </p>
-</div>
+<div class="doc_subsection"><a name="release-admin">
+Release Administrative Tasks</a></div>
-<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="deps">Make LibDeps.txt</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>
+This section describes a few administrative tasks that need to be done for the
+release process to begin. Specifically, it involves creating the release branch,
+ resetting version numbers, and creating the release tarballs for the release
+ team to begin testing.
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="settle">Settle Subversion HEAD</a></div>
+<div class="doc_subsubsection"><a name="branch">Create Release Branch</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>
-</div>
-
-<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="tag">Subversion Tag And Branch</a></div>
-<div class="doc_text">
- <p>Tag and branch the Subversion HEAD using the following procedure:</p>
+<p>Branch the Subversion HEAD using the following procedure:</p>
<ol>
+ <li>
+ <p>Verify that the current Subversion HEAD is in decent shape by examining
+ nightly tester or buildbot results.</p></li>
<li>
<p>Request all developers to refrain from committing. Offenders get commit
rights taken away (temporarily).</p></li>
-
- <li>
- <p>The Release Manager updates his/her <tt>llvm</tt>, <tt>llvm-test</tt>,
- and <tt>llvm-gcc</tt> source trees with the latest sources from mainline
- Subversion. The Release Manager may want to consider using a new working
- directory for this to keep current uncommitted work separate from release
- work.</p></li>
-
- <li>
- <p>The Release Manager tags his/her <tt>llvm</tt>, <tt>llvm-test</tt>, and
- <tt>llvm-gcc</tt> working directories with "<tt>RELEASE_XX</tt>" where
- <tt>XX</tt> is the major and minor release numbers. So, for Release 1.2,
- <tt>XX=12</tt> and for Release 1.10, <tt>XX=110</tt>.</p>
-
-<div class="doc_code">
+ <li>
+ <p> Create the release branch for <tt>llvm</tt>, <tt>llvm-gcc4.2</tt>,
+ <tt>clang</tt>, and the <tt>test-suite</tt>. The branch name will be
+ <tt>release_XX</tt>,where <tt>XX</tt> is the major and minor release numbers.
+ <tt>Clang</tt> will have a different release number than <tt>llvm</tt>/
+ <tt>llvm-gcc4</tt> since its first release was years later
+ (still deciding if this will be true or not). These branches
+ can be created without checking out anything from subversion.
+ </p>
+
+ <div class="doc_code">
<pre>
svn copy https://llvm.org/svn/llvm-project/llvm/trunk \
- https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XX</i>
-svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.0/trunk \
- https://llvm.org/svn/llvm-project/llvm-gcc-4.0/tags/RELEASE_<i>XX</i>
-svn copy https://llvm.org/svn/llvm-project/test-suite/trunk \
- https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XX</i>
-</pre>
-</div>
- </li>
-
- <li>
- <p>Immediately create Subversion branches based on the
- <tt>RELEASE_<i>XX</i></tt> tag. The tag should be
- "<tt>release_<i>XX</i></tt>" (where XX matches that used for the
- <tt>RELEASE_<i>XX</i></tt> tag). This is where the release distribution
- will be created.</p>
-
-<div class="doc_code">
-<pre>
-svn copy https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XX</i> \
https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XX</i>
-svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.0/tags/RELEASE_<i>XX</i> \
- https://llvm.org/svn/llvm-project/llvm-gcc-4.0/branches/release_<i>XX</i>
-svn copy https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XX</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>XX</i>
+svn copy https://llvm.org/svn/llvm-project/test-suite/trunk \
https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XX</i>
+svn copy https://llvm.org/svn/llvm-project/cfe/trunk \
+ https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XX</i>
</pre>
-</div>
- </li>
+ </div>
- <li>
+ <li>
<p>Advise developers they can work on Subversion HEAD again.</p></li>
-
- <li>
- <p>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>
+
+ <li>
+ <p>The Release Manager 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>
<div class="doc_code">
<pre>
svn co https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XX</i>
-svn co https://llvm.org/svn/llvm-project/llvm-gcc-4.0/branches/release_<i>XX</i>
+svn co https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_<i>XX</i>
svn co https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XX</i>
+svn co https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XX</i>
</pre>
</div></li>
+
</ol>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="verchanges">Update LLVM Version</a></div>
+<div class="doc_subs
ubsection"><a name="verchanges">Update LLVM Version</a></div>
<div class="doc_text">
<p>
- After creating the LLVM release branch, update the release branchs'
+ After creating the LLVM release branch, update the release branches'
autoconf/configure.ac version from X.Xsvn to just X.X. Update it on mainline
- as well to be the next version (X.X+1svn).
+ as well to be the next version (X.X+1svn). Regenerated the configure script
+ for both. This must be done for both <tt>llvm</tt> and the
+ <tt>test-suite</tt>.
</p>
-</div>
-
-<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="build">Build LLVM</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>
-</div>
-
-<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="check">Run 'make check'</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 '<tt>make check</tt>' passes on all platforms for all targets. If
- certain failures cannot be resolved before release time, determine if marking
- them <tt>XFAIL</tt> is appropriate. If not, fix the bug and go back. The test
- suite must complete with "0 unexpected failures" for release.
- </p>
-</div>
-
-<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="test">LLVM Test Suite</a></div>
-<div class="doc_text">
- <p>
- Run the <tt>llvm-test</tt> 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>FIXME: Add a note about <tt>clang</tt>.</p>
+ <p>In addition, the version number of all the Bugzilla components must be
+ updated for the next release.
</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="dist">Build the LLVM Source Distributions</a></div>
+<div class="doc_subs
ubsection"><a name="dist">Build the LLVM Source Distributions</a></div>
<div class="doc_text">
<p>
- Create source distributions for LLVM, LLVM GCC, and the LLVM Test Suite by
- exporting the source from Subversion and archiving it. This can be done with
- the following commands:
+ Create source distributions for <tt>LLVM</tt>, <tt>LLVM-GCC</tt>,
+ <tt>clang</tt>, and the llvm <tt>test-suite</tt> by exporting the source from
+ Subversion and archiving it. This can be done with the following commands:
</p>
<div class="doc_code">
<pre>
-svn export https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XX</i> llvm
-svn export https://llvm.org/svn/llvm-project/llvm-gcc-4.0/branches/release_<i>XX</i> llvm-gcc
-svn export https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XX</i> llvm-test
-mkdir cfrontend; mv llvm-gcc cfrontend/src
-tar -cvf - llvm | gzip > llvm-X.X.tar.gz
-tar -cvf - llvm-test | gzip > llvm-test-X.X.tar.gz
-tar -cvf - cfrontend/src | gzip > cfrontend-X.X.source.tar.gz
+svn export https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XX</i> llvm-X.X
+svn export https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_<i>XX</i> llvm-gcc4.2-X.X.source
+svn export https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XX</i> llvm-test-X.X
+svn export https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XX</i> clang-X.X
+tar -czvf - llvm-X.X | gzip > llvm-X.X.tar.gz
+tar -czvf - llvm-test-X.X | gzip > llvm-test-X.X.tar.gz
+tar -czvf - llvm-gcc4.2-X.X.source | gzip > llvm-gcc-4.2-X.X.source.tar.gz
+tar -czvf - clang-X.X | gzip > clang-X.X.tar.gz
</pre>
</div>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="rpm">Building RPM packages (optional)</a></div>
+<div class="doc_subsection"><a name="release-build">
+Building the Release</a></div>
+
<div class="doc_text">
- <p>
- You can, optionally, create source and binary RPM packages for LLVM. These may
- make it easier to get LLVM into a distribution. This can be done with the
- following commands:
- </p>
+The build of <tt>llvm</tt>, <tt>llvm-gcc</tt>, and <tt>clang</tt> must be free
+of errors and warnings in both debug, release+asserts, and release builds.
+If all builds are clean, then the release passes build qualification.
-<div class="doc_code">
-<pre>
-make dist # Build the distribution source tarball
-make dist-check # Check that the source tarball can build itself.
-cp llvm-M.m.tar.gz /usr/src/redhat/SOURCES # Required by rpmbuild
-make srpm # for source rpm
-make rpm # for binary rpm
-</pre>
+<ol>
+<li>debug: ENABLE_OPTIMIZED=0</li>
+<li>release+asserts: ENABLE_OPTIMIZED=1</li>
+<li>release: ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1</li>
+</ol>
</div>
+<!-- ======================================================================= -->
+<div class="doc_subsubsection"><a name="build">Build LLVM</a></div>
+<div class="doc_text">
<p>
- First, use <tt>make dist</tt> to simply build the distribution. Any failures
- need to be corrected (on the branch). Once <tt>make dist</tt> can be
- successful, do <tt>make dist-check</tt>. This target will do the same thing as
- the 'dist' target but also test that distribution to make sure it can build
- itself and runs <tt>make check</tt> as well. This ensures that needed files
- are not missing and that the src tarball can be successfully unpacked, built,
- installed, and cleaned. Once you have a reliable tarball, you need to copy it
- to the <tt>/usr/src/redhat/SOURCES</tt> directory which is a requirement of
- the rpmbuild tool. The last two <tt>make</tt> invocations just run rpmbuild to
- build either a source (<tt>srpm</tt>) or binary (<tt>rpm</tt>) RPM package.
+ Build both debug, release+asserts (optimized), and release versions of
+ LLVM on all supported platforms. Direction to build llvm are
+ <a href="http://llvm.org/docs/GettingStarted.html#quickstart">here</a>.
</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="llvmgccbin">Build the LLVM GCC Binary Distribution</a></div>
+<div class="doc_subs
ubsection"><a name="llvmgccbin">Build the LLVM GCC Binary Distribution</a></div>
<div class="doc_text">
<p>
- Creating the LLVM GCC binary distribution requires performing the following
- steps for each supported platform:
+ Creating the LLVM GCC binary distribution (release/optimized) 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>.
+ Build the LLVM GCC front-end by following the directions in the README.LLVM
+ file. The frontend must be compiled with c, c++, objc (mac only),
+ objc++ (mac only) and fortran support. </li>
+ <li>Please boostrap as well.</li>
+ <li>Be sure to build with LLVM_VERSION_INFO=X.X, where X is the major and
+ minor release numbers.
</li>
<li>
- Build the libraries in <tt>llvm/runtime</tt> and install them into the
- created LLVM GCC installation directory.
+ 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.
</li>
+ </ol>
+</div>
- <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>
+<!-- ======================================================================= -->
+<div class="doc_subsubsection"><a name="clangbin">Build Clang
+Binary Distribution</a></div>
+<div class="doc_text">
+ <p>
+ Creating the Clang binary distribution (debug/release/release) requires
+ performing the following steps for each supported platform:
+ </p>
+ <ol>
<li>
- Add the copyright files and header file fix script.
+ 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, but the binary
+ will be a release build.</lI>
<li>
- Archive and compress the installation directory. These can be found in
- previous releases of the LLVM-GCC front-end.
+ Package clang (details to follow).
</li>
</ol>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="webupdates">Update the LLVM Website</a></div>
+<div class="doc_subsubsection"><a name="target-build">Target Specific Build
+Details</a></div>
<div class="doc_text">
<p>
- Check out the <tt>website</tt> module from Subversion. Create a new
- subdirectory X.X in the releases directory. Place the <tt>llvm</tt>,
- <tt>llvm-test</tt>, <tt>llvm-gcc</tt> source, and <tt>llvm-gcc</tt> binaries
- in this new directory. Copy the <tt>llvm/docs</tt> and <tt>LICENSE.txt</tt>
- files into this new directory. Update the <tt>releases/download.html</tt> file
- with the new release. Update the <tt>releases/index.html</tt> with the new
- release. 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
- commited back into Subversion.
+ 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>, <tt>clang.
+ </tt></p>
+
+ <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>
</p>
+
</div>
-<!--
-<div class="doc_subsection"><a name="release">Release</a></div>
+
+<!-- ======================================================================= -->
+<div class="doc_subsection"><a name="release-qualify">
+Building the Release</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>
+ A release is qualified when it has no regressions from the previous
+ release (or baseline). Regressions are related to correctness only and not
+ performance at this time. <b>Regressions are new failures in the set of tests that
+ are used to qualify each product and only include things on the list.
+ Ultimately, there is no end to the number of possible bugs in a release. 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 things,
+ but this are things that must be satisfied before a release can go out</b>
</div>
--->
-<!-- *********************************************************************** -->
-<div class="doc_section"><a name="dist_targets">Distribution Targets</a></div>
-<!-- *********************************************************************** -->
<!-- ======================================================================= -->
-<div class="doc_subsection">Overview</div>
+<div class="doc_subsubsection"><a name="llvm-qualify">Qualify LLVM</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 '<tt>make check</tt>', and pass
- '<tt>make clean</tt>'.</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>
+ LLVM is qualified when it has a clean dejagnu test run without a frontend 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_subsubsection"><a name="llvmgcc-qualify">Qualify LLVM-GCC</a></div>
+<div class="doc_text">
<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>
+ <tt>LLVM-GCC</tt> is qualified when front-end specific tests in the
+ <tt>llvm</tt> dejagnu 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_subsection">distdir</div>
+<div class="doc_subsubsection"><a name="clang-qualify">Qualify Clang</a></div>
<div class="doc_text">
- <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:
- </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>
- <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, SVN 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>
+<!-- ======================================================================= -->
+<div class="doc_subsubsection"><a name="targets">Specific Target
+Qualification Details</a></div>
+<div class="doc_text">
+ <p><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></p>
+</div>
+<!-- ======================================================================= -->
+<div class="doc_subsection"><a name="commTest">Community Testing</a></div>
+<div class="doc_text">
<p>
- To control the process of making the distribution directory correctly, each
- Makefile can utilize two features:
- </p>
-
+ Once all testing has been completed and appropriate bugs filed, the pre-release
+ tar balls may be 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>
+ <li>Download llvm-X.X, llvm-test-X.X, and the appropriate llvm-gcc4
+ and/or clang binary. Build LLVM.
+ Run "make check" and the full llvm-test suite (make TEST=nightly report).</li>
+ <li>Download llvm-X.X, llvm-test-X.X, and the llvm-gcc4 and/or clang source.
+ Compile everything. Run "make check" and the full llvm-test suite (make TEST=nightly
+ report).</li>
</ol>
-
- <p>
- You will see various messages if things go wrong:
+ <p>Ask LLVM developers to submit the report and make check results to the list.
+ Attempt to 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 make check at least is
+ clean.</p>
+
+ <p>During the first round of testing time,
+ all regressions must be fixed before the second pre-release is created.</p>
+
+ <p>If this is the second round of testing, this is only to ensure the bug
+ fixes previously merged in have not created new major problems. This is not
+ the time to solve additional and unrelated bugs. If no patches are merged in,
+ the release is determined to be ready and the release manager may move onto
+ the next step.
</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>
- <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 it's 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>
- </ol>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection">dist</div>
+<div class="doc_subsection"><a name="release-patch">Release Patch Rules
+</a></div>
<div class="doc_text">
<p>
- This target does exactly what <tt>distdir</tt> target does, but also includes
- assembling the tarballs. There are actually four related targets here:
+ Below are the rules regarding patching the release branch.</p>
+ <p>
+ <li>Patches applied to the release branch are only 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 and 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 regressions
+ may be applied.</li>
+
</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>
+
<!-- ======================================================================= -->
-<div class="doc_subsection">dist-check</div>
+<div class="doc_subsection"><a name="release-final">Release Final Tasks
+</a></div>
<div class="doc_text">
<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>
+ The final stages of the release process involving tagging the release branch,
+ updating documentation that refers to the release, and updating the demo
+ page.</p>
+ <p>FIXME: Add a note if anything needs to be done to the clang website.
+ Eventually the websites will be merged hopefully.</p>
+</div>
- <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>
- </ol>
+<!-- ======================================================================= -->
+<div class="doc_subsubsection"><a name="updocs">Update Documentation</a></div>
+<div class="doc_text">
<p>
- If it can pass all that, the distribution will be deemed distribution worth y
- and you will see:
+ 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 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 Release Branch</a></div>
+<div class="doc_text">
+ <p>Tag the release branch using the following procedure:</p>
+<div class="doc_code">
+<pre>
+svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_XX \
+ https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XX</i>
+svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_XX \
+ https://llvm.org/svn/llvm-project/llvm-gcc-4.2/tags/RELEASE_<i>XX</i>
+svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_XX \
+ https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XX</i>
+</pre>
+</div>
+</div>
- <pre>===== LLVM-1.7.tar.gz Ready For Distribution =====</pre>
+
+<!-- ======================================================================= -->
+<div class="doc_subsection"><a name="updemo">Update the LLVM Demo Page</a></div>
+<div class="doc_text">
<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>
+ The LLVM demo page must be updated to use the new release. This consists of
+ using the llvm-gcc binary and building LLVM. Update the website demo page
+ configuration to use the new release.</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection">dist-clean</div>
+<div class="doc_subsubsection"><a name="webupdates">Update the LLVM Website</a></div>
<div class="doc_text">
<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>
+ The website must be updated before the release announcement is sent out. Here is
+ what to do:</p>
+ <ol>
+ <li> Check out the <tt>website</tt> module from CVS. </li>
+ <li> Create a new subdirectory X.X 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 BUILD_FOR_WEBSITE=1.</li>
+ <li> Commit the index.html to the release/X.X 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>
+</div>
+
+<!-- ======================================================================= -->
+<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