X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FHowToReleaseLLVM.html;h=161d5cf9678e837b6d7bffbb3eb9f2c0a4e1878c;hb=ebb5a971d903aa4479bb2a21472597319a9b0086;hp=7d9f196da0e66cf675c003a3b38b70c00d70c3a1;hpb=fe48c80bf78e434a148c2d8a97239912a1872a12;p=oota-llvm.git diff --git a/docs/HowToReleaseLLVM.html b/docs/HowToReleaseLLVM.html index 7d9f196da0e..161d5cf9678 100644 --- a/docs/HowToReleaseLLVM.html +++ b/docs/HowToReleaseLLVM.html @@ -8,13 +8,16 @@
NOTE: THIS DOCUMENT IS A WORK IN PROGRESS!
@@ -22,25 +25,48 @@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.
- --There are three main tasks for building a release of LLVM: +
+ 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. +
+ ++ 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 CVS and changes in - basic system requirements. +
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).
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/branches/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/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 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 ++
-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/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. +
+In addition, the version number 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 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 ++
- 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. + 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.
Tag and branch the CVS HEAD using the following procedure:
-+ 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 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. The + test suite must complete with "0 unexpected failures" before sending out the + pre-releases for testing. +
+
- 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
-
+ Run the llvm-test suite and ensure there are no unacceptable + failures. Unacceptable failures are regression from the previous release + and (optionally) major performance regressions from the previous release. + If a regression is found a bug is filled, but the pre-releases may still go + out.
- Build both debug and release (optimized) versions of LLVM on all - platforms. Ensure the build is warning and error free on each platform. + 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:
++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 ++
- 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. + 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 can build + itself and runs make check 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 /usr/src/redhat/SOURCES directory which is a requirement of + the rpmbuild tool. The last two make invocations just run rpmbuild to + build either a source (srpm) or binary (rpm) RPM package.
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. -
++ 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 ++
- 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. + 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.
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 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.
- 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: -
+ 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.
+
- 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
+ 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. +
- Creating the LLVM GCC binary distribution requires performing the following - steps for each supported platform: + 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: +
-+ You will see various messages if things go wrong: +
-+ This target does exactly what distdir target does, but also includes + assembling the tarballs. There are actually four related targets here: +
+ ++ 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: +
+ ++ 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. +
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.
++ 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. +