CbC/CbC_llvm: docs/HowToReleaseLLVM.rst annotate

annotate docs/HowToReleaseLLVM.rst @ 3:9ad51c7bc036

1st commit. remove git dir and add all files.

author	Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
date	Wed, 15 May 2013 06:43:32 +0900
parents
children

rev	line source
3 9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1 =================================
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	2 How To Release LLVM To The Public
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	3 =================================
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	4
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	5 .. contents::
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	6 :local:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	7 :depth: 1
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	8
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	9 Introduction
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	10 ============
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	11
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	12 This document contains information about successfully releasing LLVM ---
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	13 including subprojects: e.g., ``clang`` and ``dragonegg`` --- to the public. It
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	14 is the Release Manager's responsibility to ensure that a high quality build of
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	15 LLVM is released.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	16
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	17 .. _timeline:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	18
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	19 Release Timeline
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	20 ================
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	21
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	22 LLVM is released on a time based schedule --- roughly every 6 months. We do
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	23 not normally have dot releases because of the nature of LLVM's incremental
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	24 development philosophy. That said, the only thing preventing dot releases for
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	25 critical bug fixes from happening is a lack of resources --- testers,
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	26 machines, time, etc. And, because of the high quality we desire for LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	27 releases, we cannot allow for a truncated form of release qualification.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	28
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	29 The release process is roughly as follows:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	30
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	31 * Set code freeze and branch creation date for 6 months after last code freeze
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	32 date. Announce release schedule to the LLVM community and update the website.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	33
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	34 * Create release branch and begin release process.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	35
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	36 * Send out release candidate sources for first round of testing. Testing lasts
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	37 7-10 days. During the first round of testing, any regressions found should be
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	38 fixed. Patches are merged from mainline into the release branch. Also, all
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	39 features need to be completed during this time. Any features not completed at
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	40 the end of the first round of testing will be removed or disabled for the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	41 release.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	42
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	43 * Generate and send out the second release candidate sources. Only critial
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	44 bugs found during this testing phase will be fixed. Any bugs introduced by
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	45 merged patches will be fixed. If so a third round of testing is needed.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	46
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	47 * The release notes are updated.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	48
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	49 * Finally, release!
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	50
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	51 Release Process
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	52 ===============
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	53
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	54 .. contents::
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	55 :local:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	56
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	57 Release Administrative Tasks
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	58 ----------------------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	59
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	60 This section describes a few administrative tasks that need to be done for the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	61 release process to begin. Specifically, it involves:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	62
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	63 * Creating the release branch,
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	64
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	65 * Setting version numbers, and
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	66
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	67 * Tagging release candidates for the release team to begin testing.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	68
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	69 Create Release Branch
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	70 ^^^^^^^^^^^^^^^^^^^^^
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	71
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	72 Branch the Subversion trunk using the following procedure:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	73
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	74 #. Remind developers that the release branching is imminent and to refrain from
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	75 committing patches that might break the build. E.g., new features, large
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	76 patches for works in progress, an overhaul of the type system, an exciting
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	77 new TableGen feature, etc.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	78
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	79 #. Verify that the current Subversion trunk is in decent shape by
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	80 examining nightly tester and buildbot results.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	81
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	82 #. Create the release branch for ``llvm``, ``clang``, the ``test-suite``, and
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	83 ``dragonegg`` from the last known good revision. The branch's name is
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	84 ``release_XY``, where ``X`` is the major and ``Y`` the minor release
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	85 numbers. The branches should be created using the following commands:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	86
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	87 ::
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	88
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	89 $ svn copy https://llvm.org/svn/llvm-project/llvm/trunk \
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	90 https://llvm.org/svn/llvm-project/llvm/branches/release_XY
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	91
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	92 $ svn copy https://llvm.org/svn/llvm-project/cfe/trunk \
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	93 https://llvm.org/svn/llvm-project/cfe/branches/release_XY
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	94
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	95 $ svn copy https://llvm.org/svn/llvm-project/dragonegg/trunk \
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	96 https://llvm.org/svn/llvm-project/dragonegg/branches/release_XY
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	97
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	98 $ svn copy https://llvm.org/svn/llvm-project/test-suite/trunk \
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	99 https://llvm.org/svn/llvm-project/test-suite/branches/release_XY
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	100
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	101 #. Advise developers that they may now check their patches into the Subversion
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	102 tree again.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	103
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	104 #. The Release Manager should switch to the release branch, because all changes
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	105 to the release will now be done in the branch. The easiest way to do this is
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	106 to grab a working copy using the following commands:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	107
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	108 ::
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	109
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	110 $ svn co https://llvm.org/svn/llvm-project/llvm/branches/release_XY llvm-X.Y
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	111
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	112 $ svn co https://llvm.org/svn/llvm-project/cfe/branches/release_XY clang-X.Y
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	113
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	114 $ svn co https://llvm.org/svn/llvm-project/dragonegg/branches/release_XY dragonegg-X.Y
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	115
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	116 $ svn co https://llvm.org/svn/llvm-project/test-suite/branches/release_XY test-suite-X.Y
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	117
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	118 Update LLVM Version
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	119 ^^^^^^^^^^^^^^^^^^^
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	120
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	121 After creating the LLVM release branch, update the release branches'
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	122 ``autoconf`` and ``configure.ac`` versions from '``X.Ysvn``' to '``X.Y``'.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	123 Update it on mainline as well to be the next version ('``X.Y+1svn``').
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	124 Regenerate the configure scripts for both ``llvm`` and the ``test-suite``.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	125
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	126 In addition, the version numbers of all the Bugzilla components must be updated
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	127 for the next release.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	128
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	129 Build the LLVM Release Candidates
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	130 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	131
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	132 Create release candidates for ``llvm``, ``clang``, ``dragonegg``, and the LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	133 ``test-suite`` by tagging the branch with the respective release candidate
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	134 number. For instance, to create Release Candidate 1 you would issue the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	135 following commands:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	136
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	137 ::
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	138
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	139 $ svn mkdir https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_XY
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	140 $ svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_XY \
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	141 https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_XY/rc1
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	142
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	143 $ svn mkdir https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_XY
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	144 $ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_XY \
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	145 https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_XY/rc1
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	146
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	147 $ svn mkdir https://llvm.org/svn/llvm-project/dragonegg/tags/RELEASE_XY
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	148 $ svn copy https://llvm.org/svn/llvm-project/dragonegg/branches/release_XY \
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	149 https://llvm.org/svn/llvm-project/dragonegg/tags/RELEASE_XY/rc1
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	150
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	151 $ svn mkdir https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_XY
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	152 $ svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_XY \
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	153 https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_XY/rc1
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	154
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	155 Similarly, Release Candidate 2 would be named ``RC2`` and so on. This keeps
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	156 a permanent copy of the release candidate around for people to export and build
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	157 as they wish. The final released sources will be tagged in the ``RELEASE_XY``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	158 directory as ``Final`` (c.f. :ref:`tag`).
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	159
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	160 The Release Manager may supply pre-packaged source tarballs for users. This can
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	161 be done with the following commands:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	162
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	163 ::
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	164
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	165 $ svn export https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_XY/rc1 llvm-X.Yrc1
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	166 $ svn export https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_XY/rc1 clang-X.Yrc1
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	167 $ svn export https://llvm.org/svn/llvm-project/dragonegg/tags/RELEASE_XY/rc1 dragonegg-X.Yrc1
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	168 $ svn export https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_XY/rc1 llvm-test-X.Yrc1
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	169
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	170 $ tar -cvf - llvm-X.Yrc1 \| gzip > llvm-X.Yrc1.src.tar.gz
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	171 $ tar -cvf - clang-X.Yrc1 \| gzip > clang-X.Yrc1.src.tar.gz
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	172 $ tar -cvf - dragonegg-X.Yrc1 \| gzip > dragonegg-X.Yrc1.src.tar.gz
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	173 $ tar -cvf - llvm-test-X.Yrc1 \| gzip > llvm-test-X.Yrc1.src.tar.gz
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	174
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	175 Building the Release
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	176 --------------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	177
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	178 The builds of ``llvm``, ``clang``, and ``dragonegg`` must be free of
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	179 errors and warnings in Debug, Release+Asserts, and Release builds. If all
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	180 builds are clean, then the release passes Build Qualification.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	181
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	182 The ``make`` options for building the different modes:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	183
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	184 +-----------------+---------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	185 \| Mode \| Options \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	186 +=================+=============================================+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	187 \| Debug \| ``ENABLE_OPTIMIZED=0`` \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	188 +-----------------+---------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	189 \| Release+Asserts \| ``ENABLE_OPTIMIZED=1`` \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	190 +-----------------+---------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	191 \| Release \| ``ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1`` \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	192 +-----------------+---------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	193
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	194 Build LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	195 ^^^^^^^^^^
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	196
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	197 Build ``Debug``, ``Release+Asserts``, and ``Release`` versions
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	198 of ``llvm`` on all supported platforms. Directions to build ``llvm``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	199 are :doc:`here <GettingStarted>`.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	200
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	201 Build Clang Binary Distribution
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	202 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	203
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	204 Creating the ``clang`` binary distribution (Debug/Release+Asserts/Release)
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	205 requires performing the following steps for each supported platform:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	206
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	207 #. Build clang according to the directions `here
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	208 <http://clang.llvm.org/get_started.html>`__.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	209
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	210 #. Build both a Debug and Release version of clang. The binary will be the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	211 Release build.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	212
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	213 #. Package ``clang`` (details to follow).
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	214
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	215 Target Specific Build Details
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	216 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	217
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	218 The table below specifies which compilers are used for each Arch/OS combination
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	219 when qualifying the build of ``llvm``, ``clang``, and ``dragonegg``.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	220
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	221 +--------------+---------------+----------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	222 \| Architecture \| OS \| compiler \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	223 +==============+===============+======================+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	224 \| x86-32 \| Mac OS 10.5 \| gcc 4.0.1 \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	225 +--------------+---------------+----------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	226 \| x86-32 \| Linux \| gcc 4.2.X, gcc 4.3.X \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	227 +--------------+---------------+----------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	228 \| x86-32 \| FreeBSD \| gcc 4.2.X \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	229 +--------------+---------------+----------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	230 \| x86-32 \| mingw \| gcc 3.4.5 \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	231 +--------------+---------------+----------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	232 \| x86-64 \| Mac OS 10.5 \| gcc 4.0.1 \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	233 +--------------+---------------+----------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	234 \| x86-64 \| Linux \| gcc 4.2.X, gcc 4.3.X \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	235 +--------------+---------------+----------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	236 \| x86-64 \| FreeBSD \| gcc 4.2.X \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	237 +--------------+---------------+----------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	238
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	239 Release Qualification Criteria
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	240 ------------------------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	241
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	242 A release is qualified when it has no regressions from the previous release (or
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	243 baseline). Regressions are related to correctness first and performance second.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	244 (We may tolerate some minor performance regressions if they are deemed
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	245 necessary for the general quality of the compiler.)
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	246
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	247 **Regressions are new failures in the set of tests that are used to qualify
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	248 each product and only include things on the list. Every release will have
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	249 some bugs in it. It is the reality of developing a complex piece of
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	250 software. We need a very concrete and definitive release criteria that
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	251 ensures we have monotonically improving quality on some metric. The metric we
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	252 use is described below. This doesn't mean that we don't care about other
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	253 criteria, but these are the criteria which we found to be most important and
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	254 which must be satisfied before a release can go out.**
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	255
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	256 Qualify LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	257 ^^^^^^^^^^^^
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	258
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	259 LLVM is qualified when it has a clean test run without a front-end. And it has
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	260 no regressions when using either ``clang`` or ``dragonegg`` with the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	261 ``test-suite`` from the previous release.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	262
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	263 Qualify Clang
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	264 ^^^^^^^^^^^^^
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	265
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	266 ``Clang`` is qualified when front-end specific tests in the ``llvm`` regression
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	267 test suite all pass, clang's own test suite passes cleanly, and there are no
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	268 regressions in the ``test-suite``.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	269
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	270 Specific Target Qualification Details
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	271 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	272
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	273 +--------------+-------------+----------------+-----------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	274 \| Architecture \| OS \| clang baseline \| tests \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	275 +==============+=============+================+=============================+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	276 \| x86-32 \| Linux \| last release \| llvm regression tests, \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	277 \| \| \| \| clang regression tests, \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	278 \| \| \| \| test-suite (including spec) \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	279 +--------------+-------------+----------------+-----------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	280 \| x86-32 \| FreeBSD \| last release \| llvm regression tests, \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	281 \| \| \| \| clang regression tests, \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	282 \| \| \| \| test-suite \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	283 +--------------+-------------+----------------+-----------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	284 \| x86-32 \| mingw \| none \| QT \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	285 +--------------+-------------+----------------+-----------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	286 \| x86-64 \| Mac OS 10.X \| last release \| llvm regression tests, \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	287 \| \| \| \| clang regression tests, \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	288 \| \| \| \| test-suite (including spec) \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	289 +--------------+-------------+----------------+-----------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	290 \| x86-64 \| Linux \| last release \| llvm regression tests, \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	291 \| \| \| \| clang regression tests, \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	292 \| \| \| \| test-suite (including spec) \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	293 +--------------+-------------+----------------+-----------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	294 \| x86-64 \| FreeBSD \| last release \| llvm regression tests, \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	295 \| \| \| \| clang regression tests, \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	296 \| \| \| \| test-suite \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	297 +--------------+-------------+----------------+-----------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	298
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	299 Community Testing
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	300 -----------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	301
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	302 Once all testing has been completed and appropriate bugs filed, the release
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	303 candidate tarballs are put on the website and the LLVM community is notified.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	304 Ask that all LLVM developers test the release in 2 ways:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	305
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	306 #. Download ``llvm-X.Y``, ``llvm-test-X.Y``, and the appropriate ``clang``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	307 binary. Build LLVM. Run ``make check`` and the full LLVM test suite (``make
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	308 TEST=nightly report``).
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	309
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	310 #. Download ``llvm-X.Y``, ``llvm-test-X.Y``, and the ``clang`` sources. Compile
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	311 everything. Run ``make check`` and the full LLVM test suite (``make
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	312 TEST=nightly report``).
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	313
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	314 Ask LLVM developers to submit the test suite report and ``make check`` results
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	315 to the list. Verify that there are no regressions from the previous release.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	316 The results are not used to qualify a release, but to spot other potential
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	317 problems. For unsupported targets, verify that ``make check`` is at least
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	318 clean.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	319
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	320 During the first round of testing, all regressions must be fixed before the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	321 second release candidate is tagged.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	322
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	323 If this is the second round of testing, the testing is only to ensure that bug
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	324 fixes previously merged in have not created new major problems. *This is not
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	325 the time to solve additional and unrelated bugs!* If no patches are merged in,
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	326 the release is determined to be ready and the release manager may move onto the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	327 next stage.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	328
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	329 Release Patch Rules
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	330 -------------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	331
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	332 Below are the rules regarding patching the release branch:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	333
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	334 #. Patches applied to the release branch may only be applied by the release
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	335 manager.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	336
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	337 #. During the first round of testing, patches that fix regressions or that are
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	338 small and relatively risk free (verified by the appropriate code owner) are
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	339 applied to the branch. Code owners are asked to be very conservative in
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	340 approving patches for the branch. We reserve the right to reject any patch
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	341 that does not fix a regression as previously defined.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	342
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	343 #. During the remaining rounds of testing, only patches that fix critical
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	344 regressions may be applied.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	345
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	346 Release Final Tasks
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	347 -------------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	348
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	349 The final stages of the release process involves tagging the "final" release
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	350 branch, updating documentation that refers to the release, and updating the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	351 demo page.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	352
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	353 Update Documentation
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	354 ^^^^^^^^^^^^^^^^^^^^
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	355
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	356 Review the documentation and ensure that it is up to date. The "Release Notes"
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	357 must be updated to reflect new features, bug fixes, new known issues, and
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	358 changes in the list of supported platforms. The "Getting Started Guide" should
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	359 be updated to reflect the new release version number tag available from
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	360 Subversion and changes in basic system requirements. Merge both changes from
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	361 mainline into the release branch.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	362
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	363 .. _tag:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	364
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	365 Tag the LLVM Final Release
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	366 ^^^^^^^^^^^^^^^^^^^^^^^^^^
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	367
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	368 Tag the final release sources using the following procedure:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	369
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	370 ::
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	371
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	372 $ svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_XY \
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	373 https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_XY/Final
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	374
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	375 $ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_XY \
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	376 https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_XY/Final
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	377
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	378 $ svn copy https://llvm.org/svn/llvm-project/dragonegg/branches/release_XY \
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	379 https://llvm.org/svn/llvm-project/dragonegg/tags/RELEASE_XY/Final
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	380
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	381 $ svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_XY \
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	382 https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_XY/Final
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	383
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	384 Update the LLVM Demo Page
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	385 -------------------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	386
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	387 The LLVM demo page must be updated to use the new release. This consists of
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	388 using the new ``clang`` binary and building LLVM.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	389
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	390 Update the LLVM Website
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	391 ^^^^^^^^^^^^^^^^^^^^^^^
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	392
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	393 The website must be updated before the release announcement is sent out. Here
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	394 is what to do:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	395
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	396 #. Check out the ``www`` module from Subversion.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	397
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	398 #. Create a new subdirectory ``X.Y`` in the releases directory.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	399
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	400 #. Commit the ``llvm``, ``test-suite``, ``clang`` source, ``clang binaries``,
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	401 ``dragonegg`` source, and ``dragonegg`` binaries in this new directory.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	402
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	403 #. Copy and commit the ``llvm/docs`` and ``LICENSE.txt`` files into this new
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	404 directory. The docs should be built with ``BUILD_FOR_WEBSITE=1``.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	405
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	406 #. Commit the ``index.html`` to the ``release/X.Y`` directory to redirect (use
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	407 from previous release).
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	408
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	409 #. Update the ``releases/download.html`` file with the new release.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	410
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	411 #. Update the ``releases/index.html`` with the new release and link to release
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	412 documentation.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	413
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	414 #. Finally, update the main page (``index.html`` and sidebar) to point to the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	415 new release and release announcement. Make sure this all gets committed back
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	416 into Subversion.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	417
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	418 Announce the Release
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	419 ^^^^^^^^^^^^^^^^^^^^
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	420
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	421 Have Chris send out the release announcement when everything is finished.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	422

Mercurial > hg > CbC > CbC_llvm

annotate docs/HowToReleaseLLVM.rst @ 3:9ad51c7bc036