From f5af6ada3b0570db1afc19029cad8fb8320676ef Mon Sep 17 00:00:00 2001 From: NAKAMURA Takumi Date: Sat, 23 Apr 2011 00:30:22 +0000 Subject: docs: Introduce cascading style
and

continued on .

Section Example

Section preamble.

Subsection Example

Subsection body

FIXME: Care H5 better. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@130040 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/HowToReleaseLLVM.html | 75 +++++++++++++++++++++++----------------------- 1 file changed, 37 insertions(+), 38 deletions(-) (limited to 'docs/HowToReleaseLLVM.html') diff --git a/docs/HowToReleaseLLVM.html b/docs/HowToReleaseLLVM.html index 59e7864630..8a7d7f4b88 100644 --- a/docs/HowToReleaseLLVM.html +++ b/docs/HowToReleaseLLVM.html @@ -26,7 +26,7 @@

Introduction

-
+

This document contains information about successfully releasing LLVM — including subprojects: e.g., llvm-gcc and clang — to @@ -38,7 +38,7 @@

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 @@ -79,7 +79,7 @@

Release Process

-
+
  1. Release Administrative Tasks @@ -119,12 +119,10 @@
-
-

Release Administrative Tasks

-
+

This section describes a few administrative tasks that need to be done for the release process to begin. Specifically, it involves:

@@ -135,12 +133,10 @@
  • Tagging release candidates for the release team to begin testing
  • -
    -

    Create Release Branch

    -
    +

    Branch the Subversion trunk using the following procedure:

    @@ -200,7 +196,7 @@ $ svn co https://llvm.org/svn/llvm-project/cfe/branches/release_XY clang-

    Update LLVM Version

    -
    +

    After creating the LLVM release branch, update the release branches' autoconf and configure.ac versions from 'X.Ysvn' @@ -216,7 +212,7 @@ $ svn co https://llvm.org/svn/llvm-project/cfe/branches/release_XY clang-

    Build the LLVM Release Candidates

    -
    +

    Create release candidates for llvm, llvm-gcc, clang, and the LLVM test-suite by tagging the branch with @@ -268,10 +264,12 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g

    +
    +

    Building the Release

    -
    +

    The builds of llvm, llvm-gcc, and clang must be free of errors and warnings in Debug, Release+Asserts, and @@ -287,12 +285,10 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g ReleaseENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1 -

    -

    Build LLVM

    -
    +

    Build Debug, Release+Asserts, and Release versions of llvm on all supported platforms. Directions to build @@ -304,7 +300,7 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g

    Build the LLVM GCC Binary Distribution

    -
    +

    Creating the llvm-gcc binary distribution (Release/Optimized) requires performing the following steps for each supported platform:

    @@ -331,7 +327,7 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g

    Build Clang Binary Distribution

    -
    +

    Creating the clang binary distribution (Debug/Release+Asserts/Release) requires performing the following steps for @@ -352,7 +348,7 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g

    Target Specific Build Details

    -
    +

    The table below specifies which compilers are used for each Arch/OS combination when qualifying the build of llvm, llvm-gcc, @@ -371,10 +367,12 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g

    +
    +

    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 @@ -390,12 +388,10 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g criteria, but these are the criteria which we found to be most important and which must be satisfied before a release can go out

    -
    -

    Qualify LLVM

    -
    +

    LLVM is qualified when it has a clean test run without a front-end. And it has no regressions when using either llvm-gcc or clang with @@ -406,7 +402,7 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g

    Qualify LLVM-GCC

    -
    +

    LLVM-GCC is qualified when front-end specific tests in the llvm regression test suite all pass and there are no regressions in @@ -419,7 +415,7 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g

    Qualify Clang

    -
    +

    Clang is qualified when front-end specific tests in the llvm dejagnu test suite all pass, clang's own test suite passes @@ -430,7 +426,7 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g

    Specific Target Qualification Details

    -
    +
    @@ -444,9 +440,11 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g + +

    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 @@ -484,7 +482,7 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g

    Release Patch Rules

    -
    +

    Below are the rules regarding patching the release branch:

    @@ -508,19 +506,16 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g

    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.

    -
    - -

    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, @@ -534,7 +529,7 @@ $ tar -cvf - clang-X.Yrc1 | gzip > clang-X.Yrc1.src.tar.g

    Tag the LLVM Final Release

    -
    +

    Tag the final release sources using the following procedure:

    @@ -556,20 +551,20 @@ $ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_XY \
    +
    +

    Update the LLVM Demo Page

    -
    +

    The LLVM demo page must be updated to use the new release. This consists of using the new llvm-gcc 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:

    @@ -605,12 +600,16 @@ $ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_XY \

    Announce the Release

    -
    +

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

    +
    + +
    +
    -- cgit v1.2.3
    ArchitectureOSllvm-gcc baselineclang baselinetests