X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FHowToReleaseLLVM.html;h=30c3d5da5e9360292664cfe1918fb8dfd048abc0;hb=b894f96de4f26dd738e3bf706ffe7cf0eda60714;hp=8b95ac66fc5635151f1803aedec04773a1ff46a5;hpb=9ceece5f7d18017551e4766b06afe2b619dbe339;p=oota-llvm.git diff --git a/docs/HowToReleaseLLVM.html b/docs/HowToReleaseLLVM.html index 8b95ac66fc5..30c3d5da5e9 100644 --- a/docs/HowToReleaseLLVM.html +++ b/docs/HowToReleaseLLVM.html @@ -2,508 +2,579 @@ "http://www.w3.org/TR/html4/strict.dtd"> + How To Release LLVM To The Public - + -
How To Release LLVM To The Public
-

NOTE: THIS DOCUMENT IS A WORK IN PROGRESS!

+

How To Release LLVM To The Public

  1. Introduction
  2. +
  3. Qualification Criteria
  4. +
  5. Release Timeline
  6. Release Process
  7. -
  8. Distribution Targets
-

Written by Reid Spencer, - John Criswell

+

Written by Tanya Lattner, + Reid Spencer, + John Criswell, & + Bill Wendling +

-
Introduction
+

Introduction

-
-

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.

+
+ +

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.

-

-There are three main tasks for building a release of LLVM: -

    -
  1. Create the LLVM source distribution.
  2. -
  3. Create the LLVM GCC source distribtuion.
  4. -
  5. Create a set of LLVM GCC binary distribtuions for each supported - platform. These binary distributions must include compiled versions - of the libraries found in llvm/runtime from the LLVM - source distribution created in Step 1.
  6. -
-

-
Release Process
+

Release Timeline

+
- - -
+

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

+ + +
+ +
    +
  1. Release Administrative Tasks +
      +
    1. Create Release Branch
    2. +
    3. Update Version Numbers
    4. +
    +
  2. +
  3. Building the Release
      -
    1. Update Documentation
    2. -
    3. Merge Branches
    4. -
    5. Make LibDeps.txt
    6. -
    7. Settle LLVM HEAD
    8. -
    9. Tag LLVM and Create the Release Branch
    10. -
    11. Update LLVM Version
    12. -
    13. Build LLVM
    14. -
    15. Run 'make check'
    16. -
    17. Run LLVM Test Suite
    18. Build the LLVM Source Distributions
    19. -
    20. Build the LLVM GCC Binary Distribution
    21. +
    22. Build LLVM
    23. +
    24. Build the Clang Binary Distribution
    25. +
    26. Target Specific Build Details
    27. +
    +
  4. +
  5. Release Qualification Criteria +
      +
    1. Qualify LLVM
    2. +
    3. Qualify Clang
    4. +
    5. Specific Target Qualification Details
    6. +
    +
  6. + +
  7. Community Testing
  8. +
  9. Release Patch Rules
  10. +
  11. Release final tasks +
      +
    1. Update Documentation
    2. +
    3. Tag the LLVM Final Release
    4. +
    5. Update the LLVM Demo Page
    6. Update the LLVM Website
    7. +
    8. Announce the 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 CVS and changes in - basic system requirements. -

+

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. + +
  3. Verify that the current Subversion trunk is in decent shape by + examining nightly tester and buildbot results.

  4. + +
  5. 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_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
    +
    +
  6. + +
  7. Advise developers that they may now check their patches into the + Subversion tree again.

  8. + +
  9. 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_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
    +
    +
  10. +
+
- -
-

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

+

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.

+
- -
-

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.

+

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

- 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 CVS HEAD using the following procedure:

