projects / oota-llvm.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Resolve JIT runtime linking problems on Android.
[oota-llvm.git] / docs / HowToReleaseLLVM.rst
diff --git a/docs/HowToReleaseLLVM.rst b/docs/HowToReleaseLLVM.rst
index b75e2a8f82187d69cf357d75783de2b804b7fffb..bc3b093d755e484da0dd005384e8c386406c9b64 100644 (file)
--- a/docs/HowToReleaseLLVM.rst
+++ b/docs/HowToReleaseLLVM.rst
@@ -6,11 +6,6 @@ How To Release LLVM To The Public
    :local:
    :depth: 1
 
-.. sectionauthor:: Tanya Lattner <tonic@nondot.org>,
-                   Reid Spencer <rspencer@x10sys.com>,
-                   John Criswell <criswell@cs.uiuc.edu> and
-                   Bill Wendling <wendling@apple.com>
-
 Introduction
 ============
 
@@ -19,6 +14,9 @@ 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.
 
+If you're looking for the document on how to test the release candidates and
+create the binary packages, please refer to the :doc:`ReleaseProcess` instead.
+
 .. _timeline:
 
 Release Timeline
@@ -68,7 +66,7 @@ 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
@@ -88,18 +86,18 @@ Branch the Subversion trunk using the following procedure:
    ``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
 
@@ -107,17 +105,17 @@ Branch the Subversion trunk using the following procedure:
    tree again.
 
 #. 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 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
 
 Update LLVM Version
@@ -144,7 +142,7 @@ 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
@@ -171,7 +169,7 @@ be done with the following commands:
   $ 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
@@ -201,7 +199,7 @@ Build LLVM
 
 Build ``Debug``, ``Release+Asserts``, and ``Release`` versions
 of ``llvm`` on all supported platforms.  Directions to build ``llvm``
-are :ref:`here <getting_started>`.
+are :doc:`here <GettingStarted>`.
 
 Build Clang Binary Distribution
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -268,7 +266,7 @@ no regressions when using either ``clang`` or ``dragonegg`` with the
 Qualify Clang
 ^^^^^^^^^^^^^
 
-``Clang`` is qualified when front-end specific tests in the ``llvm`` dejagnu
+``Clang`` is qualified when front-end specific tests in the ``llvm`` regression
 test suite all pass, clang's own test suite passes cleanly, and there are no
 regressions in the ``test-suite``.
 
@@ -278,26 +276,26 @@ Specific Target Qualification Details
 +--------------+-------------+----------------+-----------------------------+
 | Architecture | OS          | clang baseline | tests                       |
 +==============+=============+================+=============================+
-| x86-32       | Linux       | last release   | llvm dejagnu,               |
-|              |             |                | clang tests,                |
+| x86-32       | Linux       | last release   | llvm regression tests,      |
+|              |             |                | clang regression tests,     |
 |              |             |                | test-suite (including spec) |
 +--------------+-------------+----------------+-----------------------------+
-| x86-32       | FreeBSD     | last release   | llvm dejagnu,               |
-|              |             |                | clang tests,                |
+| x86-32       | FreeBSD     | last release   | llvm regression tests,      |
+|              |             |                | clang regression tests,     |
 |              |             |                | test-suite                  |
 +--------------+-------------+----------------+-----------------------------+
 | x86-32       | mingw       | none           | QT                          |
 +--------------+-------------+----------------+-----------------------------+
-| x86-64       | Mac OS 10.X | last release   | llvm dejagnu,               |
-|              |             |                | clang tests,                |
+| x86-64       | Mac OS 10.X | last release   | llvm regression tests,      |
+|              |             |                | clang regression tests,     |
 |              |             |                | test-suite (including spec) |
 +--------------+-------------+----------------+-----------------------------+
-| x86-64       | Linux       | last release   | llvm dejagnu,               |
-|              |             |                | clang tests,                |
+| x86-64       | Linux       | last release   | llvm regression tests,      |
+|              |             |                | clang regression tests,     |
 |              |             |                | test-suite (including spec) |
 +--------------+-------------+----------------+-----------------------------+
-| x86-64       | FreeBSD     | last release   | llvm dejagnu,               |
-|              |             |                | clang tests,                |
+| x86-64       | FreeBSD     | last release   | llvm regression tests,      |
+|              |             |                | clang regression tests,     |
 |              |             |                | test-suite                  |
 +--------------+-------------+----------------+-----------------------------+
 
@@ -321,10 +319,10 @@ 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,
@@ -376,13 +374,13 @@ 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
 
C/C++ LLVM-based compilers that forbids OOTA behaviors