X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FHowToReleaseLLVM.html;h=30c3d5da5e9360292664cfe1918fb8dfd048abc0;hb=b894f96de4f26dd738e3bf706ffe7cf0eda60714;hp=8b95ac66fc5635151f1803aedec04773a1ff46a5;hpb=9ceece5f7d18017551e4766b06afe2b619dbe339;p=oota-llvm.git diff --git a/docs/HowToReleaseLLVM.html b/docs/HowToReleaseLLVM.html index 8b95ac66fc5..30c3d5da5e9 100644 --- a/docs/HowToReleaseLLVM.html +++ b/docs/HowToReleaseLLVM.html @@ -2,508 +2,579 @@ "http://www.w3.org/TR/html4/strict.dtd">
+NOTE: THIS DOCUMENT IS A WORK IN PROGRESS!
+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 contains information about successfully releasing LLVM — + including subprojects: e.g., clang and dragonegg — to + the public. It is the Release Manager's responsibility to ensure that a high + quality build of LLVM is released.
--There are three main tasks for building a release of LLVM: -
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.
+ +The release process is roughly as follows:
+ +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.
Create release branch and begin release process.
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.
Generate and send out the second release candidate sources. Only + critial 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.
The release notes are updated.
Finally, release!
- 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. -
+This section describes a few administrative tasks that need to be done for + the release process to begin. Specifically, it involves:
+ +Branch the Subversion trunk using the following procedure:
+ +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.
Verify that the current Subversion trunk is in decent shape by + examining nightly tester and buildbot results.
Create the release branch for llvm, clang, + the test-suite, and dragonegg from the last known good + revision. The branch's name is release_XY, + where X is the major and Y the minor release + numbers. The branches should be created using the following commands:
+ ++$ svn copy https://llvm.org/svn/llvm-project/llvm/trunk \ + https://llvm.org/svn/llvm-project/llvm/branches/release_XY + +$ svn copy https://llvm.org/svn/llvm-project/cfe/trunk \ + https://llvm.org/svn/llvm-project/cfe/branches/release_XY + +$ svn copy https://llvm.org/svn/llvm-project/dragonegg/trunk \ + https://llvm.org/svn/llvm-project/dragonegg/branches/release_XY + +$ svn copy https://llvm.org/svn/llvm-project/test-suite/trunk \ + https://llvm.org/svn/llvm-project/test-suite/branches/release_XY ++
Advise developers that they may now check their patches into the + Subversion tree again.
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:
+ ++$ svn co https://llvm.org/svn/llvm-project/llvm/branches/release_XY llvm-X.Y + +$ svn co https://llvm.org/svn/llvm-project/cfe/branches/release_XY clang-X.Y + +$ svn co https://llvm.org/svn/llvm-project/dragonegg/branches/release_XY dragonegg-X.Y + +$ svn co https://llvm.org/svn/llvm-project/test-suite/branches/release_XY test-suite-X.Y ++
-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. -
- --From this point until the release branch is created, developers should -not -commit changes to the llvm and llvm-gcc CVS repositories unless it is a bug -fix for the release. -
+After creating the LLVM release branch, update the release branches' + autoconf and configure.ac versions from 'X.Ysvn' + to 'X.Y'. Update it on mainline as well to be the next version + ('X.Y+1svn'). Regenerate the configure scripts for both + llvm and the test-suite.
+ +In addition, the version numbers of all the Bugzilla components must be + updated for the next release.
+Rebuild the LibDeps.txt target in utils/llvm-config. This - makes sure that the llvm-config utility remains relevant for the - release, reflecting any changes in the library dependencies.
+Create release candidates for llvm, clang, + dragonegg, and the LLVM test-suite by tagging the branch + with the respective release candidate number. For instance, to + create Release Candidate 1 you would issue the following commands:
+ ++$ svn mkdir https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_XY +$ svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_XY \ + https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_XY/rc1 + +$ svn mkdir https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_XY +$ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_XY \ + https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_XY/rc1 + +$ svn mkdir https://llvm.org/svn/llvm-project/dragonegg/tags/RELEASE_XY +$ svn copy https://llvm.org/svn/llvm-project/dragonegg/branches/release_XY \ + https://llvm.org/svn/llvm-project/dragonegg/tags/RELEASE_XY/rc1 + +$ svn mkdir https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_XY +$ svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_XY \ + https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_XY/rc1 +
Similarly, Release Candidate 2 would be named RC2 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 RELEASE_XY directory as Final + (c.f. Tag the LLVM Final Release).
+ +The Release Manager may supply pre-packaged source tarballs for users. This + can be done with the following commands:
+ ++$ svn export https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_XY/rc1 llvm-X.Yrc1 +$ svn export https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_XY/rc1 clang-X.Yrc1 +$ svn export https://llvm.org/svn/llvm-project/dragonegg/tags/RELEASE_XY/rc1 dragonegg-X.Yrc1 +$ svn export https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_XY/rc1 llvm-test-X.Yrc1 + +$ tar -cvf - llvm-X.Yrc1 | gzip > llvm-X.Yrc1.src.tar.gz +$ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.gz +$ tar -cvf - dragonegg-X.Yrc1 | gzip > dragonegg-X.Yrc1.src.tar.gz +$ tar -cvf - llvm-test-X.Yrc1 | gzip > llvm-test-X.Yrc1.src.tar.gz ++
- 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. -
Tag and branch the CVS HEAD using the following procedure:
-
- cvs tag ROOT_RELEASE_XX
-
- cvs tag -b -r ROOT_RELEASE_XX release_XX -
-
- cvs -d <CVS Repository> co -r release_XX llvm
- cvs -d <CVS Repository> co -r release_XX llvm-test
- cvs -d <CVS Repository> co -r release_XX llvm-gcc
-
- After creating the llvm release branch, update the release branch's autoconf/configure.ac - version from X.Xcvs to just X.X. Update it on mainline as well to be the next version - (X.X+1cvs). -
+The builds of llvm, clang, and dragonegg + must be free of errors and warnings in Debug, Release+Asserts, and + Release builds. If all builds are clean, then the release passes Build + Qualification.
+ +The make options for building the different modes:
+ +Mode | Options |
---|---|
Debug | ENABLE_OPTIMIZED=0 |
Release+Asserts | ENABLE_OPTIMIZED=1 |
Release | ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1 |
- Build both debug and release (optimized) versions of LLVM on all - platforms. Ensure the build is warning and error free on each platform. -
+Build Debug, Release+Asserts, and Release versions + of llvm on all supported platforms. Directions to build + llvm are here.
-- 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 llvm/runtime libraries. -
Run make check and ensure there are no unexpected failures. If - there are, resolve the failures, commit them back into the release branch, - and restart testing by re-building LLVM. -
+Creating the clang binary distribution + (Debug/Release+Asserts/Release) requires performing the following steps for + each supported platform:
+ +- 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. -
Run the llvm-test suite and ensure there are no unacceptable failures. - If there are, resolve the failures and go back to - re-building LLVM. The test suite - should be run in Nightly Test mode. All tests must pass. +
The table below specifies which compilers are used for each Arch/OS + combination when qualifying the build of llvm, clang, + and dragonegg.
+ +Architecture | OS | compiler |
---|---|---|
x86-32 | Mac OS 10.5 | gcc 4.0.1 |
x86-32 | Linux | gcc 4.2.X, gcc 4.3.X |
x86-32 | FreeBSD | gcc 4.2.X |
x86-32 | mingw | gcc 3.4.5 |
x86-64 | Mac OS 10.5 | gcc 4.0.1 |
x86-64 | Linux | gcc 4.2.X, gcc 4.3.X |
x86-64 | FreeBSD | gcc 4.2.X |
- 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: -
+
- cvs -d <CVS Repository> export -r release_XX llvm
- cvs -d <CVS Repository> export -r release_XX llvm-test
- cvs -d <CVS Repository> export -r release_XX llvm-gcc
- 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
-
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.)
+ +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
- -- Creating the LLVM GCC binary distribution requires performing the following - steps for each supported platform: -
+LLVM is qualified when it has a clean test run without a front-end. And it + has no regressions when using either clang or dragonegg + with the test-suite from the previous release.
-Clang is qualified when front-end specific tests in the + llvm dejagnu test suite all pass, clang's own test suite passes + cleanly, and there are no regressions in the test-suite.
+ +- Check out the llvm-www module from cvs. Create a new subdirectory X.X in the - releases directory. Place the llvm, llvm-test, llvm-gcc source, and llvm-gcc - binaries in this new directory. Copy the llvm/docs and LICENSE.txt files - into this new directory. Update the releases/download.html file with the new release. - Update the releases/index.html with the new release. Finally, update the main page ( - index.html and sidebar) to point to the new release and release announcement. Make - sure this all gets commited back into cvs. -
+Architecture | OS | clang baseline | tests |
---|---|---|---|
x86-32 | Linux | last release | llvm dejagnu, clang tests, test-suite (including spec) |
x86-32 | FreeBSD | last release | llvm dejagnu, clang tests, test-suite |
x86-32 | mingw | none | QT |
x86-64 | Mac OS 10.X | last release | llvm dejagnu, clang tests, test-suite (including spec) |
x86-64 | Linux | last release | llvm dejagnu, clang tests, test-suite (including spec) |
x86-64 | FreeBSD | last release | llvm dejagnu, clang tests, test-suite |
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.
-Okay, that's the basic functionality. When making a release, we want to -ensure that the tree you build the distribution from passes -dist-check. Beyond fixing the usual bugs, there is generally one -impediment to making the release in this fashion: missing files. The -dist-check 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 make check.
-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: -
To control the process of making the distribution directory correctly, -each Makefile can utilize two features:
+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:
+You will see various messages if things go wrong:
+ +Ask LLVM developers to submit the test suite report and make check + 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 make check + is at least clean.
+ +During the first round of testing, all regressions must be fixed before the + second release candidate is tagged.
+ +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. 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 stage.
+ +Below are the rules regarding patching the release branch:
+Patches applied to the release branch may only be applied by the + release manager.
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.
During the remaining rounds of testing, only patches that fix critical + regressions may be applied.
This target does exactly what distdir target does, but also -includes assembling the tarballs. There are actually four related targets -here:
-
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.
+ -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:
+Review the documentation and ensure that it is up to date. The "Release + Notes" must be updated to reflect new features, bug fixes, new known issues, + and changes in the list of supported platforms. The "Getting Started Guide" + should be updated to reflect the new release version number tag available from + Subversion and changes in basic system requirements. Merge both changes from + mainline into the release branch.
+ +Tag the final release sources using the following procedure:
+ ++$ svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_XY \ + https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_XY/Final + +$ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_XY \ + https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_XY/Final + +$ svn copy https://llvm.org/svn/llvm-project/dragonegg/branches/release_XY \ + https://llvm.org/svn/llvm-project/dragonegg/tags/RELEASE_XY/Final + +$ svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_XY \ + https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_XY/Final ++
The LLVM demo page must be updated to use the new release. This consists of + using the new clang binary and building LLVM.
+ + +The website must be updated before the release announcement is sent out. Here + is what to do:
+If it can pass all that, the distribution will be deemed distribution -worth y and you will see:
-
===== LLVM-1.7.tar.gz Ready For Distribution =====-
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.
--A note about disk space: using dist-check will easily triple the -amount of disk space your build tree is using. You might want to check -available space before you begin.
+ +In addition to doing a normal clean, this target will clean up the -files and directories created by the distribution targets. In particular the -distribution directory (LLVM-X.X), check directory -(_distcheckdir), 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.
+Have Chris send out the release announcement when everything is finished.
+ +