- 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: -
+The build of llvm, llvm-gcc, and clang must be free +of errors and warnings in both debug, release+asserts, and release builds. +If all builds are clean, then the release passes build qualification. --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 -+
-
+
- debug: ENABLE_OPTIMIZED=0 +
- release+asserts: ENABLE_OPTIMIZED=1 +
- release: ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1 +
- 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. + Build both debug, release+asserts (optimized), and release versions of + LLVM on all supported platforms. Direction to build llvm are + here.
- Creating the LLVM GCC binary distribution requires performing the following - steps for each supported platform: + Creating the LLVM GCC binary distribution (release/optimized) requires + performing the following steps for each supported platform:
- - Build the LLVM GCC front-end. The LLVM GCC front-end must be installed in - a directory named cfrontend/<platform>/llvm-gcc. For - example, the Sparc/Solaris directory is named - cfrontend/sparc/llvm-gcc. + Build the LLVM GCC front-end by following the directions in the README.LLVM + file. The frontend must be compiled with c, c++, objc (mac only), + objc++ (mac only) and fortran support. +
- Please boostrap as well. +
- Be sure to build with LLVM_VERSION_INFO=X.X, where X is the major and + minor release numbers.
- - Build the libraries in llvm/runtime and install them into the - created LLVM GCC installation directory. + Copy the installation directory to a directory named for the specific target. + For example on Red Hat Enterprise Linux, the directory would be named + llvm-gcc4.2-2.6-x86-linux-RHEL4. Archive and compress the new directory. +
+ Creating the Clang binary distribution (debug/release/release) requires + performing the following steps for each supported platform: +
+- - Add the copyright files and header file fix script. + Build clang according to the directions + here. + +
- Build both a debug and release version of clang, but the binary + will be a release build.
- - Archive and compress the installation directory. These can be found in - previous releases of the LLVM-GCC front-end. + Package clang (details to follow).
- 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 - point to the new release and release announcement. Make sure this all gets - commited back into Subversion. + 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 |
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.
+ 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 out- 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. -
- --
-
- distdir - builds the distribution directory from which the - distribution will be packaged -
- dist - builds each of the distribution tarballs (tar.gz, - tar.bzip2, .zip). These can be built individually as well, with separate - targets. -
- dist-check - this is identical to dist but includes a - check on the distribution that ensures the tarball can: unpack - successfully, compile correctly, pass 'make check', and pass - 'make clean'. -
- dist-clean- this just does a normal clean but also cleans up the - stuff generated by the other three dist targets (above). -
- 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. -
+ 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.
- 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: -
+ 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. +-
-
- First, if there was an old distribution directory (for the current - release), it is removed in its entirety and you see Removing old - LLVM-1.7 -
- Second, it issues a make all ENABLE_OPTIMIZED=3D1 to ensure - that the everything in your tree can be built in release mode. Often - times there are discrepancies in building between debug and release - modes so it enforces release mode first. If that fails, the - distdir target fails too. This is preceded by the message - Making 'all' to verify build. -
- Next, it traverses your source tree and copies it to a new directory - that has the name of the release (LLVM-M.m in our current - case). This is the directory that will get tar'd. It contains all the - software that needs to be in the distribution. During the copying - process, it omits generated files, CVS directories, and any other - "cruft" that's in your build tree. This is done to eliminate the - possibility of huge distribution tarballs that include useless or - irrelevant stuff in them. This is the trickiest part of making the - distribution. Done manually you will either include stuff that - shouldn't be in the distribution or exclude stuff that should. This - step is preceded by the message Building Distribution Directory - LLVM-1.7 -
- The distribution directory is then traversed and all CVS or - .svn directories are removed. You see: Eliminating CVS/.svn - directories from distribution -
- The recursive dist-hook target is executed. This gives each - directory a chance to modify the distribution in some way (more on this - below). -
- The distribution directory is traversed and the correct file - permissions and modes are set based on the type of file. -
| 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 |
- 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 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:-
-
- EXTRA_DIST - this make variable specifies which files - it should distribute. By default, all source files are automatically - included for distribution as well as certain well known files - (see DistAlways variable in Makefile.rules for details). Each Makefile - specifies, via the EXTRA_DIST variable, which additional files - need to be distributed. Only those files that are needed to build LLVM - should be added to EXTRA_DIST. EXTRA_DIST contains a - list of file or directory names that should be distributed. For example, - the top level Makefile contains EXTRA_DIST := test llvm.spec - include. This means that in addition to regular things that are - distributed at the top level (CREDITS.txt, LICENSE.txt, etc.) - the distribution should contain the entire test and - include directories as well as the llvm.spec file. -
- dist-hook - this make target can be used to alter the - content of the distribution directory. For example, in the top level - Makefile there is some logic to eliminate files in the include - subtree that are generated by the configure script. These should not be - distributed. Similarly, any dist-hook target found in any - directory can add or remove or modify things just before it gets - packaged. Any transformation is permitted. Generally, not much is - needed. +
- 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). +
- 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 + report).
- You will see various messages if things go wrong: +
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.
- --
-
- During the copying process, any files that are missing will be flagged - with: ===== WARNING: Distribution Source 'dir/file' Not Found! - These must be corrected by either adding the file or removing it from - EXTRA_DIST. -
- If you build the distribution with VERBOSE=1, then you might - also see: Skipping non-existent 'dir/file' in certain cases - where it's okay to skip the file. -
- The target can fail if any of the things it does fail. Error messages - should indicate what went wrong. -
- This target does exactly what distdir target does, but also includes - assembling the tarballs. There are actually four related targets here: + Below are the rules regarding patching the release branch.
++
-
-
- dist-gzip: package the gzipped distribution tar - file. The distribution directory is packaged into a single file ending - in .tar.gz which is gzip compressed. -
- dist-bzip2: package the bzip2 distribution tar file. - The distribution directory is packaged into a single file ending in - .tar.bzip2 which is bzip2 compressed. -
- dist-zip: package the zip distribution file. The - distribution directory is packaged into a single file ending in - .zip which is zip compressed. -
- dist: does all three, dist-gzip, dist-bzip2, - dist-zip -
- 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: -
+ The final stages of the release process involving tagging 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.
+-
-
- It depends on the dist-gzip target which, if it hasn't already - been built, builds the gzip tar bundle (see dist and distdir - above). -
- removes any pre-existing _distcheckdir at the top level. -
- creates a new _distcheckdir directory at the top level. -
- creates a build subdirectory and an install - subdirectory under _distcheckdir. -
- unzips and untars the release tarball into _distcheckdir, - creating LLVM-1.7 directory (from the tarball). -
- in the build subdirectory, it configures with appropriate options to - build from the unpacked source tarball into the build directory - with installation in the install directory. -
- runs make all -
- runs make check -
- runs make install -
- runs make uninstall -
- runs make dist -
- runs make clean -
- runs make dist-clean -
- If it can pass all that, the distribution will be deemed distribution worth y - and you will see: + 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 ++
===== 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. -
+ 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.- 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. -
+ The website must be updated before the release announcement is sent out. Here is + what to do: +-
+
- Check out the website module from CVS. +
- Create a new subdirectory X.X in the releases directory. +
- Commit the llvm, test-suite, llvm-gcc source, + clang source, clang binaries, + and llvm-gcc binaries in this new directory. +
- Copy and commit the llvm/docs and LICENSE.txt + files into this new directory. The docs should be built with BUILD_FOR_WEBSITE=1. +
- Commit the index.html to the release/X.X directory to redirect (use from previous + release. +
- Update the releases/download.html file with the new release. +
- Update the releases/index.html with the new release and link to + release documentation. +
- Finally, update the main page (index.html and sidebar) to + point to the new release and release announcement. Make sure this all gets + committed back into Subversion. +
Have Chris send out the release announcement when everything is finished.
+ src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS">
+ src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"> The LLVM Compiler Infrastructure -
+
Last modified: $Date$