X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FHowToReleaseLLVM.html;h=c0ad6c9381325f16ea7731df9d561995a893e87d;hb=dc896a41182bec1b8f9a59ca5d81770c16bdacf1;hp=c0d8639e37e1eb99ce6c2f1779f6f8ee6f7dd287;hpb=a5bbbcea44d96595a81afdedf05322b6ab9ad570;p=oota-llvm.git diff --git a/docs/HowToReleaseLLVM.html b/docs/HowToReleaseLLVM.html index c0d8639e37e..c0ad6c93813 100644 --- a/docs/HowToReleaseLLVM.html +++ b/docs/HowToReleaseLLVM.html @@ -8,13 +8,17 @@
NOTE: THIS DOCUMENT IS A WORK IN PROGRESS!
@@ -22,141 +26,497 @@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, its 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. +
+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: +
+Merge any work done on branches intended for release into mainline. Work that -is not to be incorporated into the release should not be merged from the branch. -
+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.Use the nightly test reports, and 'make check' (deja-gnu based tests) to - increase the quality of LLVM and ensure that merged branches have not - destabilized LLVM.
+Branch the Subversion HEAD using the following procedure:
+Verify that the current Subversion HEAD is in decent shape by examining + nightly tester or buildbot results.
Request all developers to refrain from committing. Offenders get commit + rights taken away (temporarily).
Create the release branch for llvm, llvm-gcc4.2, + clang, and the test-suite. The branch name will be + release_XX,where XX is the major and minor release numbers. + Clang will have a different release number than llvm/ + llvm-gcc4 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. +
+ ++svn copy https://llvm.org/svn/llvm-project/llvm/trunk \ + https://llvm.org/svn/llvm-project/llvm/branches/release_XX +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_XX +svn copy https://llvm.org/svn/llvm-project/test-suite/trunk \ + https://llvm.org/svn/llvm-project/test-suite/branches/release_XX +svn copy https://llvm.org/svn/llvm-project/cfe/trunk \ + https://llvm.org/svn/llvm-project/cfe/branches/release_XX ++
Advise developers they can work on Subversion HEAD again.
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:
+ ++svn co https://llvm.org/svn/llvm-project/llvm/branches/release_XX +svn co https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_XX +svn co https://llvm.org/svn/llvm-project/test-suite/branches/release_XX +svn co https://llvm.org/svn/llvm-project/cfe/branches/release_XX ++
Build both debug and release versions of LLVM on all platforms. Ensure - build is warning and error free on each platform.
++ 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). Regenerated the configure script + for both. This must be done for both llvm and the + test-suite. +
+FIXME: Add a note about clang.
+In addition, the version number of all the Bugzilla components must be + updated for the next release. +
Run make check and ensure there are no unexpected failures. If - there are, resolve the failures and go back to step 2. - 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. +
+ Create source distributions for LLVM, LLVM-GCC, + clang, and the llvm test-suite by exporting the source from + Subversion and archiving it. This can be done with the following commands:
+ ++svn export https://llvm.org/svn/llvm-project/llvm/branches/release_XX llvm-X.X +svn export https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_XX llvm-gcc4.2-X.X.source +svn export https://llvm.org/svn/llvm-project/test-suite/branches/release_XX llvm-test-X.X +svn export https://llvm.org/svn/llvm-project/cfe/branches/release_XX 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 ++
Run the llvm-test suite and ensure there are no unacceptable failures. - If there are, resolve the failures and go back to step 2. The test suite - should be run in Nightly Test mode. All tests must pass. If they do not, - investigate and go back to settling CVS HEAD.
++ Build both debug, release (optimized), and release-asserts versions of + LLVM on all supported platforms. Direction to build llvm are + here. +
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.
++ Creating the LLVM GCC binary distribution (release/optimized) requires + performing the following steps for each supported platform: +
+ +Tag and branch the CVS HEAD using the following procedure:
++ Creating the Clang binary distribution (debug/release/release-asserts) requires + performing the following steps for each supported platform: +
++ The table below specifies which compilers are used for each arch/os combination + when qualifying the build of llvm, llvm-gcc, clang. +
+ ++
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 |
Build the distribution, ensuring it is installable and working. This is a - two step process. First, use "make dist" to simply build the distribution. Any - failures need to be corrected (on the branch). Once "make dist" can be - successful, do "make dist-check". This target will do the same thing as the - 'dist' target but also test that distribution to make sure it works. This - ensures that needed files are not missing and that the src tarball can be - successfully unbacked, built, installed, and cleaned. This two-level testing - needs to be done on each target platform.
+ 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. 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 outRelease 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.
-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.
-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.
++ LLVM is qualified when it has a clean dejagnu test run without a frontend and + it has no regressions when using either llvm-gcc or clang + with the test-suite from the previous release. +
++ LLVM-GCC is qualified when front-end specific tests in the + llvm dejagnu test suite all pass and there are no regressions in + the test-suite.
+We do not use the gcc dejagnu test suite as release criteria.
+Architecture | OS | llvm-gcc baseline | clang baseline + | tests |
---|---|---|---|---|
x86-32 | Linux | last release | last release | llvm dejagnu, clang tests, test-suite (including spec) |
x86-32 | FreeBSD | none | last release | llvm dejagnu, clang tests, test-suite |
x86-32 | mingw | last release | none | QT |
x86-64 | Mac OS 10.X | last release | last release | llvm dejagnu, clang tests, test-suite (including spec) |
x86-64 | Linux | last release | last release | llvm dejagnu, clang tests, test-suite (including spec) |
x86-64 | FreeBSD | none | last release | llvm dejagnu, clang tests, test-suite |
+ 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:
+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.
+ +During the first round of testing time, + all regressions must be fixed before the second pre-release is created.
+ +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. +
++ Below are the rules regarding patching the release branch.
++
+ The final stages of the release process involving taging the release branch, + updating documentation that refers to the release, and updating the demo + page.
+FIXME: Add a note if anything needs to be done to the clang website. + Eventually the websites will be merged hopefully.
++ 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. +
+Tag the release branch using the following procedure:
++svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_XX \ + https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_XX +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_XX +svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_XX \ + https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_XX ++
+ 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.
++ The website must be updated before the release announcement is sent out. Here is + what to do:
+Have Chris send out the release announcement when everything is finished.