mirror of
https://github.com/c64scene-ar/llvm-6502.git
synced 2024-12-27 13:30:05 +00:00
Documentation: don't create TOCs manually.
Thanks to Sean Silva for pointing out! git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169699 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Dmitri Gribenko
parent
0da9175d90
commit
76d182f7c2
@ -4,6 +4,7 @@ How To Release LLVM To The Public
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
:depth: 1
|
||||
|
||||
.. sectionauthor:: Tanya Lattner <tonic@nondot.org>,
|
||||
Reid Spencer <rspencer@x10sys.com>,
|
||||
@ -52,52 +53,11 @@ The release process is roughly as follows:
|
||||
|
||||
* 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 @@ release process to begin. Specifically, it involves:
|
||||
|
||||
* Tagging release candidates for the release team to begin testing.
|
||||
|
||||
.. _branch:
|
||||
|
||||
Create Release Branch
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
@ -162,8 +120,6 @@ Branch the Subversion trunk using the following procedure:
|
||||
|
||||
$ 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 @@ Regenerate the configure scripts for both ``llvm`` and the ``test-suite``.
|
||||
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 @@ following commands:
|
||||
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 @@ be done with the following commands:
|
||||
$ 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 @@ The ``make`` options for building the different modes:
|
||||
| Release | ``ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1`` |
|
||||
+-----------------+---------------------------------------------+
|
||||
|
||||
|
||||
.. _build:
|
||||
|
||||
Build LLVM
|
||||
^^^^^^^^^^
|
||||
|
||||
@ -254,8 +203,6 @@ Build ``Debug``, ``Release+Asserts``, and ``Release`` versions
|
||||
of ``llvm`` on all supported platforms. Directions to build ``llvm``
|
||||
are :ref:`here <getting_started>`.
|
||||
|
||||
.. _clangbin:
|
||||
|
||||
Build Clang Binary Distribution
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
@ -270,8 +217,6 @@ requires performing the following steps for each supported platform:
|
||||
|
||||
#. Package ``clang`` (details to follow).
|
||||
|
||||
.. _target-build:
|
||||
|
||||
Target Specific Build Details
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
@ -296,8 +241,6 @@ when qualifying the build of ``llvm``, ``clang``, and ``dragonegg``.
|
||||
| x86-64 | FreeBSD | gcc 4.2.X |
|
||||
+--------------+---------------+----------------------+
|
||||
|
||||
.. _release-qualify:
|
||||
|
||||
Release Qualification Criteria
|
||||
------------------------------
|
||||
|
||||
@ -315,8 +258,6 @@ use is described below. This doesn't mean that we don't care about other
|
||||
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 @@ LLVM is qualified when it has a clean test run without a front-end. And it has
|
||||
no regressions when using either ``clang`` or ``dragonegg`` with the
|
||||
``test-suite`` from the previous release.
|
||||
|
||||
.. _clang-qualify:
|
||||
|
||||
Qualify Clang
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
@ -333,8 +272,6 @@ Qualify Clang
|
||||
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 @@ Specific Target Qualification Details
|
||||
| | | | test-suite |
|
||||
+--------------+-------------+----------------+-----------------------------+
|
||||
|
||||
.. _commTest:
|
||||
|
||||
Community Testing
|
||||
-----------------
|
||||
|
||||
@ -396,8 +331,6 @@ the time to solve additional and unrelated bugs!* If no patches are merged in,
|
||||
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 @@ Below are the rules regarding patching the release branch:
|
||||
#. During the remaining rounds of testing, only patches that fix critical
|
||||
regressions may be applied.
|
||||
|
||||
.. _release-final:
|
||||
|
||||
Release Final Tasks
|
||||
-------------------
|
||||
|
||||
@ -424,8 +355,6 @@ 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.
|
||||
|
||||
.. _updocs:
|
||||
|
||||
Update Documentation
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
@ -457,16 +386,12 @@ Tag the final release sources using the following procedure:
|
||||
$ 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 @@ is what to do:
|
||||
new release and release announcement. Make sure this all gets committed back
|
||||
into Subversion.
|
||||
|
||||
.. _announce:
|
||||
|
||||
Announce the Release
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user