[llvm-commits] [llvm] r169699 - /llvm/trunk/docs/HowToReleaseLLVM.rst
Dmitri Gribenko
gribozavr at gmail.com
Sun Dec 9 07:29:56 PST 2012
Author: gribozavr
Date: Sun Dec 9 09:29:56 2012
New Revision: 169699
URL: http://llvm.org/viewvc/llvm-project?rev=169699&view=rev
Log:
Documentation: don't create TOCs manually.
Thanks to Sean Silva for pointing out!
Modified:
llvm/trunk/docs/HowToReleaseLLVM.rst
Modified: llvm/trunk/docs/HowToReleaseLLVM.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/HowToReleaseLLVM.rst?rev=169699&r1=169698&r2=169699&view=diff
==============================================================================
--- llvm/trunk/docs/HowToReleaseLLVM.rst (original)
+++ llvm/trunk/docs/HowToReleaseLLVM.rst Sun Dec 9 09:29:56 2012
@@ -4,6 +4,7 @@
.. contents::
:local:
+ :depth: 1
.. sectionauthor:: Tanya Lattner <tonic at nondot.org>,
Reid Spencer <rspencer at x10sys.com>,
@@ -52,52 +53,11 @@
* Finally, release!
-.. _process:
-
Release Process
===============
-#. :ref:`Release Administrative Tasks <release-admin>`
-
- #. :ref:`Create Release Branch <branch>`
-
- #. :ref:`Update Version Numbers <verchanges>`
-
-#. :ref:`Building the Release <release-build>`
-
- #. :ref:`Build the LLVM Source Distribution <dist>`
-
- #. :ref:`Build LLVM <build>`
-
- #. :ref:`Build the Clang Binary Distribution <clangbin>`
-
- #. :ref:`Target Specific Build Details <target-build>`
-
-#. :ref:`Release Qualification Criteria <release-qualify>`
-
- #. :ref:`Qualify LLVM <llvm-qualify>`
-
- #. :ref:`Qualify Clang <clang-qualify>`
-
- #. :ref:`Specific Target Qualification Details <target>`
-
-#. :ref:`Community Testing <commTest>`
-
-#. :ref:`Release Patch Rules <release-patch>`
-
-#. :ref:`Release final tasks <release-final>`
-
- #. :ref:`Update Documentation <updocs>`
-
- #. :ref:`Tag the LLVM Final Release <tag>`
-
- #. :ref:`Update the LLVM Demo Page <updemo>`
-
- #. :ref:`Update the LLVM Website <webupdates>`
-
- #. :ref:`Announce the Release <announce>`
-
-.. _release-admin:
+.. contents::
+ :local:
Release Administrative Tasks
----------------------------
@@ -111,8 +71,6 @@
* Tagging release candidates for the release team to begin testing.
-.. _branch:
-
Create Release Branch
^^^^^^^^^^^^^^^^^^^^^
@@ -162,8 +120,6 @@
$ svn co https://llvm.org/svn/llvm-project/test-suite/branches/release_XY test-suite-X.Y
-.. _verchanges:
-
Update LLVM Version
^^^^^^^^^^^^^^^^^^^
@@ -175,8 +131,6 @@
In addition, the version numbers of all the Bugzilla components must be updated
for the next release.
-.. _dist:
-
Build the LLVM Release Candidates
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -206,7 +160,7 @@
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. :ref:`Tag the LLVM Final Release <tag>`).
+directory as ``Final`` (c.f. :ref:`tag`).
The Release Manager may supply pre-packaged source tarballs for users. This can
be done with the following commands:
@@ -223,8 +177,6 @@
$ 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
-.. _release-build:
-
Building the Release
--------------------
@@ -244,9 +196,6 @@
| Release | ``ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1`` |
+-----------------+---------------------------------------------+
-
-.. _build:
-
Build LLVM
^^^^^^^^^^
@@ -254,8 +203,6 @@
of ``llvm`` on all supported platforms. Directions to build ``llvm``
are :ref:`here <getting_started>`.
-.. _clangbin:
-
Build Clang Binary Distribution
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -270,8 +217,6 @@
#. Package ``clang`` (details to follow).
-.. _target-build:
-
Target Specific Build Details
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -296,8 +241,6 @@
| x86-64 | FreeBSD | gcc 4.2.X |
+--------------+---------------+----------------------+
-.. _release-qualify:
-
Release Qualification Criteria
------------------------------
@@ -315,8 +258,6 @@
criteria, but these are the criteria which we found to be most important and
which must be satisfied before a release can go out.**
-.. _llvm-qualify:
-
Qualify LLVM
^^^^^^^^^^^^
@@ -324,8 +265,6 @@
no regressions when using either ``clang`` or ``dragonegg`` with the
``test-suite`` from the previous release.
-.. _clang-qualify:
-
Qualify Clang
^^^^^^^^^^^^^
@@ -333,8 +272,6 @@
test suite all pass, clang's own test suite passes cleanly, and there are no
regressions in the ``test-suite``.
-.. _target:
-
Specific Target Qualification Details
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -364,8 +301,6 @@
| | | | test-suite |
+--------------+-------------+----------------+-----------------------------+
-.. _commTest:
-
Community Testing
-----------------
@@ -396,8 +331,6 @@
the release is determined to be ready and the release manager may move onto the
next stage.
-.. _release-patch:
-
Release Patch Rules
-------------------
@@ -415,8 +348,6 @@
#. During the remaining rounds of testing, only patches that fix critical
regressions may be applied.
-.. _release-final:
-
Release Final Tasks
-------------------
@@ -424,8 +355,6 @@
branch, updating documentation that refers to the release, and updating the
demo page.
-.. _updocs:
-
Update Documentation
^^^^^^^^^^^^^^^^^^^^
@@ -457,16 +386,12 @@
$ 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
-.. _updemo:
-
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.
-.. _webupdates:
-
Update the LLVM Website
^^^^^^^^^^^^^^^^^^^^^^^
@@ -495,8 +420,6 @@
new release and release announcement. Make sure this all gets committed back
into Subversion.
-.. _announce:
-
Announce the Release
^^^^^^^^^^^^^^^^^^^^
More information about the llvm-commits
mailing list