-
    -
  1. - Request all developers to refrain from committing. Offenders get commit - rights taken away (temporarily). -
  2. - -
  3. - The Release Manager updates his/her llvm, llvm-test, and llvm-gcc source - trees with the - latest sources from mainline CVS. The Release Manage may want to consider - using a new working directory for this to keep current uncommitted work - separate from release work. -
  4. - -
  5. - The Release Manager tags his/her llvm, llvm-test, and llvm-gcc working - directories with - "ROOT_RELEASE_XX" where XX is the major and minor - release numbers (you can't have . in a cvs tag name). So, for Release 1.2, - XX=12 and for Release 1.10, XX=110. - -

    - cvs tag ROOT_RELEASE_XX
    -

    -
  6. - -
  7. - Immediately create cvs branches based on the ROOT_RELEASE_XX tag. The tag - should be "release_XX" (where XX matches that used for the ROOT_RELEASE_XX - tag). This is where the release distribution will be created. - -

    - cvs tag -b -r ROOT_RELEASE_XX release_XX -

    -
  8. - -
  9. - Advise developers they can work on CVS HEAD again. -
  10. - -
  11. - 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: - -

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

    -
- -
-

- After creating the llvm release branch, update the release branch's autoconf/configure.ac - version from X.Xcvs to just X.X. Update it on mainline as well to be the next version - (X.X+1cvs). -

+

Building the Release

-
+
+ +

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:

+ + + + + + +
ModeOptions
DebugENABLE_OPTIMIZED=0
Release+AssertsENABLE_OPTIMIZED=1
ReleaseENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1
- -
-

- Build both debug and release (optimized) versions of LLVM on all - platforms. Ensure the build is warning and error free on each platform. -

+

Build LLVM

+ +
+ +

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

-

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

- -
-

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

+

Build Clang Binary Distribution

+ +
+ +

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

+ +
    +
  1. Build clang according to the directions + here.
  2. + +
  3. Build both a Debug and Release version of clang. The binary will be the + Release build.
  4. + +
  5. Package clang (details to follow).
  6. +
-

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

- -
-

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

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

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

+

Building the Release

-

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

+
- -
+

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

- -
-

- Creating the LLVM GCC binary distribution requires performing the following - steps for each supported platform: -

+

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.

-
    -
  1. - 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. -
  2. - -
  3. - Build the libraries in llvm/runtime and install them into the - created LLVM GCC installation directory. -
  4. - -
  5. - For systems with non-distributable header files (e.g. Solaris), manually - remove header files that the GCC build process has "fixed." This process - is admittedly painful, but not as bad as it looks; these header files are - almost always easily identifiable with simple grep expressions and are - installed in only a few directories in the GCC installation directory. -
  6. - -
  7. - Add the copyright files and header file fix script. -
  8. - -
  9. - Archive and compress the installation directory. These can be found in - previous releases of the LLVM-GCC front-end. -
  10. -
+ +

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.

+ +
- -
-

- Check out the llvm-www module from cvs. 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 cvs. -

+

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

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

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

    -
  1. 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
  2. -
  3. 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.
  4. -
  5. 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
  6. -
  7. The distribution directory is then traversed and all CVS or - .svn directories are removed. You see: Eliminating CVS/.svn - directories from distribution
  8. -
  9. The recursive dist-hook target is executed. This gives each - directory a chance to modify the distribution in some way (more on this - below).
  10. -
  11. The distribution directory is traversed and the correct file - permissions and modes are set based on the type of file.
  12. -
-

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

+

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:

+
    -
  1. 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.
  2. -
  3. 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. +
  4. 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).
  5. + +
  6. 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).
-

You will see various messages if things go wrong:

+ +

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.

+ +
+ + +

Release Patch Rules

+ +
+ +

Below are the rules regarding patching the release branch:

+
    -
  1. 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. -
  2. If you build the distribution with VERBOSE=1, then you might - also see: Skipping non-existent 'dir/file' in certain cases where - its okay to skip the file.
  3. -
  4. The target can fail if any of the things it does fail. Error messages - should indicate what went wrong.
  5. +
  6. Patches applied to the release branch may only be applied by the + release manager.

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

  9. + +
  10. During the remaining rounds of testing, only patches that fix critical + regressions may be applied.

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

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.

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

+ +
+ + +

Tag the LLVM Final Release

+ +
+ +

Tag the final release sources using the following procedure:

+ +
+
+$ svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_XY \
+           https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_XY/Final
+
+$ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_XY \
+           https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_XY/Final
+
+$ svn copy https://llvm.org/svn/llvm-project/dragonegg/branches/release_XY \
+           https://llvm.org/svn/llvm-project/dragonegg/tags/RELEASE_XY/Final
+
+$ 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
+
+
+ +
+ +
+ + +

Update the LLVM Demo Page

+ +
+ +

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

+ + +

Update the LLVM Website

+ +
+ +

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

+
    -
  1. 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).
  2. -
  3. removes any pre-existing _distcheckdir at the top level.
  4. -
  5. creates a new _distcheckdir directory at the top level.
  6. -
  7. creates a build subdirectory and an install - subdirectory under _distcheckdir.
  8. -
  9. unzips and untars the release tarball into _distcheckdir, - creating LLVM-1.7 directory (from the tarball).
  10. -
  11. 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.
  12. -
  13. runs make all
  14. -
  15. runs make check
  16. -
  17. runs make install
  18. -
  19. runs make uninstall
  20. -
  21. runs make dist
  22. -
  23. runs make clean
  24. -
  25. runs make dist-clean
  26. +
  27. Check out the www module from Subversion.
  28. + +
  29. Create a new subdirectory X.Y in the releases directory.
  30. + +
  31. Commit the llvm, test-suite, clang source, + clang binaries, dragonegg source, and dragonegg + binaries in this new directory.
  32. + +
  33. Copy and commit the llvm/docs and LICENSE.txt files + into this new directory. The docs should be built with + BUILD_FOR_WEBSITE=1.
  34. + +
  35. Commit the index.html to the release/X.Y directory to + redirect (use from previous release.
  36. + +
  37. Update the releases/download.html file with the new release.
  38. + +
  39. Update the releases/index.html with the new release and link to + release documentation.
  40. + +
  41. 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.
-

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.

+ +
+ -
dist-clean
-

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.

+ +
+ +
+

Valid CSS! + src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"> Valid HTML 4.01! - - Reid Spencer
- The LLVM Compiler Infrastructure -
+ src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"> + The LLVM Compiler Infrastructure +
Last modified: $Date$