2006-03-23 06:45:42 +00:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
|
|
|
|
|
"http://www.w3.org/TR/html4/strict.dtd">
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<title>How To Release LLVM To The Public</title>
|
|
|
|
|
<link rel="stylesheet" href="llvm.css" type="text/css">
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<div class="doc_title">How To Release LLVM To The Public</div>
|
|
|
|
|
<ol>
|
|
|
|
|
<li><a href="#introduction">Introduction</a></li>
|
2009-08-18 22:33:28 +00:00
|
|
|
<li><a href="#criteria">Qualification Criteria</a></li>
|
2007-09-28 22:50:54 +00:00
|
|
|
<li><a href="#introduction">Release Timeline</a></li>
|
2006-04-10 21:43:05 +00:00
|
|
|
<li><a href="#process">Release Process</a></li>
|
2006-03-23 06:45:42 +00:00
|
|
|
</ol>
|
|
|
|
|
<div class="doc_author">
|
2009-08-18 22:33:28 +00:00
|
|
|
<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>
|
2006-03-23 06:45:42 +00:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
<div class="doc_section"><a name="introduction">Introduction</a></div>
|
|
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
2007-07-23 04:41:42 +00:00
|
|
|
<p>
|
2009-08-18 22:33:28 +00:00
|
|
|
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
|
2007-09-28 22:50:54 +00:00
|
|
|
build of LLVM is released.
|
2007-07-23 04:41:42 +00:00
|
|
|
</p>
|
2006-03-23 06:45:42 +00:00
|
|
|
</div>
|
|
|
|
|
|
2007-09-28 22:50:54 +00:00
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
<div class="doc_section"><a name="process">Release Timeline</a></div>
|
|
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
<div class="doc_text">
|
2009-08-18 22:33:28 +00:00
|
|
|
<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
|
2009-10-12 14:46:08 +00:00
|
|
|
development philosophy. The release schedule is roughly as follows:
|
2009-08-18 22:33:28 +00:00
|
|
|
</p>
|
2007-09-28 22:50:54 +00:00
|
|
|
<ol>
|
2009-08-18 22:33:28 +00:00
|
|
|
<li>Set code freeze and branch creation date for 6 months after last code freeze
|
2007-09-28 22:50:54 +00:00
|
|
|
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>
|
|
|
|
|
|
|
|
|
|
|
2006-03-23 06:45:42 +00:00
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
<div class="doc_section"><a name="process">Release Process</a></div>
|
|
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
<ol>
|
2009-08-18 22:33:28 +00:00
|
|
|
<li><a href="#release-admin">Release Administrative Tasks</a></li>
|
|
|
|
|
<ol>
|
2007-09-28 22:50:54 +00:00
|
|
|
<li><a href="#branch">Create Release Branch</a></li>
|
2009-08-18 22:33:28 +00:00
|
|
|
<li><a href="#verchanges">Update Version Numbers</a></li>
|
|
|
|
|
</ol>
|
|
|
|
|
<li><a href="#release-build">Building the Release</a></li>
|
|
|
|
|
<ol>
|
2007-09-28 22:50:54 +00:00
|
|
|
<li><a href="#dist">Build the LLVM Source Distributions</a></li>
|
2006-04-10 21:43:05 +00:00
|
|
|
<li><a href="#build">Build LLVM</a></li>
|
2009-08-18 22:33:28 +00:00
|
|
|
<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>
|
2007-09-28 22:50:54 +00:00
|
|
|
<li><a href="#updocs">Update Documentation</a></li>
|
2009-08-19 23:07:37 +00:00
|
|
|
<li><a href="#tag">Tag the LLVM Release Branch</a></li>
|
2007-09-28 22:50:54 +00:00
|
|
|
<li><a href="#updemo">Update the LLVM Demo Page</a></li>
|
2006-08-10 00:23:05 +00:00
|
|
|
<li><a href="#webupdates">Update the LLVM Website</a></li>
|
2007-09-28 22:50:54 +00:00
|
|
|
<li><a href="#announce">Announce the Release</a></li>
|
2009-08-18 22:33:28 +00:00
|
|
|
</ol>
|
2007-09-28 22:50:54 +00:00
|
|
|
|
2006-03-23 06:45:42 +00:00
|
|
|
</ol>
|
|
|
|
|
</div>
|
|
|
|
|
|
2006-04-11 20:24:28 +00:00
|
|
|
<!-- ======================================================================= -->
|
2009-08-18 22:33:28 +00:00
|
|
|
<div class="doc_subsection"><a name="release-admin">
|
|
|
|
|
Release Administrative Tasks</a></div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
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_subsubsection"><a name="branch">Create Release Branch</a></div>
|
2006-03-23 06:45:42 +00:00
|
|
|
<div class="doc_text">
|
2007-09-28 22:50:54 +00:00
|
|
|
<p>Branch the Subversion HEAD using the following procedure:</p>
|
2006-04-11 20:24:28 +00:00
|
|
|
<ol>
|
2007-09-28 22:50:54 +00:00
|
|
|
<li>
|
2009-08-18 22:33:28 +00:00
|
|
|
<p>Verify that the current Subversion HEAD is in decent shape by examining
|
|
|
|
|
nightly tester or buildbot results.</p></li>
|
2006-04-11 20:24:28 +00:00
|
|
|
<li>
|
2007-07-23 04:41:42 +00:00
|
|
|
<p>Request all developers to refrain from committing. Offenders get commit
|
|
|
|
|
rights taken away (temporarily).</p></li>
|
2007-09-28 22:50:54 +00:00
|
|
|
<li>
|
2009-08-18 22:33:28 +00:00
|
|
|
<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.
|
2009-08-19 23:07:37 +00:00
|
|
|
<tt>Clang</tt> will have a different release number than <tt>llvm</tt>/
|
2009-08-18 22:33:28 +00:00
|
|
|
<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.
|
2007-09-28 22:50:54 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<div class="doc_code">
|
2007-07-23 04:41:42 +00:00
|
|
|
<pre>
|
|
|
|
|
svn copy https://llvm.org/svn/llvm-project/llvm/trunk \
|
|
|
|
|
https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XX</i>
|
2007-09-28 22:50:54 +00:00
|
|
|
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 \
|
2007-07-23 04:41:42 +00:00
|
|
|
https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XX</i>
|
2009-08-18 22:33:28 +00:00
|
|
|
svn copy https://llvm.org/svn/llvm-project/cfe/trunk \
|
|
|
|
|
https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XX</i>
|
2007-07-23 04:41:42 +00:00
|
|
|
</pre>
|
2007-09-28 22:50:54 +00:00
|
|
|
</div>
|
2006-04-11 20:24:28 +00:00
|
|
|
|
2007-09-28 22:50:54 +00:00
|
|
|
<li>
|
2007-07-23 04:41:42 +00:00
|
|
|
<p>Advise developers they can work on Subversion HEAD again.</p></li>
|
2007-09-28 22:50:54 +00:00
|
|
|
|
|
|
|
|
<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>
|
2007-07-23 04:41:42 +00:00
|
|
|
|
|
|
|
|
<div class="doc_code">
|
|
|
|
|
<pre>
|
|
|
|
|
svn co https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XX</i>
|
2007-09-28 22:50:54 +00:00
|
|
|
svn co https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_<i>XX</i>
|
2007-07-23 04:41:42 +00:00
|
|
|
svn co https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XX</i>
|
2009-08-18 22:33:28 +00:00
|
|
|
svn co https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XX</i>
|
2007-07-23 04:41:42 +00:00
|
|
|
</pre>
|
2007-07-23 04:44:02 +00:00
|
|
|
</div></li>
|
2007-09-28 22:50:54 +00:00
|
|
|
|
2007-07-23 04:44:02 +00:00
|
|
|
</ol>
|
2006-03-23 06:45:42 +00:00
|
|
|
</div>
|
|
|
|
|
|
2006-08-10 00:23:05 +00:00
|
|
|
<!-- ======================================================================= -->
|
2009-08-18 22:33:28 +00:00
|
|
|
<div class="doc_subsubsection"><a name="verchanges">Update LLVM Version</a></div>
|
2006-08-10 00:23:05 +00:00
|
|
|
<div class="doc_text">
|
|
|
|
|
<p>
|
2007-09-28 22:50:54 +00:00
|
|
|
After creating the LLVM release branch, update the release branches'
|
2007-07-23 04:41:42 +00:00
|
|
|
autoconf/configure.ac version from X.Xsvn to just X.X. Update it on mainline
|
2007-09-28 22:50:54 +00:00
|
|
|
as well to be the next version (X.X+1svn). Regenerated the configure script
|
2009-08-19 23:07:37 +00:00
|
|
|
for both. This must be done for both <tt>llvm</tt> and the
|
|
|
|
|
<tt>test-suite</tt>.
|
2007-09-28 22:50:54 +00:00
|
|
|
</p>
|
2009-08-19 23:07:37 +00:00
|
|
|
<p>FIXME: Add a note about <tt>clang</tt>.</p>
|
2007-09-28 22:50:54 +00:00
|
|
|
<p>In addition, the version number of all the Bugzilla components must be
|
|
|
|
|
updated for the next release.
|
2006-08-10 00:23:05 +00:00
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
2007-09-28 22:50:54 +00:00
|
|
|
<!-- ======================================================================= -->
|
2009-08-18 22:33:28 +00:00
|
|
|
<div class="doc_subsubsection"><a name="dist">Build the LLVM Source Distributions</a></div>
|
2007-09-28 22:50:54 +00:00
|
|
|
<div class="doc_text">
|
|
|
|
|
<p>
|
2009-08-19 23:07:37 +00:00
|
|
|
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:
|
2007-09-28 22:50:54 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<div class="doc_code">
|
|
|
|
|
<pre>
|
|
|
|
|
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
|
2009-08-18 22:33:28 +00:00
|
|
|
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
|
2009-08-23 04:36:30 +00:00
|
|
|
tar -czvf - clang-X.X | gzip > clang-X.X.tar.gz
|
2007-09-28 22:50:54 +00:00
|
|
|
</pre>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
2006-03-23 06:45:42 +00:00
|
|
|
<!-- ======================================================================= -->
|
2009-08-18 22:33:28 +00:00
|
|
|
<div class="doc_subsection"><a name="release-build">
|
|
|
|
|
Building the Release</a></div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
2009-08-19 23:07:37 +00:00
|
|
|
The build of <tt>llvm</tt>, <tt>llvm-gcc</tt>, and <tt>clang</tt> must be free
|
2009-08-23 04:36:30 +00:00
|
|
|
of errors and warnings in both debug, release, and release-asserts builds.
|
|
|
|
|
If all builds are clean, then the release passes build qualification.
|
|
|
|
|
|
|
|
|
|
<ol>
|
|
|
|
|
<li>debug: ENABLE_OPTIMIZED=0</li>
|
|
|
|
|
<li>release: ENABLE_OPTIMIZED=1</li>
|
|
|
|
|
<li>release-asserts: ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1</li>
|
|
|
|
|
</ol>
|
2009-08-18 22:33:28 +00:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsubsection"><a name="build">Build LLVM</a></div>
|
2006-03-23 06:45:42 +00:00
|
|
|
<div class="doc_text">
|
2006-04-11 20:24:28 +00:00
|
|
|
<p>
|
2009-08-23 04:36:30 +00:00
|
|
|
Build both debug, release (optimized), and release-asserts versions of
|
|
|
|
|
LLVM on all supported platforms. Direction to build llvm are
|
2009-08-19 23:07:37 +00:00
|
|
|
<a href="http://llvm.org/docs/GettingStarted.html#quickstart">here</a>.
|
2006-04-11 20:24:28 +00:00
|
|
|
</p>
|
2007-09-28 22:50:54 +00:00
|
|
|
</div>
|
2006-04-11 20:24:28 +00:00
|
|
|
|
2007-09-28 22:50:54 +00:00
|
|
|
<!-- ======================================================================= -->
|
2009-08-18 22:33:28 +00:00
|
|
|
<div class="doc_subsubsection"><a name="llvmgccbin">Build the LLVM GCC Binary Distribution</a></div>
|
2007-09-28 22:50:54 +00:00
|
|
|
<div class="doc_text">
|
2006-04-11 20:24:28 +00:00
|
|
|
<p>
|
2007-09-28 22:50:54 +00:00
|
|
|
Creating the LLVM GCC binary distribution (release/optimized) requires
|
|
|
|
|
performing the following steps for each supported platform:
|
2006-04-11 20:24:28 +00:00
|
|
|
</p>
|
2007-09-28 22:50:54 +00:00
|
|
|
|
|
|
|
|
<ol>
|
|
|
|
|
<li>
|
|
|
|
|
Build the LLVM GCC front-end by following the directions in the README.LLVM
|
2009-08-19 23:07:37 +00:00
|
|
|
file. The frontend must be compiled with c, c++, objc (mac only),
|
2009-08-23 04:36:30 +00:00
|
|
|
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
|
2007-09-28 22:50:54 +00:00
|
|
|
minor release numbers.
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
Copy the installation directory to a directory named for the specific target.
|
|
|
|
|
For example on Red Hat Enterprise Linux, the directory would be named
|
2009-08-18 22:33:28 +00:00
|
|
|
<tt>llvm-gcc4.2-2.6-x86-linux-RHEL4</tt>. Archive and compress the new directory.
|
2007-09-28 22:50:54 +00:00
|
|
|
</li>
|
|
|
|
|
</ol>
|
2006-03-23 06:45:42 +00:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
2009-08-19 23:07:37 +00:00
|
|
|
<div class="doc_subsubsection"><a name="clangbin">Build Clang
|
|
|
|
|
Binary Distribution</a></div>
|
2006-03-23 06:45:42 +00:00
|
|
|
<div class="doc_text">
|
2007-07-23 04:41:42 +00:00
|
|
|
<p>
|
2009-08-23 04:36:30 +00:00
|
|
|
Creating the Clang binary distribution (debug/release/release-asserts) requires
|
2009-08-18 22:33:28 +00:00
|
|
|
performing the following steps for each supported platform:
|
2006-04-11 20:24:28 +00:00
|
|
|
</p>
|
|
|
|
|
|
2009-08-18 22:33:28 +00:00
|
|
|
<ol>
|
|
|
|
|
<li>
|
2009-08-19 23:07:37 +00:00
|
|
|
Build clang according to the directions
|
|
|
|
|
<a href="http://clang.llvm.org/get_started.html">here</a>.
|
2009-08-18 22:33:28 +00:00
|
|
|
</li>
|
2009-08-19 23:07:37 +00:00
|
|
|
|
|
|
|
|
<li>Build both a debug and release version of clang, but the binary
|
|
|
|
|
will be a release build.</lI>
|
2009-08-18 22:33:28 +00:00
|
|
|
|
|
|
|
|
<li>
|
2009-08-19 23:07:37 +00:00
|
|
|
Package clang (details to follow).
|
2009-08-18 22:33:28 +00:00
|
|
|
</li>
|
|
|
|
|
</ol>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsubsection"><a name="target-build">Target Specific Build
|
|
|
|
|
Details</a></div>
|
|
|
|
|
<div class="doc_text">
|
2006-04-11 20:24:28 +00:00
|
|
|
<p>
|
2009-08-19 23:07:37 +00:00
|
|
|
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>
|
2009-08-23 04:36:30 +00:00
|
|
|
<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>
|
2009-08-19 23:07:37 +00:00
|
|
|
<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>
|
2009-08-23 04:36:30 +00:00
|
|
|
<tr><td>x86-64</td><td>FreeBSD</td><td>gcc 4.2.X</td></tr>
|
2009-08-19 23:07:37 +00:00
|
|
|
|
|
|
|
|
</table>
|
2006-04-11 06:21:25 +00:00
|
|
|
</p>
|
2009-08-19 23:07:37 +00:00
|
|
|
|
2006-03-23 06:45:42 +00:00
|
|
|
</div>
|
|
|
|
|
|
2009-08-18 22:33:28 +00:00
|
|
|
|
2006-03-23 06:45:42 +00:00
|
|
|
<!-- ======================================================================= -->
|
2009-08-18 22:33:28 +00:00
|
|
|
<div class="doc_subsection"><a name="release-qualify">
|
|
|
|
|
Building the Release</a></div>
|
|
|
|
|
|
|
|
|
|
<div class="doc_text">
|
2009-08-19 23:07:37 +00:00
|
|
|
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
|
2009-08-23 04:36:30 +00:00
|
|
|
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>
|
2009-08-18 22:33:28 +00:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsubsection"><a name="llvm-qualify">Qualify LLVM</a></div>
|
2006-03-23 06:45:42 +00:00
|
|
|
<div class="doc_text">
|
2007-07-23 04:41:42 +00:00
|
|
|
<p>
|
2009-08-19 23:07:37 +00:00
|
|
|
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>
|
2006-08-16 00:54:50 +00:00
|
|
|
</div>
|
2006-03-23 06:45:42 +00:00
|
|
|
|
2006-08-16 00:54:50 +00:00
|
|
|
<!-- ======================================================================= -->
|
2009-08-18 22:33:28 +00:00
|
|
|
<div class="doc_subsubsection"><a name="llvmgcc-qualify">Qualify LLVM-GCC</a></div>
|
2006-08-16 00:54:50 +00:00
|
|
|
<div class="doc_text">
|
2007-07-23 04:41:42 +00:00
|
|
|
<p>
|
2009-08-19 23:07:37 +00:00
|
|
|
<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>
|
2009-08-18 22:33:28 +00:00
|
|
|
</div>
|
2007-07-23 04:41:42 +00:00
|
|
|
|
2009-08-18 22:33:28 +00:00
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsubsection"><a name="clang-qualify">Qualify Clang</a></div>
|
|
|
|
|
<div class="doc_text">
|
2009-08-19 23:07:37 +00:00
|
|
|
<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>
|
2007-07-23 04:41:42 +00:00
|
|
|
</div>
|
|
|
|
|
|
2009-08-18 22:33:28 +00:00
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsubsection"><a name="targets">Specific Target
|
|
|
|
|
Qualification Details</a></div>
|
|
|
|
|
<div class="doc_text">
|
2009-08-19 23:07:37 +00:00
|
|
|
<p><table>
|
|
|
|
|
<tr><th>Architecture</th><th>OS</th><th>llvm-gcc baseline</th><th>clang baseline
|
|
|
|
|
</th><th>tests</th></tr>
|
2010-04-05 18:35:37 +00:00
|
|
|
<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>
|
2009-08-19 23:07:37 +00:00
|
|
|
<tr><td>x86-32</td><td>mingw</td><td>last release</td><td>none</td><td>QT</td></tr>
|
2010-04-05 18:35:37 +00:00
|
|
|
<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>
|
2009-08-19 23:07:37 +00:00
|
|
|
</table></p>
|
2006-04-11 20:24:28 +00:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
2009-08-18 22:33:28 +00:00
|
|
|
<div class="doc_subsection"><a name="commTest">Community Testing</a></div>
|
2006-04-11 20:24:28 +00:00
|
|
|
<div class="doc_text">
|
|
|
|
|
<p>
|
2007-09-28 22:50:54 +00:00
|
|
|
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>
|
2006-04-11 20:24:28 +00:00
|
|
|
<ol>
|
2009-08-19 23:07:37 +00:00
|
|
|
<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
|
2007-09-28 22:50:54 +00:00
|
|
|
report).</li>
|
|
|
|
|
</ol>
|
|
|
|
|
<p>Ask LLVM developers to submit the report and make check results to the list.
|
2009-08-19 23:07:37 +00:00
|
|
|
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>
|
2007-09-28 22:50:54 +00:00
|
|
|
|
2009-08-19 23:07:37 +00:00
|
|
|
<p>During the first round of testing time,
|
|
|
|
|
all regressions must be fixed before the second pre-release is created.</p>
|
2007-09-28 22:50:54 +00:00
|
|
|
|
2009-08-19 23:07:37 +00:00
|
|
|
<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>
|
2007-09-28 22:50:54 +00:00
|
|
|
</div>
|
2006-04-11 20:24:28 +00:00
|
|
|
|
2009-08-18 22:33:28 +00:00
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsection"><a name="release-patch">Release Patch Rules
|
|
|
|
|
</a></div>
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
<p>
|
2009-08-19 23:07:37 +00:00
|
|
|
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>
|
2009-08-18 22:33:28 +00:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<div class="doc_subsection"><a name="release-final">Release Final Tasks
|
|
|
|
|
</a></div>
|
|
|
|
|
<div class="doc_text">
|
|
|
|
|
<p>
|
2009-08-19 23:07:37 +00:00
|
|
|
The final stages of the release process involving taging 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>
|
2009-08-18 22:33:28 +00:00
|
|
|
</div>
|
|
|
|
|
|
2006-04-11 20:24:28 +00:00
|
|
|
|
2009-08-19 23:07:37 +00:00
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<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 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>
|
|
|
|
|
|
2007-09-28 22:50:54 +00:00
|
|
|
<!-- ======================================================================= -->
|
2009-08-18 22:33:28 +00:00
|
|
|
<div class="doc_subsubsection"><a name="tag">Tag the Release Branch</a></div>
|
2007-09-28 22:50:54 +00:00
|
|
|
<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>
|
2006-04-11 20:24:28 +00:00
|
|
|
|
2009-08-19 23:07:37 +00:00
|
|
|
|
2006-03-23 06:45:42 +00:00
|
|
|
|
2007-09-28 22:50:54 +00:00
|
|
|
<!-- ======================================================================= -->
|
|
|
|
|
<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 llvm-gcc binary and building LLVM. Update the website demo page
|
|
|
|
|
configuration to use the new release.</p>
|
|
|
|
|
</div>
|
2006-08-10 00:23:05 +00:00
|
|
|
|
|
|
|
|
<!-- ======================================================================= -->
|
2009-08-18 22:33:28 +00:00
|
|
|
<div class="doc_subsubsection"><a name="webupdates">Update the LLVM Website</a></div>
|
2006-08-10 00:23:05 +00:00
|
|
|
<div class="doc_text">
|
|
|
|
|
<p>
|
2007-09-28 22:50:54 +00:00
|
|
|
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>
|
2009-08-19 23:07:37 +00:00
|
|
|
<li> Commit the <tt>llvm</tt>, <tt>test-suite</tt>, <tt>llvm-gcc</tt> source,
|
|
|
|
|
<tt>clang source</tt>, <tt>clang binaries</tt>,
|
2007-09-28 22:50:54 +00:00
|
|
|
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
|
2007-07-23 04:41:42 +00:00
|
|
|
point to the new release and release announcement. Make sure this all gets
|
2009-10-12 14:46:08 +00:00
|
|
|
committed back into Subversion.</li>
|
2007-09-28 22:50:54 +00:00
|
|
|
</ol>
|
2006-08-10 00:23:05 +00:00
|
|
|
</div>
|
|
|
|
|
|
2007-09-28 22:50:54 +00:00
|
|
|
<!-- ======================================================================= -->
|
2009-08-18 22:33:28 +00:00
|
|
|
<div class="doc_subsubsection"><a name="announce">Announce the Release</a></div>
|
2006-03-23 06:45:42 +00:00
|
|
|
<div class="doc_text">
|
2007-09-28 22:50:54 +00:00
|
|
|
<p>Have Chris send out the release announcement when everything is finished.</p>
|
2006-03-23 06:45:42 +00:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- *********************************************************************** -->
|
|
|
|
|
<hr>
|
|
|
|
|
<address>
|
|
|
|
|
<a href="http://jigsaw.w3.org/css-validator/check/referer"><img
|
2008-12-11 17:34:48 +00:00
|
|
|
src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
|
2006-03-23 06:45:42 +00:00
|
|
|
<a href="http://validator.w3.org/check/referer"><img
|
2008-12-11 18:23:24 +00:00
|
|
|
src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
|
2006-03-23 06:45:42 +00:00
|
|
|
<a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
|
2008-12-11 18:23:24 +00:00
|
|
|
<br>
|
2006-03-23 06:45:42 +00:00
|
|
|
Last modified: $Date$
|
|
|
|
|
</address>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
