NOTE: THIS DOCUMENT IS A WORK IN PROGRESS!
@@ -27,25 +28,45 @@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. + build of LLVM is released.
- There are three main tasks for building a release of LLVM: + The following is the basic criteria for releasing LLVM:
- 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 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 - Subversion repositories unless it is a bug fix for the 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. -
-- 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 Subversion HEAD using the following procedure:
+Branch the Subversion HEAD using the following procedure:
Verify that the current Subversion HEAD is in decent shape by examining nightly + tester results.
Request all developers to refrain from committing. Offenders get commit rights taken away (temporarily).
The Release Manager updates his/her llvm, llvm-test, - and llvm-gcc 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.
The Release Manager tags his/her llvm, llvm-test, and - llvm-gcc working directories with "RELEASE_XX" where - XX is the major and minor release numbers. So, for Release 1.2, - XX=12 and for Release 1.10, XX=110.
- -Create the release branch for llvm, llvm-gcc4.0, + llvm-gcc4.2, and the test-suite. The + branch name will be release_XX, where XX is the major and + minor release numbers. 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/tags/RELEASE_XX -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_XX -svn copy https://llvm.org/svn/llvm-project/test-suite/trunk \ - https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_XX --
Immediately create Subversion branches based on the - RELEASE_XX tag. The tag should be - "release_XX" (where XX matches that used for the - RELEASE_XX tag). This is where the release distribution - will be created.
- -
-svn copy https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_XX \
https://llvm.org/svn/llvm-project/llvm/branches/release_XX
-svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.0/tags/RELEASE_XX \
+svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.0/trunk \
https://llvm.org/svn/llvm-project/llvm-gcc-4.0/branches/release_XX
-svn copy https://llvm.org/svn/llvm-project/test-suite/tags/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
-Advise developers they can work on Subversion HEAD again.
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:
+ +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.0/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
- 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 llvm and the test-suite. +
+In addition, the version number of all the Bugzilla components must be + updated for the next release.
+ 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: +
+ ++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.0/branches/release_XX llvm-gcc4.0-X.X.source +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 +tar -cvf - llvm-X.X | gzip > llvm-X.X.tar.gz +tar -cvf - llvm-test-X.X | gzip > llvm-test-X.X.tar.gz +tar -cvf - llvm-gcc4.0-X.X.source | gzip > llvm-gcc-4.0-X.X.source.tar.gz +tar -cvf - llvm-gcc4.2-X.X.source | gzip > llvm-gcc-4.2-X.X.source.tar.gz ++
Build both debug and release (optimized) versions of LLVM on all platforms. Ensure the build is warning and error free on each platform. + Note that when building the LLVM GCC Binary, use a release build of LLVM.
+- 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. + Creating the LLVM GCC binary distribution (release/optimized) requires + performing the following steps for each supported platform:
+ ++ Using the newly built llvm-gcc and llvm, reconfigure llvm to locate llvm-gcc. 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. + are, resolve the failures or file a bug. If there is a fix commited to mainline, + merge back into the release branch, and restart testing by + re-building LLVM and llvm-gcc. If no + fix will be made, XFAIL the test and commit back to the release branch.
- 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. + Ensure that 'make check' passes on all platforms for all targets. The + test suite must complete with "0 unexpected failures" before sending out the + pre-releases for testing.
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. -
-- 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: -
- --svn export https://llvm.org/svn/llvm-project/llvm/branches/release_XX llvm -svn export https://llvm.org/svn/llvm-project/llvm-gcc-4.0/branches/release_XX llvm-gcc -svn export https://llvm.org/svn/llvm-project/test-suite/branches/release_XX 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 --
- Creating the LLVM GCC binary distribution requires performing the following - steps for each supported platform: -
- + 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. + Verify that there are no regressions from the previous release. For + unsupported targets, verify that make check at least is clean.
+ +The first round of pre-release testing will be the longest. During this time, + all regressions must be fixed before the second pre-release is created (repeat + steps 4-8).
+ +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.
+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.0/branches/release_XX \ + https://llvm.org/svn/llvm-project/llvm-gcc-4.0/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 ++
+ 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. +
+ 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.
+- Check out the website module from Subversion. 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 + The website must be updated before the release announcement is sent out. Here is + what to do:
+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.
-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.
+Have Chris send out the release announcement when everything is finished.