From: Reid Spencer Date: Thu, 23 Mar 2006 06:45:42 +0000 (+0000) Subject: A very early, rough draft of a guide to making public releases for LLVM. X-Git-Url: http://plrg.eecs.uci.edu/git/?p=oota-llvm.git;a=commitdiff_plain;h=cf427e8ea03d993179307372057c6857942b8b32 A very early, rough draft of a guide to making public releases for LLVM. This document will detail the steps needed for making a quality release of LLVM that ensures the release functions and is of high quality. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@26978 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/docs/HowToReleaseLLVM.html b/docs/HowToReleaseLLVM.html new file mode 100644 index 00000000000..02b54bb7eeb --- /dev/null +++ b/docs/HowToReleaseLLVM.html @@ -0,0 +1,130 @@ + + + + How To Release LLVM To The Public + + + + +
How To Release LLVM To The Public
+

NOTE: THIS DOCUMENT IS A WORK IN PROGRESS!

+ + +
    +
  1. Introduction
    2. +
  2. Release Process +
      +
    1. Overview
      2. +
    2. Merge Branches
      3. +
    3. Build LLVM
      4. +
    4. Run 'make check'
      5. +
    5. Run LLVM Test Suite
      6. +
    6. make LibDeps.txt
      7. +
    7. cvs tag
      8. +
    8. make dist
      9. +
    9. Release
      10. +
    3. +
+
+

Written by Reid Spencer

+
+ + +
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, its just a bunch of reminders of things to do at +release time so we don't inadvertently ship something that is utility +deficient.

+
+ + +
Release Process
+ + + +
Process Overview
+
+
    +
  1. Merge Branches
    2. +
  2. Build LLVM
    3. +
  3. Run 'make check'
    4. +
  4. Run LLVM Test Suite
    5. +
  5. make LibDeps.txt
    6. +
  6. cvs tag
    7. +
  7. make dist
    8. +
  8. release
    9. +
+
+ + +
Merge Branches
+
+

Merge any work done on branches intended for release into mainline.

+
+ + +
Build LLVM
+
+

Build LLVM

+
+ + +
Run 'make check'
+
+

Run "make check" and ensure there are no unexpected failures. If there + are, resolve the failures and go back to step 2.

+
+ + +
LLVM Test Suite
+
+

Run the llvm-test suite and ensure there are no unacceptable failures. + If there are, resolve the failures and go back to step 2.

+
+ + +
Make LibDeps.txt
+
+

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.

+
+ + +
CVS Tag
+
+

Tag the release.

+
+ + +
Run 'make dist'
+
+

Build the distribution, ensuring it is installable and working

+
+ + +
Release
+
+

Release the distribution tarball to the public.

+
+ + +
+
+ Valid CSS! + Valid HTML 4.01! + + Reid Spencer
+ The LLVM Compiler Infrastructure +
+ Last modified: $Date$ +
+ +