How To Release LLVM To The Public

- 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: -

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.

Successful configure and build.
Clean 'make check'.
No regressions in the testsuite from the previous release. This may - include performance regressions for major benchmarks.

Release Timeline

-The release manager should attempt to have a release every 3-4 months because LLVM -does time based releases (instead of feature based). The release schedule should -be roughly as follows: -

Set code freeze and branch creation date for 3 months after last release -date. Announce release schedule to the LLVM community and update the website.
Create release branch and begin release process.
Send out pre-release for first round of testing. Testing will last 7-10 days. -During the first round of testing, regressions should be found and fixed. Patches -are merged from mainline to the release branch.
Generate and send out second pre-release. Bugs found during this time will -not be fixed unless absolutely critical. Bugs introduce by patches merged in -will be fixed and if so, a 3rd round of testing is needed.
The release notes should be updated during the first and second round of -pre-release testing.
Finally, release!

+ +

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!

+ +

Release Process

- -

Process Overview

+ +

Release Administrative Tasks
+
Building the Release +
+
Release Qualification Criteria +
+
Community Testing
Release Patch Rules
Release final tasks +
-

+ + -

Create Release Branch

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.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. -
+
Release Administrative Tasks
+ +
+ +
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,
- Setting version numbers, and
- Tagging release candidates for the release team to begin testing
+ + +
Create Release Branch
+ +
+ +
Branch the Subversion trunk using the following procedure:
+ +
1. 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.
2. Verify that the current Subversion trunk is in decent shape by + examining nightly tester and buildbot results.
3. 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_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/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
  -
  +
4. -
  Advise developers they can work on Subversion HEAD again.
5. -
  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:
  +
6. Advise developers that they may now check their patches into the + Subversion tree again.
7. 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_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/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
-

Update LLVM Version

- 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. -

Update LLVM Version

+ +

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.

Build the LLVM Source Distributions

- 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: -

Build the LLVM Release Candidates

+ +

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 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
-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.2-X.X.source | gzip > llvm-gcc-4.2-X.X.source.tar.gz
+$ 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
+

- -

Build LLVM

- 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 the LLVM GCC Binary Distribution

- Creating the LLVM GCC binary distribution (release/optimized) requires - performing the following steps for each supported platform: -

Building the Release

- Build the LLVM GCC front-end by following the directions in the README.LLVM - file. Be sure to build with LLVM_VERSION_INFO=X.X, where X is the major and - minor release numbers. -
- 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.0-2.1-x86-linux-RHEL4. Archive and compress the new directory. -

+ +

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`

Run 'make check'

- 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. -

Build LLVM

+ +

Build Debug, Release+Asserts, and Release versions + of llvm on all supported platforms. Directions to build + llvm are here.

- 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. -

LLVM Test Suite

- 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 Clang Binary Distribution

+ +

Creating the clang binary distribution + (Debug/Release+Asserts/Release) requires performing the following steps for + each supported platform:

+ +

Build clang according to the directions + here.
Build both a Debug and Release version of clang. The binary will be the + Release build.
Package clang (details to follow).

Building RPM packages (optional)

- 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: -

Target Specific Build Details

+ +

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

-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
-

- 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. -

Pre-Release Testing

- 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:

Download llvm-X.X, llvm-test-X.X, and the appropriate llvm-gcc4 binary. - 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 source. Compile - everything. Run "make check" and the full llvm-test suite (make TEST=nightly - report).

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.

Building the Release

+ +

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

Tag 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
-

Qualify LLVM

+ +

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.

Update Documentation

- 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. -

Qualify Clang

+ +

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.

Update the LLVM Demo Page

- 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.

Specific Target Qualification Details

+ +

+ + + + + + + + + +

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

+ +

Update the LLVM Website

- 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, - 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 - commited back into Subversion.

Community Testing

+ +

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:

+ +

Download llvm-X.Y, llvm-test-X.Y, and the + appropriate clang binary. Build LLVM. Run make check and + the full LLVM test suite (make TEST=nightly report).
Download llvm-X.Y, llvm-test-X.Y, and the + clang sources. Compile everything. Run make check and + the full LLVM test suite (make TEST=nightly report).

+ +

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.

Announce the Release

Have Chris send out the release announcement when everything is finished.

Release Patch Rules

+ +

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.

- -

Distribution Targets

- + +

Release Final Tasks

+ +

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.

Overview

- 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. -

Update Documentation

+ +

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 avaiable from + Subversion and changes in basic system requirements. Merge both changes from + mainline into the release branch.

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. -

Tag the LLVM Final Release

distdir

- 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: -

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, SVN 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.

Tag the final release sources using the following procedure:

- To control the process of making the distribution directory correctly, each - Makefile can utilize two features: -

+$ svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_XY \ + https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_XY/Final -

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.

+$ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_XY \ + https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_XY/Final -

- You will see various messages if things go wrong: -

+$ svn copy https://llvm.org/svn/llvm-project/dragonegg/branches/release_XY \ + https://llvm.org/svn/llvm-project/dragonegg/tags/RELEASE_XY/Final -

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.

+$ 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 +

- -

dist

- This target does exactly what distdir target does, but also includes - assembling the tarballs. There are actually four related targets here: -

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

dist-check

- 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: -

Update the LLVM Demo Page

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: -

The LLVM demo page must be updated to use the new release. This consists of + using the new clang binary and building LLVM.

===== LLVM-1.7.tar.gz Ready For Distribution =====

+ +

Update the LLVM Website

+ +

The website must be updated before the release announcement is sent out. Here + is what to do:

+ +

Check out the www module from Subversion.
Create a new subdirectory X.Y in the releases directory.
Commit the llvm, test-suite, clang source, + clang binaries, dragonegg source, and dragonegg + 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.Y 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.

- 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. -

dist-clean

- 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. -

Announce the Release

+ +

Have Chris send out the release announcement when everything is finished.

+ +

@@ -591,7 +573,7 @@ svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_XX \ src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS">

- The LLVM Compiler Infrastructure + The LLVM Compiler Infrastructure
Last modified: $Date$